share/man/man3head/mqueue.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) 2002, Sun Microsystems, Inc.  All Rights Reserved.
  44 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
  45 .\"
  46 .TH MQUEUE.H 3HEAD "Aug 30, 2002"
  47 .SH NAME
  48 mqueue.h, mqueue \- message queues
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 \fB#include <mqueue.h>\fR
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The <\fBmqueue.h\fR> header defines the \fBmqd_t\fR type, which is used for
  59 message queue descriptors.  This will not be an array type.  A message queue
  60 descriptor may be implemented using a file descriptor, in which case
  61 applications can open up to at least \fBOPEN_MAX\fR file and message queues.
  62 .sp
  63 .LP
  64 The <\fBmqueue.h\fR> header defines the \fBsigevent\fR structure (as described
  65 in <\fBsignal.h\fR>, see \fBsignal.h\fR(3HEAD)) and the  \fBmq_attr\fR
  66 structure, which is used in getting and setting the attributes of a message
  67 queue.  Attributes are initially set when the message queue is created.  A
  68 \fBmq_attr\fR structure has the following members:
  69 .sp
  70 .in +2
  71 .nf
  72 \fBlong    mq_flags       message queue flags
  73 long    mq_maxmsg      maximum number of messages
  74 long    mq_msgsize     maximum message size
  75 long    mq_curmsgs     number of messages currently queued\fR
  76 .fi
  77 .in -2
  78 .sp
  79
  80 .sp
  81 .LP
  82 Inclusion of the <\fBmqueue.h\fR> header may make visible symbols defined in
  83 the headers <\fBfcntl.h\fR>, <\fBsignal.h\fR>, <\fBsys/types.h\fR>, and
  84 <\fBtime.h\fR>.
  85 .SH ATTRIBUTES
  86 .sp
  87 .LP
  88 See \fBattributes\fR(5) for descriptions of the following attributes:
  89 .sp
  90
  91 .sp
  92 .TS
  93 box;
  94 c | c
  95 l | l .
  96 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  97 _
  98 Interface Stability     Standard
  99 .TE
 100
 101 .SH SEE ALSO
 102 .sp
 103 .LP
 104 \fBfcntl.h\fR(3HEAD), \fBsignal.h\fR(3HEAD), \fBtime.h\fR(3HEAD),
 105 \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)