Go to main content

Reference for Oracle Solaris Cluster 4.4

Exit Print View

Updated: August 2018
 
 

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(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
ha-cluster/developer/api
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(7)