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

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