リナックスコマンド

mq_openのヘルプ・マニュアル

日本語 英語

• help
• man

mq_open --help

man mq_open

MQ_OPEN(3) Linux Programmer’s Manual MQ_OPEN(3) 名前 mq_open - メッセージキューをオープンする 書式 #include /* For O_* constants */ #include /* For mode constants */ #include mqd_t mq_open(const char *name, int oflag); mqd_t mq_open(const char *name, int oflag, mode_t mode, struct mq_attr *attr); -lrt でリンクする。 説明 mq_open() は、新しい POSIX メッセージキューを作成するか、既存のキューを オープンする。キューは name で識別される。 name の構成の詳細について は mq_overview (7) を参照。 oflag 引き数には、関数呼び出しの操作を制御するフラグを指定する (oflag の値の定義は のインクルードにより得られる)。 oflag には、以下 のうちいずれか一つを必ず指定しなければならない。 O_RDONLY メッセージの受信専用としてキューをオープンする。 O_WRONLY メッセージの送信専用としてキューをオープンする。 O_RDWR メッセージの送受信両用としてキューをオープンする。 0 個以上の下記のフラグを、ビット単位の OR (論理和) で oflag に追加で指 定できる。 O_NONBLOCK 非停止 (non-blocking) モード で キ ュ ー を オ ー プ ン す る 。 mq_receive(3) と mq_send(3) は、通常は停止 (block) する状況にお いて、エラー EAGAIN で失敗するようになる。 O_CREAT 存在しない場合、メッセージキューを作成する。メッセージキューの所 有者 (ユーザ ID) とグループ所有権 (グループ ID) は、それぞれ呼び 出し元プロセスの実効ユーザ ID と実効グループ ID に設定される。 O_EXCL O_CREAT が oflag に指定され、かつ指定された名前 name を持つキ ュ ーがすでに存在する場合、エラー EEXIST で失敗する。 oflag に O_CREAT を指定する場合、追加で 2つの引き数を与える必要がある。 mode 引き数は、新しいキューに適用される許可 設 定 (permission) を 、 open(2) と同じように指定する (許可ビットのシンボル定義は のインクルードにより得られる)。許可設定はプロセスの umask でマスクさ れ る。 attr 引き数は、キューの属性を指定する。詳細は、 mq_getattr(3) を参 照。 attr が NULL の場合、キューは実装で定義されたデフォルト属性で作 成 される。 返り値 成功すると、 mq_open() はメッセージキュー記述子 (message queue descrip- tor) を返す。メッセージキュー記述子は他のメッセージキュー関連の関数で使 用 される。エラーの場合、 mq_open() は (mqd_t) -1 を返し、 errno にエラ ーを示す値を設定する。 エラー EACCES キューは存在するが、呼び出し元が指定されたモードでそのキューをオ ープンする許可を持たない。 EACCES name にスラッシュが 2 個以上含まれていた。 EEXIST oflag に O_CREAT と O_EXCL の両方が指定されたが、指定された名前 name を持つキューがすでに存在する。 EINVAL oflag に O_CREAT が指定され、かつ attr が NULL 以 外 だ が 、 attr->mq_maxmsg か attr->mq_msqsize が不正であった。これらのフィ ールドは両方とも 0 より大きくなければならない。プロセスが特権 を 持 た な い (CAP_SYS_RESOURCE ケーパビリティを持たない) 場合、 attr->mq_maxmsg と attr->mq_msgsize は、それぞれ上限 msg_max 、 msgsize_max 以下でなければならない。また、特権プロセスの場合でも 、 attr->mq_maxmsg は HARD_MAX 上限を超えることはできない。 ( こ れらの上限に関する詳細は mq_overview(7) を参照。) EMFILE そのプロセスがオープンしているファイルとメッセージキューの数がプ ロセス毎の上限に達している。 ENAMETOOLONG name が長すぎる。 ENFILE システム全体でオープンしているファイルとメッセージキューの合計数 がシステム上限に達している。 ENOENT O_CREAT フラグが oflag に指定されなかったが、指定された名前 name を持つキューが存在しない。 ENOENT name が "/" だけで、その後ろに他の文字が続いていなかった。 ENOMEM 十分なメモリがない。 ENOSPC 新しいメッセージキューを作成するのに十分な空間がない。このエラー は お そ ら く queues_max 上限に抵触したため起こったのだろう。 mq_overview(7) を参照。 準拠 POSIX.1-2001. バグ 2.6.14 より前のカーネルには、プロセスの umask が mode で指定された許 可 設定に適用されなかった。 関連項目 mq_close(3), mq_getattr(3), mq_notify(3), mq_receive(3), mq_send(3), mq_unlink(3), mq_overview(7) Linux 2009-02-20 MQ_OPEN(3)

