Cross Reference: /ohac/man/man3ha/scds_fm_tcp_write.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_write 3HA "13 Aug 2008" "Sun Cluster 3.2" "Sun Cluster HA and Data Services"

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 by means of a TCP connection to a process that is 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:

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

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

.na buffer .ad Data buffer.

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

.na timeout .ad Timeout value in seconds.

RETURN VALUES

The scds_fm_tcp_write() 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_TIMEOUT .ad Indicates that the function timed out.

.na Other values .ad Indicate that 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	Evolving

SEE ALSO

scds_fm_tcp_connect(3HA), scds_fm_tcp_read(3HA), scds_initialize(3HA), scha_calls(3HA), attributes(5)