msg_stat_queue

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

msg_stat_queueメッセージキューデータ構造体の情報を返す

説明

msg_stat_queue(SysvMessageQueue $queue): array|false

msg_stat_queue() は、queue で指定したメッセージキューのメタデータを返します。 これは、例えば受信したメッセージがどのプロセスから送信されたのかを調べる場合などに有用です。

パラメータ

queue

メッセージキュー

戻り値

成功した場合、戻り値は配列で、そのキーと値は以下のような意味をもちます。

msg_stat_queue の配列構造
msg_perm.uid キューの所有者の uid 。
msg_perm.gid キューの所有者の gid 。
msg_perm.mode キューのファイルアクセスモード。
msg_stime キューに対して最後にメッセージが送信された時刻。
msg_rtime キューから最後にメッセージを受信した時刻。
msg_ctime キューが最後に更新された時刻。
msg_qnum キューにある読み込み待ちのメッセージの数。
msg_qbytes ひとつのメッセージキューに含められる最大のバイト数。 Linux では、この値の取得や設定を /proc/sys/kernel/msgmnb で行えます。
msg_lspid 最後にキューに対してメッセージを送信したプロセスの pid 。
msg_lrpid 最後にキューからメッセージを受信したプロセスの pid 。

失敗時に false を返します。

変更履歴

バージョン 説明
8.0.0 引数 queue は、 SysvMessageQueue のインスタンスを期待するようになりました。 これより前のバージョンでは、リソースが期待されていました。

参考

  • msg_remove_queue() - メッセージキューを破棄する
  • msg_receive() - メッセージキューからメッセージを受信する
  • msg_get_queue() - メッセージキューを作成またはそれにアタッチする
  • msg_set_queue() - メッセージキューデータ構造体の情報を設定する

関連キーワード:  メッセージキュー, queue, キュー, 情報, メッセージ, 最後, stat, 受信, perm, 送信