Cross Reference: /ohac/man/man3ha/scds_pmf_signal.3ha

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_signal 3HA "13 Aug 2008" "Sun Cluster 3.2" "Sun Cluster HA and Data Services"

NAME

scds_pmf_signal - send a signal to a process tree 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_signal(scds_handle_t handle, scds_pmf_type_t program_type,
 int instance, int signal, time_t timeout);

DESCRIPTION

The scds_pmf_signal() function sends the specified signal to a process tree running under PMF control. This function is equivalent to the pmfadm(1M) command with the -k option.

After sending the signal, the scds_pmf_signal() function waits for the specified timeout period for the process tree to die, before returning. A value of 0 for timeout tells the function to return immediately without waiting for any process to exit. A value of -1 tells the function to wait indefinitely for the processes to exit.

PARAMETERS

The following parameters are supported:

.na handle .ad The handle returned from scds_initialize()

.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. See signal(3HEAD).

.na timeout .ad Timeout period in seconds.

RETURN VALUES

The scds_pmf_signal() function returns the following:

.na 0 .ad The function succeeded.

.na nonzero .ad The function failed.

ERRORS

.na SCHA_ERR_TIMEOUT .ad The process tree did not exit within the specified timeout period after the signal was sent.

.na SCHA_ERR_NOERR .ad The function succeeded.

.na Other values .ad Indicate the function failed. See scha_calls(3HA) for the meaning of failure 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 TYPE	ATTRIBUTE VALUE
Availability	SUNWscdev
Interface Stability	Evolving

SEE ALSO

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