(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
msg_receive — メッセージキューからメッセージを受信する
$queue
,$desired_message_type
,&$received_message_type
,$max_message_size
,&$message
,$unserialize
= true
,$flags
= 0,&$error_code
= null
msg_receive() は、指定した queue
から指定した desired_message_type
の最初のメッセージを受信します。
queue
メッセージキュー
desired_message_type
desired_message_type
が 0 の場合、 キューの先頭にあるメッセージが返されます。desiredmsgtype
が 0 より大きな値の場合、その型のメッセージのうち一番最初にあるものが返されます。 desired_message_type
が 0 より小さな値の場合、 desired_message_type
の絶対値と同じかそれより小さい型のメッセージのうち一番最初にあるものが返されます。 条件を満たすメッセージがない場合は、 条件を満たすメッセージがキューに投入されるまで待ち続けます。 パラメータ flags
に MSG_IPC_NOWAIT
を指定することで、 ブロックモードではなくすることが可能です。
received_message_type
受信したメッセージの型がこのパラメータに保存されます。
max_message_size
読み込むメッセージの最大サイズは mmax_message_size
で指定します。もしキューにあるメッセージのサイズがこれより大きい場合、 (以下で説明する flags
が設定されていない限り) この関数は失敗します。
message
エラーが発生しなければ、 受信したメッセージは message
に保存されます。
unserialize
このパラメータが true
に設定されている場合、 メッセージはセッションモジュールと同様の方法でシリアライズされているものとみなされます。 メッセージは元の状態に復元されたうえでスクリプトに返されます。 これにより、配列やオブジェクト構造体のような複雑な形式のデータを他の PHP スクリプトから簡単に受信することが可能となります。 また、もし WDDX シリアライザを使用しているなら、あらゆる WDDX 互換のソースからデータを受け取ることが可能となります。
unserialize
が false
の場合、 メッセージはバイナリセーフな文字列として返されます。
flags
オプションの flags
により、低レベルの msgrcv システムコールにフラグを渡すことが可能です。デフォルト値は 0 ですが、以下の値のうちのいくつかを(値を足すかあるいは論理和ととることで) 指定することが可能です。
MSG_IPC_NOWAIT | desired_message_type を満たすメッセージが存在しない場合に、 待ち続けずにすぐに結果を返します。 関数は失敗し、MSG_ENOMSG に対応する整数値を返します。 |
MSG_EXCEPT | このフラグを正の desired_message_type と組み合わせて使用すると、この関数は desired_message_type 以外の型をもつ 最初のメッセージを受信するようになります。 |
MSG_NOERROR | このフラグを設定しておくと、メッセージが max_message_size より大きい場合に そのメッセージを max_message_size までに切り詰め、 エラーを返しません。 |
error_code
エラーが発生した場合は、オプションの error_code
にシステムの errno 値が設定されます。
成功した場合に true
を、失敗した場合に false
を返します。
処理が正常に完了すると、メッセージキューデータ構造体は以下のように更新されます。 msg_lrpid
には呼び出し元のプロセス ID が 設定され、msg_qnum
が 1 減少し、 msg_rtime
が現在の時刻に設定されます。
バージョン | 説明 |
---|---|
8.0.0 | 引数 queue は、 SysvMessageQueue のインスタンスを期待するようになりました。 これより前のバージョンでは、リソースが期待されていました。 |