Go to main content

Reference for Oracle Solaris Cluster 4.4

Exit Print View

Updated: August 2018
 
 

scds_fm_tcp_read (3HA)

Name

scds_fm_tcp_read - read 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_read(scds_handle_t handle, int sock, 
     char *buffer, size_t *size, time_t timeout);

Description

The scds_fm_tcp_read() function reads data from a TCP connection with a process being monitored.

The size argument is an input and argument. On input, you specify the size of the buffer, bytes. On completion, the function places the data in buffer and specifies the actual number of bytes read in size. If the buffer is not big enough for the number of bytes read, the function returns a full buffer of size bytes, and you can call the function again for further data.

If the function times out, it returns SCHA_ERR_TIMEOUT. In this case, the function might return fewer bytes than requested, indicated by the value returned in size.

Parameters

The following parameters are supported:

handle

The handle returned from scds_initialize(3HA).

sock

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

buffer

Data buffer.

size

Data buffer size. On input, you specify the size of the buffer, in bytes. On output, the function returns the actual number of bytes read.

timeout

Timeout value in seconds.

Return Values

The scds_fm_tcp_read() function returns the following:

0

The function succeeded.

nonzero

The function failed.

Errors

SCHA_ERR_NOERR

Indicates that the function succeeded.

SCHA_ERR_TIMEOUT

Indicates that the function timed out.

Other values

Indicate that 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
Evolving

See Also

scds_fm_tcp_disconnect(3HA), scds_fm_tcp_write(3HA), scds_initialize(3HA), scha_calls(3HA), attributes(7)