名前

       mq_getattr, mq_setattr - メッセージキューの属性を設定/取得する

書式

       #include <mqueue.h>

       int mq_getattr(mqd_t mqdes, struct mq_attr *attr);

       int mq_setattr(mqd_t mqdes, struct mq_attr *newattr,
                        struct mq_attr *oldattr);

       -lrt でリンクする。

説明

       mq_getattr()  と mq_setattr()  は、記述子 mqdes で参照されるメッセージキューの属性の取得と
       変更をそれぞれ行う。

       mq_getattr()  は、 attr が指すバッファに mq_attr  構造体を格納して返す。この構造体は以下の
       ように定義されている:

           struct mq_attr {
               long mq_flags;       /* フラグ: 0 か O_NONBLOCK */
               long mq_maxmsg;      /* キューの最大メッセージ数 */
               long mq_msgsize;     /* 最大メッセージサイズ (バイト単位) */
               long mq_curmsgs;     /* キューに現在入っているメッセージ数 */
           };

       mq_flags  フィールドには、オープンメッセージキュー記述 (open message queue description) に
       関連付けられているフラグが格納される。 このフィールドは mq_open(3)  でキューが作成される際
       に初期化される。 このフィールドに現れるフラグは O_NONBLOCK だけである。

       mq_maxmsg  と mq_msgsize フィールドは mq_open(3)  でメッセージキューが作成される際にセット
       される。 mq_maxmsg フィールドは、 mq_send(3)  を使ってキューに入れることができるメッセージ
       数の上限である。  mq_msgsize フィールドは、キューに入れることができるメッセージの 上限サイ
       ズである。 これらのフィールドはどちらも 0 より大きな値でなければならない。  これらのフィー
       ルドに設定できる値の上限は  /proc ファイルにより決まる。 /proc ファイルの詳細は mq_open(3)
       に説明されている。

       mq_curmsgs フィールドはキューに現在格納されているメッセージ数を返す。

       mq_setattr()  は、 newattr が指す mq_attr 構造体で与えられた情報を使って、メッセージキュー
       の属性を設定する。  変更することができる属性は、 mq_flags の O_NONBLOCK フラグの設定だけで
       ある。  newattr  の他のフィールドは無視される。  oldattr  フィールドが  NULL  以外の場合、
       mq_getattr()  が返すのと同じ情報を格納した mq_attr 構造体を oldattr が指すバッファに入れて
       返す。

返り値

       成功すると、 mq_getattr () と mq_setattr () は 0 を返す。エラーの場合、-1  を返し、  errno
       にエラーを示す値を設定する。

エラー

       EBADF  mqdes に指定されたディスクリプタが不正である。

       EINVAL newattr->mq_flags に O_NONBLOCK 以外のビットがセットされていた。

準拠

       POSIX.1-2001.

注意

       Linux  では、 mq_getattr()  と mq_setattr()  はライブラリ関数であり、 mq_getsetattr(2)  シ
       ステムコールを用いて実装されている。

関連項目

       mq_close(3),   mq_notify(3),   mq_open(3),   mq_receive(3),   mq_send(3),    mq_unlink(3),
       mq_overview(7)

この文書について

       この  man ページは Linux man-pages プロジェクトのリリース 3.54 の一部 である。プロジェクト
       の説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。