MQ_OPEN(3) Linux Programmer’s Manual MQ_OPEN(3) NAME mq_open - open a message queue SYNOPSIS #include /* For O_* constants */ #include /* For mode constants */ #include mqd_t mq_open(const char *name, int oflag); mqd_t mq_open(const char *name, int oflag, mode_t mode, struct mq_attr *attr); Link with -lrt. DESCRIPTION mq_open() creates a new POSIX message queue or opens an existing queue. The queue is identified by name. For details of the construction of name, see mq_overview(7). The oflag argument specifies flags that control the operation of the call. (Definitions of the flags values can be obtained by including .) Exactly one of the following must be specified in oflag: O_RDONLY Open the queue to receive messages only. O_WRONLY Open the queue to send messages only. O_RDWR Open the queue to both send and receive messages. Zero or more of the following flags can additionally be ORed in oflag: O_NONBLOCK Open the queue in non-blocking mode. In circumstances where mq_receive(3) and mq_send(3) would normally block, these func- tions instead fail with the error EAGAIN. O_CREAT Create the message queue if it does not exist. The owner (user ID) of the message queue is set to the effective user ID of the calling process. The group ownership (group ID) is set to the effective group ID of the calling process. O_EXCL If O_CREAT was specified in oflag, and a queue with the given name already exists, then fail with the error EEXIST. If O_CREAT is specified in oflag, then two additional arguments must be supplied. The mode argument specifies the permissions to be placed on the new queue, as for open(2). (Symbolic definitions for the permis- sions bits can be obtained by including .) The permissions settings are masked against the process umask. The attr argument spec- ifies attributes for the queue. See mq_getattr(3) for details. If attr is NULL, then the queue is created with implementation-defined default attributes. RETURN VALUE On success, mq_open() returns a message queue descriptor for use by other message queue functions. On error, mq_open() returns (mqd_t) -1, with errno set to indicate the error. ERRORS EACCES The queue exists, but the caller does not have permission to open it in the specified mode. EACCES name contained more than one slash. EEXIST Both O_CREAT and O_EXCL were specified in oflag, but a queue with this name already exists. EINVAL O_CREAT was specified in oflag, and attr was not NULL, but attr->mq_maxmsg or attr->mq_msqsize was invalid. Both of these fields must be greater than zero. In a process that is unprivi- leged (does not have the CAP_SYS_RESOURCE capability), attr->mq_maxmsg must be less than or equal to the msg_max limit, and attr->mq_msgsize must be less than or equal to the msg- size_max limit. In addition, even in a privileged process, attr->mq_maxmsg cannot exceed the HARD_MAX limit. (See mq_overview(7) for details of these limits.) EMFILE The process already has the maximum number of files and message queues open. ENAMETOOLONG name was too long. ENFILE The system limit on the total number of open files and message queues has been reached. ENOENT The O_CREAT flag was not specified in oflag, and no queue with this name exists. ENOENT name was just "/" followed by no other characters. ENOMEM Insufficient memory. ENOSPC Insufficient space for the creation of a new message queue. This probably occurred because the queues_max limit was encoun- tered; see mq_overview(7). CONFORMING TO POSIX.1-2001. BUGS In kernels before 2.6.14, the process umask was not applied to the per- missions specified in mode. SEE ALSO mq_close(3), mq_getattr(3), mq_notify(3), mq_receive(3), mq_send(3), mq_unlink(3), mq_overview(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 2009-02-20 MQ_OPEN(3)