1 .\" Copyright (c) 2005 David Xu <davidxu@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice(s), this list of conditions and the following disclaimer as
9 .\" the first lines of this file unmodified other than the possible
10 .\" addition of one or more copyright notices.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice(s), this list of conditions and the following disclaimer in
13 .\" the documentation and/or other materials provided with the
16 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
17 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
20 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
26 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 .\" Portions of this text are reprinted and reproduced in electronic form
29 .\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
30 .\" Portable Operating System Interface (POSIX), The Open Group Base
31 .\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
32 .\" Electrical and Electronics Engineers, Inc and The Open Group. In the
33 .\" event of any discrepancy between this version and the original IEEE and
34 .\" The Open Group Standard, the original IEEE and The Open Group Standard is
35 .\" the referee document. The original Standard can be obtained online at
36 .\" http://www.opengroup.org/unix/online.html.
45 .Nd "get message queue attributes (REALTIME)"
51 .Fn mq_getattr "mqd_t mqdes" "struct mq_attr *mqstat"
55 system call obtains status information and attributes of the message queue and
56 the open message queue description associated with the message queue
61 argument specifies a message queue descriptor.
63 The results are returned in the
65 structure referenced by the
69 Upon return, the following members will have the values associated with the
70 open message queue description as set when the message queue was opened and
71 as modified by subsequent
76 The following attributes of the message queue will be returned as set at
77 message queue creation:
78 .Va mq_maxmsg , mq_msgsize .
80 Upon return, the following members within the
82 structure referenced by the
84 argument will be set to the current state
86 .Bl -tag -width ".Va mq_flags"
88 The number of messages currently on the queue.
101 argument is not a valid message queue descriptor.
111 system call conforms to
116 message queues first appeared in
119 Portions of this text are reprinted and reproduced in electronic form
120 from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
121 Portable Operating System Interface (POSIX), The Open Group Base
122 Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
123 Electrical and Electronics Engineers, Inc and The Open Group. In the
124 event of any discrepancy between this version and the original IEEE and
125 The Open Group Standard, the original IEEE and The Open Group Standard is
126 the referee document. The original Standard can be obtained online at
127 http://www.opengroup.org/unix/online.html.