php8.5
Home/ Manual/ stream / streamwrapper/ streamWrapper::stream_set_option

streamWrapper::stream_set_option

PHP function Edit on GitHub ✎

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

Change stream options

Description

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

This method is called to set options on the stream.

Parameters

option

One of:

arg1

If option is

  • STREAM_OPTION_BLOCKING: requested blocking mode (1 meaning block 0 not blocking).
  • STREAM_OPTION_READ_TIMEOUT: the timeout in seconds.
  • STREAM_OPTION_READ_BUFFER: buffer mode (STREAM_BUFFER_NONE or STREAM_BUFFER_FULL).
  • STREAM_OPTION_WRITE_BUFFER: buffer mode (STREAM_BUFFER_NONE or STREAM_BUFFER_FULL).
arg2

If option is

  • STREAM_OPTION_BLOCKING: This option is not set.
  • STREAM_OPTION_READ_TIMEOUT: the timeout in microseconds.
  • STREAM_OPTION_READ_BUFFER: the requested buffer size.
  • STREAM_OPTION_WRITE_BUFFER: the requested buffer size.

Return Values

Success If option is not implemented, false should be returned.

See Also

Source: reference/stream/streamwrapper/stream-set-option.xml · from the official PHP manual (php/doc-en)