share/man/man3head/msg.h.3head

   1 '\" te
   2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH MSG.H 3HEAD "Sep 10, 2004"
  11 .SH NAME
  12 msg.h, msg \- message queue structures
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <\fBsys/msg.h\fR>
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The <\fBsys/msg.h\fR> header defines the following data types through
  23 \fBtypedef\fR:
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fBmsgqnum_t\fR\fR
  28 .ad
  29 .RS 13n
  30 used for the number of messages in the message queue
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fBmsglen_t\fR\fR
  37 .ad
  38 .RS 13n
  39 used for the number of bytes allowed in the message queue
  40 .RE
  41
  42 .sp
  43 .LP
  44 These types are unsigned integer types that are able to store values at least
  45 as large as a type unsigned short.
  46 .sp
  47 .LP
  48 The <\fBsys/msg.h\fR> header defines the following constant as a message
  49 operation flag:
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBMSG_NOERROR\fR\fR
  54 .ad
  55 .RS 15n
  56 no error if big message
  57 .RE
  58
  59 .sp
  60 .LP
  61 The \fBmsqid_ds\fR structure contains the following members:
  62 .sp
  63 .in +2
  64 .nf
  65 struct ipc_perm    msg_perm      Operation permission structure.
  66 msgqnum_t          msg_qnum      Number of messages currently on
  67                                  queue.
  68 msglen_t           msg_qbytes    Maximum number of bytes allowed
  69                                  on queue.
  70 pid_t              msg_lspid     Process ID of last msgsnd(2).
  71 pid_t              msg_lrpid     Process ID of last msgrcv(2).
  72 time_t             msg_stime     Time of last \fBmsgsnd()\fR.
  73 time_t             msg_rtime     Time of last \fBmsgrcv()\fR.
  74 time_t             msg_ctime     Time of last change.
  75 .fi
  76 .in -2
  77
  78 .sp
  79 .LP
  80 The \fBpid_t\fR, \fBtime_t\fR, \fBkey_t\fR, \fBsize_t\fR, and \fBssize_t\fR
  81 types are defined as described in <\fBsys/types.h\fR>. See \fBtypes\fR(3HEAD).
  82 .SH ATTRIBUTES
  83 .sp
  84 .LP
  85 See \fBattributes\fR(5) for descriptions of the following attributes:
  86 .sp
  87
  88 .sp
  89 .TS
  90 box;
  91 c | c
  92 l | l .
  93 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  94 _
  95 Interface Stability     Standard
  96 .TE
  97
  98 .SH SEE ALSO
  99 .sp
 100 .LP
 101 \fBmsgctl\fR(2), \fBmsgget\fR(2), \fBmsgrcv\fR(2), \fBmsgsnd\fR(2),
 102 \fBipc.h\fR(3HEAD), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5),
 103 \fBstandards\fR(5)