opensolaris man page for scds_fm_tcp_write

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

NAME
       scds_fm_tcp_write - write data using a tcp connection to an application

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

       scha_err_t  scds_fm_tcp_write(scds_handle_t handle, int sock, char *buffer,
	   size_t *size, time_t timeout

DESCRIPTION
       The scds_fm_tcp_write() function writes data from by means of a TCP connection to a process being monitored.

       The  size  argument  is	an  input  and	output argument.  On input, you specify the number of bytes to be written. On output, the function
       returns the number of bytes actually written. If the input and output values of size are not equal, an error  has  occurred.  The  function
       returns SCHA_ERR_TIMEOUT if it times out before writing all the requested data.

PARAMETERS
       The following parameters are supported:

       handle		   The handle returned from scds_initialize(3HA).

       sock		   The socket number returned by a previous call to scds_fm_tcp_connect(3HA).

       buffer		   Data buffer.

       size		   Data  buffer  size. On input, you specify the number of bytes to be written. On output, the function returns the number
			   of bytes actually written.

       timeout		   Timeout value in seconds.

RETURN VALUES
       The scds_fm_tcp_write() function returns the following:

       0		   The function succeeded.

       nonzero		   The function failed.

ERRORS
       SCHA_ERR_NOERR		   Indicates that the function succeeded.

       SCHA_ERR_TIMEOUT 	   Indicates that the function timed out.

       Other values		   Indicate that 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
       scds_fm_tcp_connect(3HA), scds_fm_tcp_read(3HA), scds_initialize(3HA), scha_calls(3HA), attributes(5)

Sun Cluster 3.2 						    7 Sep 2007						    scds_fm_tcp_write(3HA)