CSSJ::Helpers - 入出力ユーティリティ

- NAME

- 概要
- 作者

- 定数

- BUFFER_SIZE

- write_int

- 引数
- 戻り値

- write_byte

- 引数
- 戻り値

- write_bytes

- 引数
- 戻り値

- write

- 引数
- 戻り値

- read_int

- 引数
- 戻り値

- read_byte

- 引数
- 戻り値

- read_bytes

- 引数
- 戻り値

- read

- 引数
- 戻り値

# NAME

CSSJ::Helpers - 入出力ユーティリティ

## 概要

ストリームへデータを入出力するためのユーティリティです。 これらの関数は、ノンブロッキングI/Oに対しても与えられた(要求される)データを全て出力(入力)します。

通常、プログラマがこのパッケージを直接使う必要はありません。

## 作者

$Date: 2006/03/30 08:35:00 $ MIYABE Tatsuhiko

# 定数

## BUFFER_SIZE

パケットの送信に使うバッファのサイズです。

# write_int

`write_int OUTHANDLE INTEGER`

32ビット数値をビッグインディアンで書き出します。

## 引数

OUTHANDLE 出力先ハンドル
INTEGER 32ビット整数

## 戻り値

成功なら書き込んだバイト数,失敗ならundef

# write_byte

`write_byte OUTHANDLE BYTE`

8ビット数値を書き出します。

## 引数

OUTHANDLE 出力先ハンドル
BYTE 8ビット整数

## 戻り値

成功なら書き込んだバイト数,失敗ならundef

# write_bytes

`write_bytes OUTHANDLE BYTES`

バイト数を16ビットビッグインディアンで書き出した後、バイト列を書き出します。

## 引数

OUTHANDLE 出力先ハンドル
BYTES バイト列

## 戻り値

成功なら書き込んだバイト数,失敗ならundef

# write

`write OUTHANDLE BYTES [ LENGTH]`

バイト列を書き出します。

## 引数

OUTHANDLE 出力先ハンドル
BYTES バイト列
LENGTH 長さ

## 戻り値

成功なら書き込んだバイト数,失敗ならundef

# read_int

`read_int INHANDLE INTEGER`

32ビットビッグインディアン数値を読み込みます。

## 引数

INHANDLE 入力元ハンドル

## 戻り値

成功なら32ビット整数,失敗ならundef

# read_byte

`read_byte INHANDLE`

8ビット数値を読み込みます。

## 引数

INHANDLE 入力元ハンドル

## 戻り値

成功なら8ビット整数,失敗ならundef

# read_bytes

`read_bytes INHANDLE`

16ビットビッグインディアン数値を読み込み、そのバイト数だけバイト列を読み込みます。

## 引数

INHANDLE 入力元ハンドル

## 戻り値

成功ならバイト列,失敗ならundef

# read

`read INHANDLE LENGTH`

バイト列を読み込みます。

## 引数

INHANDLE 入力元ハンドル
LENGTH 要求されるバイト数

## 戻り値

成功ならバイト列,失敗ならundef