doc/ja_JP.eucJP/man/man3/msgsnd.3
Kazuo Horikawa cb5d1a9147 Replace jpman project specific RCS keyword with $FreeBSD.
jpman project specific RCS keyword (jpman %Id) is obsolete,
after manual entries are stored in freefall CVS repository.
This old Id is useless and more worse it confuses users and bug reporters.
So, this old Id is removed.

Submitted by:jpman project <man-jp@jp.FreeBSD.org>
2001-05-14 01:10:24 +00:00

170 lines
4.7 KiB
Groff

.\" %NetBSD: msgsnd.2,v 1.1 1995/10/16 23:49:24 jtc Exp %
.\"
.\" Copyright (c) 1995 Frank van der Linden
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed for the NetBSD Project
.\" by Frank van der Linden
.\" 4. The name of the author may not be used to endorse or promote products
.\" derived from this software without specific prior written permission
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\" %Id: msgsnd.3,v 1.4 1997/11/23 17:58:40 bde Exp %
.\"
.\"/
.\" $FreeBSD$
.Dd November 24, 1997
.Dt MSGSND 3
.Os FreeBSD
.Sh 名称
.Nm msgsnd
.Nd メッセージキューにメッセージを送信
.Sh 書式
.Fd #include <sys/types.h>
.Fd #include <sys/ipc.h>
.Fd #include <sys/msg.h>
.Ft int
.Fn msgsnd "int msqid" "void *msgp" "size_t msgsz" "int msgflg"
.Sh 解説
.Fn msgsnd
関数は、
.Fa msqid
で指定されているメッセージキューからメッセージ
を送信します。
.Fa msgp
は、メッセージを含む構造体を指します。この構造体は、
以下のメンバから構成されている必要があります。
.Bd -literal
long mtype; /* メッセージタイプ */
char mtext[1]; /* メッセージ本体 */
.Ed
.Pp
.Va mtype
は 0 より大きい整数で、メッセージの選択に使用されます (
.Xr msgrcv 3
参照)。
.Va mtext
はバイトの配列で、システム制限
.Pf ( Dv MSGMAX )
までのサイズです。
.Pp
メッセージキューにすでに存在するバイト数と
.Fa msgsz
の合計が、メッセージキューの最大バイト数
.Pf ( Va msg_qbytes
.Xr msgctl 3
参照) より大きい場合、またはシステム全体のすべてのキューに存在する
メッセージ数がシステム制限にすでに等しくなっている場合は、
.Fa msgflg
.Fn msgsnd
の動作を決めます。
.Fa msgflg
.Dv IPC_NOWAIT
マスクが設定されている場合、呼び出しはすぐに戻されます。
.Fa msgflg
.Dv IPC_NOWAIT
が設定されていない場合、呼出しは以下の状態になるまでブロックされます。
.Bl -bullet
.It
呼出しがブロックされる条件がなくなるまで。この条件がなくなると、
メッセージが送信されます。
.It
メッセージキューが削除されるまで。この場合は -1 が戻され、
.Va errno
.Er EINVAL
に設定されます。
.It
呼び出し側がシグナルを受信するまで。呼び出しは、
.Va errno
.Er EINTR
に設定された状態で戻ります。
.El
.Pp
呼び出しで問題が発生しなかった場合、メッセージキューに関連する
データ構造は以下のように更新されます。
.Bl -bullet
.It
.Va msg_cbytes
が、メッセージのサイズだけ大きくなります。
.It
.Va msg_qnum
に 1 が加えられます。
.It
.Va msg_lspid
が呼び出しプロセスのプロセス ID に設定されます。
.It
.Va msg_stime
が現在の時刻に設定されます。
.El
.Sh 戻り値
問題なく終了すると 0 が戻されます。問題が発生すると -1 が戻され、
.Va errno
がそのエラーを示すように設定されます。
.Sh エラー
.Fn msgsnd
は、以下のような場合にエラーとなります。
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa msqid
が正しいメッセージキュー ID でない場合。
.Pp
リソースが使用できるようになり、メッセージを送信できる
状態になることを
.Fn msgsnd
が待っている間に、メッセージキューが削除された場合。
.Pp
.Fa msgsz
が 0 より小さいか、
.Va msg_qbytes
より大きい場合。
.It Bq Er EACCES
呼出しプロセスにメッセージキューの書込み権がない場合。
.It Bq Er EAGAIN
キューかシステム全体にメッセージ用のスペースがなく、
.Fa msgflg
.Dv IPC_NOWAIT
が設定されている場合。
.It Bq Er EFAULT
.Fa msgp
が正しいアドレスを指していない場合。
.It Bq Er EINTR
システムコールが、シグナルの配送によって割り込まれた場合。
.Sh バグ
.Tn NetBSD
.Tn FreeBSD
は、メッセージキューが削除された場合に使用すべきエラー値
.Er EIDRM
を定義していません。
.Sh 歴史
メッセージキューは、
AT&T Unix System V
の最初のリリースに
追加されました。
.\"kuma 1999-11-12