stream_set_blocking()
stream_set_blocking() — Set blocking/non-blocking mode on a stream.
Built-in function of PHP 8.5. The manual lists it as available in PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.
Signature
stream_set_blocking(resource $stream, bool $enable): bool
Parameters
| Parameter | Type | What it takes |
|---|---|---|
| $stream | resource | The stream. |
| $enable | bool | If enable is false, the given stream will be switched to non-blocking mode, and if true, it will be switched to blocking mode. This affects calls like fgets() and fread() that read from the stream. In non-blocking mode an fgets() call will always return right away while in blocking mode it will wait for data to become available on the stream. |
Return value
Returns true on success or false on failure.
Example
The PHP manual ships no example for stream_set_blocking(); the signature and the parameter table above are the contract.
See also
All PHP 8.5 built-in functions
Reference card built from the PHP manual page stream_set_blocking() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.