Cross Reference: /ohac/man/man3ha/scds_fm_tcp_connect.3ha

te
CDDL HEADER START

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at CDDL.txt
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at CDDL.txt.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]

CDDL HEADER END
Copyright 2008 Sun Microsystems, Inc. All rights
reserved. Use is subject to license terms.

scds_fm_tcp_connect 3HA "13 Aug 2008" "Sun Cluster 3.2" "Sun Cluster HA and Data Services"

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:

.na handle .ad The handle returned by scds_initialize(3HA).

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

.na hostname .ad 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.

.na port .ad TCP port number.

.na timeout .ad Timeout value in seconds.

RETURN VALUES

The scds_fm_tcp_connect() function returns the following:

.na 0 .ad The function succeeded.

.na nonzero .ad The function failed.

ERRORS

.na SCHA_ERR_NOERR .ad Indicates that the function succeeded.

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

.na SCHA_ERR_TIMEOUT .ad Indicates that the function timed out.

.na Other values .ad Indicate the function failed. See scha_calls(3HA) for the meaning of failure codes.

FILES

.na /usr/cluster/include/rgm/libdsdev.h .ad Include file

.na /usr/cluster/lib/libdsdev.so .ad 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)