Php/docs/function.com-message-pump

提供:Dev Guides
< Php
移動先:案内検索

com_message_pump

(PHP 4 >= 4.2.0, PHP 5, PHP 7)

com_message_pumpCOM メッセージを処理し、timeoutms ミリ秒の間待つ


説明

com_message_pump ([ int $timeout_milliseconds = 0 ] ) : bool

この関数は、timeout_milliseconds ミリ秒が経過するか キューにメッセージが到着するまで待機します。

この関数の目的は、別々の場所にある COM のコールを振り分け、同期の 問題をうまく処理することです。これにより、発生するイベントを 効率的にスクリプトで待ち受けられるようになり、バックグラウンドで 動作している他のコードやイベントも処理できるようになります。 COM オブジェクトのイベントを使用している間は、 com_event_sink() 関数の例で示したように この関数をループ内で使用すべきです。


パラメータ

timeout_milliseconds

タイムアウト。ミリ秒単位で指定します。

timeout_milliseconds の値を指定しなかった場合は 0 であるとみなされます。0 という値は、一切待機しないことを 意味します。処理待ち状態のメッセージがあればそれを処理し、 なければこの関数はすぐに false を返します。


返り値

タイムアウトの前に メッセージが到着した場合は、そのメッセージが処理されて 関数は true を返します。メッセージを処理することなく タイムアウトが発生した場合は、この関数は false を返します。