scds_fm_tcp_read (3HA)

名前

scds_fm_tcp_read - アプリケーションとの TCP 接続を使用したデータの読み取り

形式

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);

説明

scds_fm_tcp_read() 関数は、モニター対象のプロセスと TCP 接続からデータを読み取ります。

size 引数は入力および引数です。入力時にバッファーのサイズをバイト数で指定します。完了時に、この関数は、buffer 内にデータを配置し、実際に読み取られたバイト数を size に指定します。バッファーのサイズが読み取られるバイト数より小さい場合、size バイトの完全なバッファーを返します。この関数は、さらにデータを取得するために再度呼び出すことができます。

タイムアウトになった場合は、SCHA_ERR_TIMEOUT を返します。この場合、関数は、要求されたバイト数より少ないバイト数 (size で表される) を返します。

パラメータ

次のパラメータがサポートされます。

handle

scds_initialize(3HA) から返されるハンドルです。

sock

以前の scds_fm_tcp_connect(3HA) 呼び出しから返されるソケット番号です。

buffer

データバッファーです。

size

データバッファーサイズです。入力時にバッファーのサイズをバイト数で指定します。出力時、関数は実際に読み取られたバイト数を返します。

timeout

タイムアウト値 (秒) です。

戻り値

scds_fm_tcp_read() 関数の戻り値は次のとおりです。

0

関数の実行に成功。

0 以外

関数の実行に失敗。

エラー

SCHA_ERR_NOERR

関数が正常に終了。

SCHA_ERR_TIMEOUT

関数がタイムアウト。

その他の値

関数の実行に失敗。障害コードの意味については、scha_calls(3HA) を参照してください。

ファイル

/usr/cluster/include/rgm/libdsdev.h

インクルードファイル

/usr/cluster/lib/libdsdev.so

ライブラリ

属性

次の属性については、attributes(5) を参照してください。

属性タイプ 属性値 使用条件 ha-cluster/developer/api インタフェースの安定性 発展中

関連項目

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