kazmax - Linux で自宅サーバー

mq_getattr - ライブラリコールの説明 - Linux コマンド集 一覧表

  1. 名前
  2. 書式
  3. 説明
  4. 返り値
  5. エラー
  6. 準拠
  7. 関連項目

名前

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

書式

#include <mqueue.h>

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

説明

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 ()でキューが作成される際に初期化される。 このフィールドに現れるフラグは O_NONBLOCK だけである。
mq_maxmsgmq_msgsize フィールドは mq_open ()でメッセージキューが作成される際にセットされる。 mq_maxmsg フィールドは、 mq_send ()を使ってキューに入れることができるメッセージ数の上限である。 mq_msgsize フィールドは、キューに入れることができるメッセージの 上限サイズである。 これらのフィールドはどちらも 0 より大きな値でなければならない。 これらのフィールドに設定できる値の上限は /proc ファイルにより決まる。 /proc ファイルの詳細は   mq_open (3) に説明されている。
mq_curmsgs フィールドはキューに現在格納されているメッセージ数を返す。
mq_setattr ()は、 newattr が指す mq_attr 構造体で与えられた情報を使って、メッセージキューの属性を設定する。 変更することができる属性は、 mq_flagsO_NONBLOCK フラグの設定だけである。 newattr の他のフィールドは無視される。 oldattr フィールドが NULL 以外の場合、 mq_getattr ()が返すのと同じ情報を格納した mq_attr 構造体を oldattr が指すバッファに入れて返す。

返り値

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

エラー

EBADF
mqdes で指定された記述子が不正である。
EINVAL
newattr->mq_flagsO_NONBLOCK 以外のビットがセットされていた。

準拠

POSIX.1-2001.

関連項目