日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.3-RELEASE-K, 13.0-RELEASE-K から 13.2-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
MQ_OPEN(2) FreeBSD システムコールマニュアル MQ_OPEN(2)
名称
mq_open -- メッセージキューをオープンする (リアルタイム)
ライブラリ
POSIX リアルタイムライブラリ (librt, -lrt)
書式
#include <mqueue.h>
mqd_t
mq_open(const char *name, int oflag, ...);
解説
mq_open() システムコールは、メッセージキュー記述子でプロセスとメッセージ
キューとの間の接続を確立します。それは、メッセージキューを参照するオープ
ンしているメッセージキュー記述とそのオープンしているメッセージキュー記述
を参照するメッセージキュー記述子を作成します。メッセージキュー記述子は、
そのメッセージキューを参照する他の関数によって使用されます。name 引数は、
メッセージキューの名前が付けられた文字列を指します。name 引数は、パス名の
ための構成規則に適合するべきです。name は、スラッシュ文字で始まるべきで
す。name の同じ値で mq_open() を呼び出すプロセスは、その名前を削除されて
いない限り、同じメッセージキューのオブジェクトを参照します。name 引数が既
存のメッセージキューの名前でなく、作成が要求されないなら、mq_open() は、
失敗して、エラーを返します。
oflag 引数は、メッセージキューをアクセスする必要な受信および送信を要求し
ます。呼び出しプロセスが、同等に保護されたファイルへのそれぞれ呼び込みま
たは書き込みアクセスを与えられるなら、受信メッセージまたは送信メッセージ
への要求されたアクセスパーミッションが、与えられます。
oflag の値は、次のリストからビット単位の包含的 OR の値です。アプリケー
ションは、oflag の値で、下記の最初の 3 つの値 (アクセスモード) の 1 つを
正確に指定するべきです:
O_RDONLY 受信メッセージのメッセージキューをオープンします。プロセス
は、mq_receive() で返されたメッセージキュー記述子を使用するこ
とができますが、mq_send() のものは使用することができません。
メッセージキューは、受信メッセージの同じか、または異なったプ
ロセスで複数回をオープンされます。
O_WRONLY 送信メッセージのキューをオープンします。プロセスは、mq_send()
で返されたメッセージキュー記述子を使用することができますが、
mq_receive() のものは使用することができません。メッセージ
キューは、送信メッセージの同じか、または異なったプロセスで複
数回をオープンされます。
O_RDWR メッセージを受信して、送信するキューをオープンします。プロセ
スは、O_RDONLY と O_WRONLY で許された任意の関数で使用すること
ができます。メッセージキューは、送信メッセージの同じか、また
は異なったプロセスで複数回をオープンされます。
残っているフラグのすべての組み合わせは、oflag の値で指定されます:
O_CREAT メッセージキューを作成します。2 つの追加引数を必要とします:
タイプ mode_t の mode と mq_attr 構造対へのポインタである
attr です。パス名 name が、まだ存在しているメッセージキューを
作成するために既に使用されていたなら、このフラグは、下記の
O_EXCL で述べられることを除いて、効果がありません。そうでなけ
れば、メッセージキューは、それにメッセージなしで作成されま
す。メッセージキューのユーザ ID は、プロセスの実効ユーザ ID
に設定され、メッセージキューのグループ ID は、プロセスの実効
グループ ID に設定されます。メッセージキューのパーミッション
ビットは、プロセスのファイルモード作成マスクで設定されたもの
を除いて、mode 引数の値に設定されます。ファイルパーミッション
ビット以外の mode 中のビットが指定されるとき、効果は不特定で
す。attr が NULL であるなら、メッセージキューは、実装で定義さ
れたデフォルトメッセージキュー属性で作成されます。attr が
NULL でなく、呼び出しプロセスが、名前で適切な特権があるなら、
メッセージキュー mq_maxmsg と mq_msgsize 属性は、attr. に
よって参照される mq_attr 構造体の対応するメンバの値に設定され
ます。attr が NULL ではないが、呼び出しプロセスが、名前で適切
な特権がないなら、mq_open() 関数は、失敗し、メッセージキュー
を作成しないでエラーを返します。
O_EXCL O_EXCL と O_CREAT が設定されるなら、mq_open() は、メッセージ
キューの名が存在しているなら、失敗します。
O_NONBLOCK mq_send() または mq_receive() が、現在利用可能でないリソース
またはメッセージをウェートするかどうか決定する、または errno
を EAGAIN に設定され失敗します。詳細に関しては mq_send(2) と
mq_receive(2) を参照してください。
mq_open() システムコールは、キューにメッセージに追加しないし、キューから
メッセージを削除しません。
注
FreeBSD は、ファイル記述子に基づいてメッセージキューを実装しています。記
述子は、fork(2) の後に子供によって継承されます。記述子は、exec(3) の後に
新しいイメージでクローズされます。select(2) と kevent(2) システムコール
は、メッセージキュー記述子に対してサポートされます。
モジュールをロードに関するか、またはカーネルにサービスをコンパイルするこ
とについては、mqueuefs(5) マニュアルページを参照してください。
戻り値
成功して終了するとき、関数は、メッセージキュー記述子を返します。そうでな
ければ、関数は、(mqd_t)-1 を返し、グローバル変数 errno にエラーを示す値が
設定されます。
エラー
mq_open() システムコールは、次の場合に失敗します:
[EACCES] メッセージキューが存在していて、oflag によって指定され
たパーミッションが拒否されるか、またはメッセージキュー
が存在せず、メッセージキューを作成するパーミッションが
否定されます。
[EEXIST] O_CREAT と O_EXCL が設定され、名前が付けられたメッセー
ジキューが、既に存在しています。
[EINTR] mq_open() 関数は、シグナルによって割り込まれました。
[EINVAL] mq_open() 関数は、与えられた名前をサポートしていませ
ん。
[EINVAL] O_CREAT が oflag で指定され、attr の値が NULL でなく、
そして、mq_maxmsg または mq_msgsize のどちらかが 0 以
下でした。
[EMFILE] 多すぎるメッセージキュー記述子またはファイル記述子が、
現在このプロセスで使用中です。
[ENAMETOOLONG] name 引数の長さが {PATH_MAX} を超えるか、またはパス名
の構成要素が {NAME_MAX} より長くなっています。
[ENFILE] 多すぎるメッセージキューが、現在システムでオープンされ
ています。
[ENOENT] O_CREAT が設定されていなくて、名前が付けられたメッセー
ジキューが存在していません。
[ENOSPC] 新しいメッセージキューを作成するために十分な空間があり
ません。
関連項目
mq_close(2), mq_getattr(2), mq_receive(2), mq_send(2), mq_setattr(2),
mq_timedreceive(3), mq_timedsend(3), mq_unlink(3), mqueuefs(5)
規格
mq_open() システムコールは、IEEE Std 1003.1-2004 (``POSIX.1'') に適合して
います。
歴史
POSIX メッセージキューのサポートは FreeBSD 7.0 ではじめて登場しました。
バグ
この実装は、name の値で厳しい要件を課します。それは、スラッシュ (`/') で
始まり、他のスラッシュ文字含んではいけません。
COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base Spec
ifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electri
cal and Electronics Engineers, Inc and The Open Group. In the event of
any discrepancy between this version and the original IEEE and The Open
Group Standard, the original IEEE and The Open Group Standard is the ref
eree document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.
FreeBSD 11.2 September 15, 2014 FreeBSD 11.2