opensolaris man page for scds_fm_tcp_connect

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

NAME
       scds_fm_tcp_connect - establish 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_connect(scds_handle_t handle, int *sock, const char*hostname,
	   int port, time_t timeout

DESCRIPTION
       The scds_fm_tcp_connect() function establishes a TCP connection with a process being monitored.

       Retrieve the hostname with either scds_get_rs_hostnames(3HA) or scds_get_rg_hostnames(3HA).

       Consider using scds_fm_net_connect(3HA) instead of this function.

PARAMETERS
       The following parameters are supported:

       handle		   The handle returned by scds_initialize(3HA).

       sock		   A handle to the socket established by this function. This parameter is an output argument set by this function.

       hostname 	   Name of the host where the process is listening. If the hostname maps to an IPv4 address only, or to both IPv4 and IPv6
			   addresses, this function uses the IPv4 mapping as the address at which to connect. If the  hostname	maps  to  an  IPv6
			   address only, this function uses that IPv6 mapping as the address at which to connect.

       port		   TCP port number.

       timeout		   Timeout value in seconds.

RETURN VALUES
       The scds_fm_tcp_connect() function returns the following:

       0		   The function succeeded.

       nonzero		   The function failed.

ERRORS
       SCHA_ERR_NOERR		   Indicates that the function succeeded.

       SCHA_ERR_STATE		   Indicates that an attempt to initiate a connection on a socket failed for reasons other than a timeout.

       SCHA_ERR_TIMEOUT 	   Indicates that the function timed out.

       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	     |Deprecated		   |
       +-----------------------------+-----------------------------+

SEE ALSO
       scds_fm_net_connect(3HA),   scds_fm_tcp_disconnect(3HA),   scds_get_rg_hostnames(3HA),	scds_get_rs_hostnames(3HA),  scds_initialize(3HA),
       scha_calls(3HA), attributes(5)

Sun Cluster 3.2 						    7 Sep 2007						  scds_fm_tcp_connect(3HA)