mq_receiveのヘルプ・マニュアル
日本語 英語
mq_receive --help
man mq_receive
MQ_RECEIVE(3) Linux Programmer’s Manual MQ_RECEIVE(3)
名前
mq_receive, mq_timedreceive - メッセージキューからメッセージを受信する
書式
#include
ssize_t mq_receive(mqd_t mqdes, char *msg_ptr,
size_t msg_len, unsigned *msg_prio);
#define _XOPEN_SOURCE 600
#include
#include
ssize_t mq_timedreceive(mqd_t mqdes, char *msg_ptr,
size_t msg_len, unsigned *msg_prio,
const struct timespec *abs_timeout);
-lrt でリンクする。
説明
mq_receive() は、記述子 mqdes で参照されるメッセージキューから最も高い
優先度を持つ最も古いメッセージを削除し、そのメッセージを msg_ptr が指す
バ ッファに格納する。 msg_len 引き数は、 msg_ptr が指すバッファの大きさ
を示す。この値はキューの mq_msgsize 属性よりも大きくなければな ら な い
(mq_getattr(3) 参照)。 prio が NULL 以外の場合、 prio が指すバッファに
受信したメッセージの優先度が格納される。
キューが空の場合、デフォルトでは、 mq_receive() は、新しいメッセージ が
届 く か 、 関 数 呼 び出しがシグナルハンドラにより中断されるまで、停止
(block) する。メッセージキュー記 述 (message queue description) で
O_NONBLOCK フ ラ グ が 有効になっている場合は、 mq_receive() はエラー
EAGAIN ですぐに失敗する。
mq_timedreceive() は mq_receive() と全く同じ動作をするが、メッセージ キ
ュ ーが空で、メッセージキュー記述で O_NONBLOCK フラグが有効になっていな
い場合に、この呼び出しが停止する時間の上限を abs_timeout が指す構造体で
指 定 す る点が異なる。この上限は、タイムアウトの時刻を時刻紀元 (Epoch;
1970 年 1 月 1 日 00:00:00) からの経過時間 (秒とナノ秒の組) で指定す る
。タイムアウト時刻は以下の構造体で指定する:
struct timespec {
time_t tv_sec; /* 秒 */
long tv_nsec; /* ナノ秒 */
};
メ ッセージがキューになく、関数呼び出し時にすでにタイムアウト時刻が過ぎ
ている場合、 mq_timedreceive() はすぐに返る。
返り値
成功すると、 mq_receive() と mq_timedreceive() は受信したメッセージのバ
イ ト数を返す。エラーの場合、-1 を返し、 errno にエラーを示す値を設定す
る。
エラー
EAGAIN キューが空で、かつ mqdes で参照されるメッセージキ ュ ー 記 述 で
O_NONBLOCK フラグがセットされていた。
EBADF mqdes で指定された記述子が不正である。
EINTR 関数呼び出しがシグナルハンドラにより中断された。 signal(7) 参照
。
EINVAL 関数呼び出しは停止するはずであったが、 abs_timeout が不正であ っ
た。 abs_timeout が不正とは、 tv_sec が 0 未満、もしくは tv_nsec
が 0 未満か 1,000,000,000 より大きい、ということである。
EMSGSIZE
msg_len がメッセージキューの mq_msgsize 属性よりも小さかった。
ETIMEDOUT
メッセージが転送される前に関数呼び出しがタイムアウトした。
準拠
POSIX.1-2001.
注意
Linux では、 mq_timedreceive() はシステムコールである。 mq_receive() は
ライブラリ関数で、 mq_timedreceive() システムコールを用いて実装されてい
る。
関連項目
mq_close(3), mq_getattr(3), mq_notify(3), mq_open(3), mq_send(3),
mq_unlink(3), feature_test_macros(7), mq_overview(7), time(7)
Linux 2008-09-29 MQ_RECEIVE(3)
MQ_RECEIVE(3) Linux Programmer’s Manual MQ_RECEIVE(3)
NAME
mq_receive, mq_timedreceive - receive a message from a message queue
SYNOPSIS
#include
ssize_t mq_receive(mqd_t mqdes, char *msg_ptr,
size_t msg_len, unsigned *msg_prio);
#define _XOPEN_SOURCE 600
#include
#include
ssize_t mq_timedreceive(mqd_t mqdes, char *msg_ptr,
size_t msg_len, unsigned *msg_prio,
const struct timespec *abs_timeout);
Link with -lrt.
DESCRIPTION
mq_receive() removes the oldest message with the highest priority from
the message queue referred to by the descriptor mqdes, and places it in
the buffer pointed to by msg_ptr. The msg_len argument specifies the
size of the buffer pointed to by msg_ptr; this must be greater than the
mq_msgsize attribute of the queue (see mq_getattr(3)). If prio is not
NULL, then the buffer to which it points is used to return the priority
associated with the received message.
If the queue is empty, then, by default, mq_receive() blocks until a
message becomes available, or the call is interrupted by a signal han-
dler. If the O_NONBLOCK flag is enabled for the message queue descrip-
tion, then the call instead fails immediately with the error EAGAIN.
mq_timedreceive() behaves just like mq_receive(), except that if the
queue is empty and the O_NONBLOCK flag is not enabled for the message
queue description, then abs_timeout points to a structure which speci-
fies a ceiling on the time for which the call will block. This ceiling
is an absolute timeout in seconds and nanoseconds since the Epoch (mid-
night on the morning of 1 January 1970), specified in the following
structure:
struct timespec {
time_t tv_sec; /* seconds */
long tv_nsec; /* nanoseconds */
};
If no message is available, and the timeout has already expired by the
time of the call, mq_timedreceive() returns immediately.
RETURN VALUE
On success, mq_receive() and mq_timedreceive() return the number of
bytes in the received message; on error, -1 is returned, with errno set
to indicate the error.
ERRORS
EAGAIN The queue was empty, and the O_NONBLOCK flag was set for the
message queue description referred to by mqdes.
EBADF The descriptor specified in mqdes was invalid.
EINTR The call was interrupted by a signal handler; see signal(7).
EINVAL The call would have blocked, and abs_timeout was invalid, either
because tv_sec was less than zero, or because tv_nsec was less
than zero or greater than 1000 million.
EMSGSIZE
msg_len was less than the mq_msgsize attribute of the message
queue.
ETIMEDOUT
The call timed out before a message could be transferred.
CONFORMING TO
POSIX.1-2001.
NOTES
On Linux, mq_timedreceive() is a system call, and mq_receive() is a
library function layered on top of that system call.
SEE ALSO
mq_close(3), mq_getattr(3), mq_notify(3), mq_open(3), mq_send(3),
mq_unlink(3), feature_test_macros(7), mq_overview(7), time(7)
COLOPHON
This page is part of release 3.22 of the Linux man-pages project. A
description of the project, and information about reporting bugs, can
be found at http://www.kernel.org/doc/man-pages/.
Linux 2008-09-29 MQ_RECEIVE(3)