mq_sendのヘルプ・マニュアル
日本語 英語
mq_send --help
man mq_send
MQ_SEND(3) Linux Programmer’s Manual MQ_SEND(3)
名前
mq_send, mq_timedsend - メッセージキューにメッセージを送信する
書式
#include
mqd_t mq_send(mqd_t mqdes, const char *msg_ptr,
size_t msg_len, unsigned msg_prio);
#define _XOPEN_SOURCE 600
#include
#include
mqd_t mq_timedsend(mqd_t mqdes, const char *msg_ptr,
size_t msg_len, unsigned msg_prio,
const struct timespec *abs_timeout);
-lrt でリンクする。
説明
mq_send() は、記述子 mqdes で参照されるメッセージキューに msg_ptr が指
すメッセージを追加する。 msg_len 引き数は、 msg_ptr が指すメッセージ の
長 さを示す。この長さはキューの mq_msgsize 属性以下でなければならない。
長さが 0 のメッセージも認められている。
msg_prio 引き数は、メッセージの優先度を指定する負でない整数である。メッ
セ ージは優先度の降順でキューに格納され、同じ優先度の新しいメッセージは
同じ優先度の古いメッセージの後ろに格納される。
メッセージキューがすでに一杯の場合 (すなわち、キューに入っているメッ セ
ー ジ数がキューの mq_maxmsg 属性と等しい場合)、デフォルトでは、 mq_send
() は、メッセージをキューイングするのに十分な空間ができるか、関数呼び出
しがシグナルハンドラにより中断されるまで、停止 (block) する。メッセージ
キュー記述 (message queue description) で O_NONBLOCK フラグが有効になっ
ている場合は、 mq_send() はエラー EAGAIN ですぐに失敗する。
mq_timedsend() は mq_send() と全く同じ動作をするが、メッセージキューが
一杯で、メッセージキュー記述で O_NONBLOCK フラグが有効になっていない 場
合に、この呼び出しが停止する時間の上限を abs_timeout が指す構造体で指定
する点が異なる。この上限は、タイムアウトの時刻を時刻紀元 (Epoch; 1970
年 1 月 1 日 00:00:00) からの経過時間 (秒とナノ秒の組) で指定する。タイ
ムアウト時刻は以下の構造体で指定する:
struct timespec {
time_t tv_sec; /* 秒 */
long tv_nsec; /* ナノ秒 */
};
メッセージキューが一杯で、関数呼び出し時にすでにタイムアウト時刻が過 ぎ
ている場合、 mq_timedsend() はすぐに返る。
返り値
成 功すると、 mq_send() と mq_timedsend() は 0 を返す。エラーの場合、-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_timedsend() はシステムコールである。 mq_send() はライブ
ラリ関数で、 mq_timedsend() システムコールを用いて実装されている。
関連項目
mq_close(3), mq_getattr(3), mq_notify(3), mq_open(3), mq_receive(3),
mq_unlink(3), feature_test_macros(7), mq_overview(7), time(7)
Linux 2008-09-29 MQ_SEND(3)
MQ_SEND(3) Linux Programmer’s Manual MQ_SEND(3)
NAME
mq_send, mq_timedsend - send a message to a message queue
SYNOPSIS
#include
mqd_t mq_send(mqd_t mqdes, const char *msg_ptr,
size_t msg_len, unsigned msg_prio);
#define _XOPEN_SOURCE 600
#include
#include
mqd_t mq_timedsend(mqd_t mqdes, const char *msg_ptr,
size_t msg_len, unsigned msg_prio,
const struct timespec *abs_timeout);
Link with -lrt.
DESCRIPTION
mq_send() adds the message pointed to by msg_ptr to the message queue
referred to by the descriptor mqdes. The msg_len argument specifies
the length of the message pointed to by msg_ptr; this length must be
less than or equal to the queue’s mq_msgsize attribute. Zero-length
messages are allowed.
The msg_prio argument is a non-negative integer that specifies the pri-
ority of this message. Messages are placed on the queue in decreasing
order of priority, with newer messages of the same priority being
placed after older messages with the same priority.
If the message queue is already full (i.e., the number of messages on
the queue equals the queue’s mq_maxmsg attribute), then, by default,
mq_send() blocks until sufficient space becomes available to allow the
message to be queued, or until 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_timedsend() behaves just like mq_send(), except that if the queue is
full and the O_NONBLOCK flag is not enabled for the message queue
description, then abs_timeout points to a structure which specifies a
ceiling on the time for which the call will block. This ceiling is an
absolute timeout in seconds and nanoseconds since the Epoch (midnight
on the morning of 1 January 1970), specified in the following struc-
ture:
struct timespec {
time_t tv_sec; /* seconds */
long tv_nsec; /* nanoseconds */
};
If the message queue is full, and the timeout has already expired by
the time of the call, mq_timedsend() returns immediately.
RETURN VALUE
On success, mq_send() and mq_timedsend() return zero; 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 greater 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_timedsend() is a system call, and mq_send() 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_receive(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_SEND(3)