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_fm_sleep 3HA "13 Aug 2008" "Sun Cluster 3.2" "Sun Cluster HA and Data Services"
 NAME
scds_fm_sleep - wait for
a message on a fault monitor control socket

 SYNOPSIS


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

scha_err_t scds_fm_sleep(scds_handle_t handle, time_t timeout);




 DESCRIPTION

Thescds_fm_sleep() function waits for a data service
application process tree that running under control of the process monitor
facility to die. If no such death occurs within the specified timeout period,
the function returns SCHA_ERR_NOERR. 


If a data service application process tree death occurs, scds_fm_sleep() records SCDS_COMPLETE_FAILURE
in the failure history and either restarts the process tree or fails it over
according to the algorithm described in the scds_fm_action(3HA)
man page. If a failover attempt is unsuccessful, a restart of the application
is attempted. 


If an attempted restart fails, the function returns SCHA_ERR_INTERNAL. 


Note that if the failure history causes this function to do a failover,
and the failover attempt succeeds, scds_fm_sleep() never
returns.

 PARAMETERS

The following parameters are supported:


.na
handle
.ad


The
handle returned from scds_initialize(3HA).





.na
timeout
.ad


The timeout period measured in seconds.




 RETURN VALUES

The scds_fm_sleep() function returns the following:


.na
0
.ad


The function
succeeded.





.na
nonzero
.ad


The function failed.




 ERRORS

.na
SCHA_ERR_NOERR
.ad


Indicates that the process tree has not died.





.na
SCHA_ERR_INTERNAL
.ad


Indicates that the data service application process tree has died and
failed to restart.





.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 TYPEATTRIBUTE VALUE
AvailabilitySUNWscdev
Interface StabilityEvolving



 SEE ALSO

 scha_calls(3HA), scds_fm_action(3HA), scds_initialize(3HA), attributes(5)