Home | History | Annotate | Download | only in man3ha
 te
 CDDL HEADER START

 The contents of this file are subject to the terms of the
 Common Development and Distribution License (the "License"). 
 You may not use this file except in compliance with the License.

 You can obtain a copy of the license at CDDL.txt
 or http://www.opensolaris.org/os/licensing.
 See the License for the specific language governing permissions
 and limitations under the License.

 When distributing Covered Code, include this CDDL HEADER in each
 file and include the License file at CDDL.txt.
 If applicable, add the following below this CDDL HEADER, with the
 fields enclosed by brackets "[]" replaced with your own identifying
 information: Portions Copyright [yyyy] [name of copyright owner]

 CDDL HEADER END
 Copyright 2008 Sun Microsystems, Inc. All
 rights reserved. Use is subject to license terms.
 scds_pmf_stop 3HA "13 Aug 2008" "Sun Cluster 3.2" "Sun Cluster HA and Data Services"
 NAME
scds_pmf_stop - terminate a process that is running
under PMF control

 SYNOPSIS


cc [flags.\|.\|.] -I /usr/cluster/include file -L /usr/cluster/lib  -l  dsdev
#include <rgm/libdsdev.h>

scha_err_t  scds_pmf_stop(scds_handle_t handle, scds_pmf_type_t program_type,
 int instance, int signal, time_t timeout);




 DESCRIPTION

The scds_pmf_stop() function stops a program that
is running under PMF control. It is equivalent to the pmfadm(1M) command with the -s option.


If the requested instance is not running, scds_pmf_stop() returns
with value SCHA_ERR_NOERR.


If the requested instance is running, then the specified signal is sent
to the instance. If the instance fails to die within a period of time equal
to 80 percent of the timeout value, SIGKILL is sent to
the instance. If the instance then fails to die within a period of time equal
to 15 percent of the timeout value, the function is considered to have failed
and returns SCHA_ERR_TIMEOUT. The remaining 5 percent of
the timeout argument is presumed to have been absorbed by this function's
overhead.

 PARAMETERS

The following parameters are supported:


.na
handle
.ad


The handle returned from scds_initialize(3HA)





.na
program_type
.ad


Type of program to execute. Valid types are:


.na
SCDS_PMF_TYPE_SVC
.ad


Data service application





.na
SCDS_PMF_TYPE_MON
.ad


Fault monitor





.na
SCDS_PMF_TYPE_OTHER
.ad


Other








.na
instance
.ad


For resources with multiple instances, this integer, starting
at 0, uniquely identifies the instance. For single instance resources, use
0. 





.na
signal
.ad


Solaris signal to send kill the instance. See signal(3HEAD). Use SIGKILL if
the specified signal fails to kill the instance.





.na
timeout
.ad


Timeout period measured in seconds.




 RETURN VALUES

The scds_pmf_stop() function returns the following:


.na
0
.ad


The function succeeded.





.na
non-zero
.ad


The function failed.




 ERRORS

.na
SCHA_ERR_TIMEOUT
.ad


The function timed out. 





.na
SCHA_ERR_NOERR
.ad


The function succeeded. 





.na
Other values
.ad


Indicate the function failed. See scha_calls(3HA) for a description of other
error codes.




 FILES

.na
/usr/cluster/include/rgm/libdsdev.h
.ad


Include file





.na
/usr/cluster/lib/libdsdev.so
.ad


Library




 ATTRIBUTES

See attributes(5) 
for descriptions of the following attributes:







ATTRIBUTE TYPEATTRIBUTE VALUE
AvailabilitySUNWscdev
Interface StabilityEvolving



 SEE ALSO

pmfadm(1M), scds_initialize(3HA), scds_pmf_start(3HA), scha_calls(3HA), signal(3HEAD), attributes(5)