streamWrapper::stream_set_option

ストリームのオプションを変更する

説明

public bool streamWrapper::stream_set_option(int $option, int $arg1, int $arg2)

このメソッドは、ストリームのオプションを設定する際にコールされます。

パラメータ

option

以下のいずれか。

  • STREAM_OPTION_BLOCKING (このメソッドは、stream_set_blocking に対応してコールされます)
  • STREAM_OPTION_READ_TIMEOUT (このメソッドは、stream_set_timeout に対応してコールされます)
  • STREAM_OPTION_READ_BUFFER (このメソッドは、stream_set_read_buffer に対応してコールされます)
  • STREAM_OPTION_WRITE_BUFFER (このメソッドは、stream_set_write_buffer に対応してコールされます)

arg1

option の値に応じて、以下の内容となります。

  • STREAM_OPTION_BLOCKING: 要求されたブロックモード (1 はブロックモード、0 は非ブロックモード)。
  • STREAM_OPTION_READ_TIMEOUT: タイムアウト秒数。
  • STREAM_OPTION_READ_BUFFER: バッファモード (STREAM_BUFFER_NONE あるいは STREAM_BUFFER_FULL).
  • STREAM_OPTION_WRITE_BUFFER: バッファモード (STREAM_BUFFER_NONE あるいは STREAM_BUFFER_FULL)。

arg2

option の値に応じて、以下の内容となります。

  • STREAM_OPTION_BLOCKING: このオプションは設定されません。
  • STREAM_OPTION_READ_TIMEOUT: タイムアウトマイクロ秒数。
  • STREAM_OPTION_READ_BUFFER: 要求されたバッファサイズ。
  • STREAM_OPTION_WRITE_BUFFER: 要求されたバッファサイズ。

戻り値

成功した場合に true を、失敗した場合に false を返します。 option が実装されていない場合は false を返さなければなりません。

参考

  • stream_set_blocking
  • stream_set_timeout
  • stream_set_write_buffer