Sun Microsystems, Inc.
   www.sun.com docs.sun.com | | |  
   
A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
    
 
Sun Cluster HA and Data Servicesscds_pmf_stop(3HA)


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% 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% of the timeout value, the function is considered to have failed and returns SCHA_ERR_TIMEOUT. The remaining 5% of the timeout argument is presumed to have been absorbed by this function's overhead.


PARAMETERS

 

The following parameters are supported:

handle
The handle returned from scds_initialize(3HA)
program_type
Type of program to execute. Valid types are:
SCDS_PMF_TYPE_SVC
Data service application
SCDS_PMF_TYPE_MON
Fault monitor
SCDS_PMF_TYPE_OTHER
Other
instance
For resources with multiple instances, this integer, starting at 0, uniquely identifies the instance. For single instance resources, use 0.
signal
Solaris signal to send kill the instance. See signal(3head). Use SIGKILL if the specified signal fails to kill the instance.
timeout
Timeout period measured in seconds.

RETURN VALUES

 

The scds_pmf_stop() function returns the following:

0
The function succeeded.
non-zero
The function failed.

ERRORS

 
SCHA_ERR_TIMEOUT
The function timed out.
SCHA_ERR_NOERR
The function succeeded.
Other values
Indicate the function failed. See scha_calls(3HA) for a description of other error codes.

FILES

 
/usr/cluster/include/rgm/libdsdev.h
Include file
/usr/cluster/lib/libdsdev.so
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)



Sun Cluster 3.1Go To TopLast Changed 9 Jul 2002

 
      
      
Copyright 2003 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.