Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

scds_timerun(3ha) [opensolaris man page]

scds_timerun(3HA)					 Sun Cluster HA and Data Services					 scds_timerun(3HA)

NAME

       scds_timerun - execute a given command in a given amount of time

SYNOPSIS

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

       scha_err_t scds_timerun(scds_handle_t handle, const char *command,
	   time_t timeout, int signal, int *cmd_exit_code

DESCRIPTION

       The  scds_timerun()  function  executes	a specified command using hatimerun(1M). If the command does not complete within the allotted time
       period,which is specified by the timeout argument, scds_timerun() sends a signal, specified by the signal argument, to kill it.

       The command argument does not support I/O redirection.  However, you can write a script to  perform  redirection  and  then  identify  this
       script in the command argument as the command for scds_timerun() to execute.

PARAMETERS

       The following parameters are supported:

       handle		   The handle returned from scds_initialize(3HA)

       command		   String containing the command to run

       timeout		   Time, in seconds, allotted to run the command

       signal		   Signal  to  kill the command if it is still running when the timeout expires. If signal = -1, then SIGKILL is used. See
			   signal(3HEAD).

       cmd_exit_code	   Return code from execution of the command

RETURN VALUES

       The scds_timerun() function returns the following:

       0		   The function succeeded.

       non-zero 	   The function failed.

ERRORS

       SCHA_ERR_NOERR			   The command executed and cmd_exit_code contains the child program's exit status.

       SCHA_ERR_INTERNAL		   The timeout did not occur, but some other error was detected by scds_timerun() that was  not  an  error
					   detected by the child program. Or hatimerun(1M) caught the signal SIGTERM.

       SCHA_ERR_INVAL			   There was an invalid input argument.

       SCHA_ERR_TIMEOUT 		   The timeout occurred before the command specified by the command argument finished executing.

       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 TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWscdev 		   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+

SEE ALSO

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

Sun Cluster 3.2 						    7 Sep 2007							 scds_timerun(3HA)

Check Out this Related Man Page

scds_pmf_signal(3HA)					 Sun Cluster HA and Data Services				      scds_pmf_signal(3HA)

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 return-
       ing.  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 indefintely for the processes to exit.

PARAMETERS

       The following parameters are supported:

       handle		   The handle returned from scds_initialize()

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

       timeout		   Timeout period in seconds.

RETURN VALUES

       The scds_pmf_signal() function returns the following:

       0		   The function succeeded.

       non-zero 	   The function failed.

ERRORS

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

       SCHA_ERR_NOERR		   The function succeeded.

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

SEE ALSO

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

Sun Cluster 3.2 						    7 Sep 2007						      scds_pmf_signal(3HA)
Man Page