.\" t .\" Copyright (C) 2006 Michael Kerrisk .\" .\" %%%LICENSE_START(VERBATIM) .\" Permission is granted to make and distribute verbatim copies of this .\" manual provided the copyright notice and this permission notice are .\" preserved on all copies. .\" .\" Permission is granted to copy and distribute modified versions of this .\" manual under the conditions for verbatim copying, provided that the .\" entire resulting derived work is distributed under the terms of a .\" permission notice identical to this one. .\" .\" Since the Linux kernel and libraries are constantly changing, this .\" manual page may be incorrect or out-of-date. The author(s) assume no .\" responsibility for errors or omissions, or for damages resulting from .\" the use of the information contained herein. The author(s) may not .\" have taken the same level of care in the production of this manual, .\" which is licensed free of charge, as they might when working .\" professionally. .\" .\" Formatted or processed versions of this manual, if unaccompanied by .\" the source, must acknowledge the copyright and authors of this work. .\" %%%LICENSE_END .\" .\"******************************************************************* .\" .\" This file was generated with po4a. Translate the source file. .\" .\"******************************************************************* .\" .\" Japanese Version Copyright (c) 2006 Akihiro MOTOKI all rights reserved. .\" Translated 2006-04-23, Akihiro MOTOKI .\" Updated 2008-11-09, Akihiro MOTOKI, LDP v3.13 .\" .TH MQ_RECEIVE 3 2014\-06\-03 Linux "Linux Programmer's Manual" .SH 名前 mq_receive, mq_timedreceive \- メッセージキューからメッセージを受信する .SH 書式 .nf \fB#include \fP .sp \fBssize_t mq_receive(mqd_t \fP\fImqdes\fP\fB, char *\fP\fImsg_ptr\fP\fB,\fP \fB size_t \fP\fImsg_len\fP\fB, unsigned int *\fP\fImsg_prio\fP\fB);\fP .sp \fB#include \fP \fB#include \fP .sp \fBssize_t mq_timedreceive(mqd_t \fP\fImqdes\fP\fB, char *\fP\fImsg_ptr\fP\fB,\fP \fB size_t \fP\fImsg_len\fP\fB, unsigned int *\fP\fImsg_prio\fP\fB,\fP \fB const struct timespec *\fP\fIabs_timeout\fP\fB);\fP .fi .sp \fI\-lrt\fP でリンクする。 .sp .ad l .in -4n glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7) 参照): .in .sp \fBmq_timedreceive\fP(): .RS 4 _XOPEN_SOURCE\ >=\ 600 || _POSIX_C_SOURCE\ >=\ 200112L .RE .ad .SH 説明 \fBmq_receive\fP() は、記述子 \fImqdes\fP で参照されるメッセージキューから最も高い優先度を持つ 最も古いメッセージを削除し、そのメッセージを \fImsg_ptr\fP が指すバッファーに格納する。 \fImsg_len\fP 引き数は、 \fImsg_ptr\fP が指すバッファーの大きさを示す。この値はキューの \fImq_msgsize\fP 属性以上でなければならない (\fBmq_getattr\fP(3) 参照)。 \fImsg_prio\fP が NULL 以外の場合、 \fImsg_prio\fP が指すバッファーに受信したメッセージの優先度が格納される。 キューが空の場合、デフォルトでは、 \fBmq_receive\fP() は、新しいメッセージが届くか、関数呼び出しがシグナルハンドラーにより 中断されるまで、停止 (block) する。 メッセージキュー記述 (message queue description) で \fBO_NONBLOCK\fP フラグが有効になっている場合は、 \fBmq_receive\fP() はエラー \fBEAGAIN\fP ですぐに失敗する。 \fBmq_timedreceive\fP() は \fBmq_receive\fP() と全く同じ動作をするが、 メッセージキューが空で、メッセージキュー記述で \fBO_NONBLOCK\fP フラグが有効になっていない場合に、この呼び出しが停止する時間の上限を \fIabs_timeout\fP が指す構造体で指定する点が異なる。この上限は、タイムアウトの時刻を、 時刻紀元 (Epoch; 1970\-01\-01 00:00:00 +0000 (UTC)) からの経過時間 (秒とナノ秒の組) で指定する。タイムアウト時刻は以下の構造体で指定する: .sp .in +4n .nf struct timespec { time_t tv_sec; /* 秒 */ long tv_nsec; /* ナノ秒 */ }; .fi .in メッセージがキューになく、関数呼び出し時にすでにタイムアウト時刻が 過ぎている場合、 \fBmq_timedreceive\fP() はすぐに返る。 .SH 返り値 成功すると、 \fBmq_receive\fP() と \fBmq_timedreceive\fP() は受信したメッセージのバイト数を返す。 エラーの場合、\-1 を返し、 \fIerrno\fP にエラーを示す値を設定する。 .SH エラー .TP \fBEAGAIN\fP キューが空で、かつ \fImqdes\fP で参照されるメッセージキュー記述で \fBO_NONBLOCK\fP フラグがセットされていた。 .TP \fBEBADF\fP \fImqdes\fP で指定された記述子が不正である。 .TP \fBEINTR\fP 関数呼び出しがシグナルハンドラーにより中断された。 \fBsignal\fP(7) 参照。 .TP \fBEINVAL\fP 関数呼び出しは停止するはずであったが、 \fIabs_timeout\fP が不正であった。 \fIabs_timeout\fP が不正とは、 \fItv_sec\fP が 0 未満、もしくは \fItv_nsec\fP が 0 未満か 1,000,000,000 より大きい、ということである。 .TP \fBEMSGSIZE\fP \fImsg_len\fP がメッセージキューの \fImq_msgsize\fP 属性よりも小さかった。 .TP \fBETIMEDOUT\fP メッセージが転送される前に関数呼び出しがタイムアウトした。 .SH 属性 .SS "マルチスレッディング (pthreads(7) 参照)" 関数 \fBmq_receive\fP() と \fBmq_timedreceive\fP() はスレッドセーフである。 .SH 準拠 POSIX.1\-2001. .SH 注意 Linux では、 \fBmq_timedreceive\fP() はシステムコールである。 \fBmq_receive\fP() はライブラリ関数で、 \fBmq_timedreceive\fP() システムコールを用いて実装されている。 .SH 関連項目 \fBmq_close\fP(3), \fBmq_getattr\fP(3), \fBmq_notify\fP(3), \fBmq_open\fP(3), \fBmq_send\fP(3), \fBmq_unlink\fP(3), \fBmq_overview\fP(7), \fBtime\fP(7) .SH この文書について この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.79 の一部 である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man\-pages/ に書かれている。