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

NAME

       scds_simple_net_probe - probe by establishing and terminating 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_simple_net_probe(scds_handle_t handle, scds_netaddr_t addr,
	   time_t timeout, scds_fmsock_status_t *status, int count

DESCRIPTION

       The scds_simple_net_probe() function is a wrapper function around scds_fm_net_connect(3HA) and scds_fm_net_disconnect(3HA).  For hosts that
       have multiple mappings, scds_simple_net_probe() handles both IPv4 and IPv6 addresses for the supplied hostname.

       You can retrieve a list of network addresses for the resource by using scds_get_netaddr_list(3HA).

       The status for a connect to, or disconnect from, an IPv4 target is stored in the first member of the scds_fmsock_status_t array.  The  sec-
       ond  member contains the status for an IPv6 target. If the hostname that is supplied to this function does not contain an IPv4 or IPv6 map-
       ping, the corresponding status is set to SCDS_FMSOCK_NA.

PARAMETERS

       The following parameters are supported:

       handle		   The handle returned by scds_initialize(3HA).

       addr		   The hostname, TCP port number, and protocol identifier that specify where the process is listening.

       timeout		   The timeout value in seconds to wait for a successful connection. Each socket (IPv4 or  IPv6)  gets	the  same  timeout
			   period, and timeouts proceed in parallel.

       status		   Array  of  SCDS_MAX_IPADDR_TYPES  members  of  type scds_fmsock_status_t. Each member in the array holds a status. This
			   parameter is an output argument that is set by this function.

       count		   The number of members in the socklist array. Set this parameter to SCDS_MAX_IPADDR_TYPES.

RETURN VALUES

       The scds_simple_net_probe() function returns the following values:

       0		   The function succeeded.

       SCHA_ERR_INVAL	   The function was called with invalid paramaters.

       Other nonzero valuesAt least one connect operation failed due to a timeout, a refused connection, or some  other  error.  Inspect  the  err
			   field of all members of the socklist array that are set to SCDS_FMSOCK_ERR to determine the exact error.

       nonzero		   At least one connect or disconnect operation failed. You can inspect the scds_fmsock_status_t array to determine if the
			   failure was in an IPv4 target, an IPv6 target, or both.

ERRORS

       SCHA_ERR_NOERR		   Indicates that the function succeeded.

       SCHA_ERR_INTERNAL	   Indicates that an internal error occurred while the function was executing.

       SCHA_ERR_STATE		   Indicates that the connection request was refused by the server.

       SCHA_ERR_TIMEOUT 	   Indicates that the connection request timed out.

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_net_connect(3HA),   scds_fm_net_disconnect(3HA),    scds_get_netaddr_list(3HA),	  scds_initialize(3HA),    scds_simple_probe(3HA),
       scha_calls(3HA), attributes(5)

Sun Cluster 3.2 						    7 Sep 2007						scds_simple_net_probe(3HA)