stream_set_blocking

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

stream_set_blocking — ストリームのブロックモードを有効にする / 解除する

説明

stream_set_blocking(resource $stream, bool $enable): bool

stream のモードをブロックあるいは非ブロックに設定します。

この関数は、非ブロックモードをサポートするすべてのストリーム (現在は、通常のファイルストリームとソケットストリームのみ) において利用可能です。

パラメータ

stream: ストリーム。
enable: enable が false の時、ストリームは非ブロックモードに切り替えられ、true の場合は、ブロックモードに切り替えられます。このモードの違いは、 fgets() や fread() といった、ストリームからデータを読む関数に影響します。非ブロックモードにおいては fgets() を呼び出すとどんな場合でもただちに呼び出し元に戻りますが、ブロックモードの場合では、ストリームがデータを読み出せる状態になるまで待ちつづけます。

戻り値

成功した場合に true を、失敗した場合に false を返します。

注意

注意:
Windowsでは、これはローカルファイルには影響しません。ローカルファイルのノンブロッキングI/Oは、Windowsではサポートされていません。

参考

stream_select() - select() システムコールと同等の操作を、ストリームの配列に対して seconds と microseconds で指定されたタイムアウト時間をもって行う

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 2 notes

down

Anonymous ¶

11 years ago

On Windows this function does not work with pipes opened with proc_open (https://bugs.php.net/bug.php?id=47918, https://bugs.php.net/bug.php?id=34972, https://bugs.php.net/bug.php?id=51800)

down

MagicalTux at ookoo dot org ¶

18 years ago

When you use fwrite() on a non-blocking stream, data isn't discarded silently as t dot starling said.

Remember that fwrite() returns an int, and this int represents the amount of data really written to the stream. So, if you see that fwrite() returns less than the amount of written data, it means you'll have to call fwrite() again in the future to write the remaining amount of data.

You can use stream_select() to wait for the stream to be available for writing, then continue writing data to the stream.

Non-blocking streams are useful as you can have more than one non-blocking stream, and wait for them to be available for writing.

＋add a note