streamWrapper::stream_set_option
(PHP 5 >= 5.3.0, PHP 7, PHP 8)
streamWrapper::stream_set_option — Change stream options
Description
$option
, int $arg1
, int $arg2
): boolThis method is called to set options on the stream.
Parameters
-
option
-
One of:
STREAM_OPTION_BLOCKING
(The method was called in response to stream_set_blocking())STREAM_OPTION_READ_TIMEOUT
(The method was called in response to stream_set_timeout())STREAM_OPTION_WRITE_BUFFER
(The method was called in response to stream_set_write_buffer())
-
arg1
-
If
option
isSTREAM_OPTION_BLOCKING
: requested blocking mode (1 meaning block 0 not blocking).STREAM_OPTION_READ_TIMEOUT
: the timeout in seconds.STREAM_OPTION_WRITE_BUFFER
: buffer mode (STREAM_BUFFER_NONE
orSTREAM_BUFFER_FULL
).
-
arg2
-
If
option
isSTREAM_OPTION_BLOCKING
: This option is not set.STREAM_OPTION_READ_TIMEOUT
: the timeout in microseconds.STREAM_OPTION_WRITE_BUFFER
: the requested buffer size.
Return Values
Returns true
on success or false
on failure.
If option
is not implemented, false
should be
returned.
See Also
- stream_set_blocking() - Set blocking/non-blocking mode on a stream
- stream_set_timeout() - Set timeout period on a stream
- stream_set_write_buffer() - Sets write file buffering on the given stream