Print this page
5258 Incorrect range specified in mq_send(3c) manual
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man3c/mq_send.3c
+++ new/usr/src/man/man3c/mq_send.3c
1 1 '\" te
2 +.\" Copyright (c) 2014, Ryan Zezeski.
2 3 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
3 4 .\" Copyright 1989 AT&T
4 5 .\" Portions Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
5 6 .\" 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
6 7 .\" http://www.opengroup.org/bookstore/.
7 8 .\" 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.
8 9 .\" This notice shall appear on any product containing this material.
9 10 .\" 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.
10 11 .\" 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.
11 12 .\" 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]
12 -.TH MQ_SEND 3C "Feb 5, 2008"
13 +.TH MQ_SEND 3C "Oct 23, 2014"
13 14 .SH NAME
14 15 mq_send, mq_timedsend, mq_reltimedsend_np \- send a message to a message queue
15 16 .SH SYNOPSIS
16 17 .LP
17 18 .nf
18 19 #include <mqueue.h>
19 20
20 21 \fBint\fR \fBmq_send\fR(\fBmqd_t\fR \fImqdes\fR, \fBconst char *\fR\fImsg_ptr\fR, \fBsize_t\fR \fImsg_len\fR,
21 22 \fBunsigned\fR \fImsg_prio\fR);
22 23 .fi
23 24
24 25 .LP
25 26 .nf
26 27 #include <mqueue.h>
27 28 #include <time.h>
28 29
29 30 \fBint\fR \fBmq_timedsend\fR(\fBmqd_t\fR \fImqdes\fR, \fBconst char *\fR\fImsg_ptr\fR,
30 31 \fBsize_t\fR \fImsg_len\fR, \fBunsigned\fR \fImsg_prio\fR,
31 32 \fBconst struct timespec *restrict\fR \fIabs_timeout\fR);
32 33 .fi
33 34
34 35 .LP
35 36 .nf
36 37 \fBint\fR \fBmq_reltimedsend_np\fR(\fBmqd_t\fR \fImqdes\fR, \fBconst char *\fR\fImsg_ptr\fR,
37 38 \fBsize_t\fR \fImsg_len\fR, \fBunsigned\fR \fImsg_prio\fR,
38 39 \fBconst struct timespec *restrict\fR \fIrel_timeout\fR);
39 40 .fi
40 41
↓ open down ↓ |
18 lines elided |
↑ open up ↑ |
41 42 .SH DESCRIPTION
42 43 .sp
43 44 .LP
44 45 The \fBmq_send()\fR function adds the message pointed to by the argument
45 46 \fImsg_ptr\fR to the message queue specified by \fImqdes\fR. The \fImsg_len\fR
46 47 argument specifies the length of the message in bytes pointed to by
47 48 \fImsg_ptr\fR. The value of \fImsg_len\fR is less than or equal to the
48 49 \fImq_msgsize\fR attribute of the message queue, or \fBmq_send()\fR fails.
49 50 .sp
50 51 .LP
51 -If the specified message queue is not full, \fBmq_send()\fR behaves as if the
52 -message is inserted into the message queue at the position indicated by the
53 -\fImsg_prio\fR argument. A message with a larger numeric value of
54 -\fImsg_prio\fR is inserted before messages with lower values of \fImsg_prio\fR.
55 -A message will be inserted after other messages in the queue, if any, with
56 -equal \fImsg_prio\fR. The value of \fImsg_prio\fR must be greater than zero and
57 -less than or equal to \fBMQ_PRIO_MAX\fR.
52 +If the specified message queue is not full, \fBmq_send()\fR behaves as
53 +if the message is inserted into the message queue at the position
54 +indicated by the \fImsg_prio\fR argument. A message with a larger
55 +numeric value of \fImsg_prio\fR is inserted before messages with lower
56 +values of \fImsg_prio\fR. A message will be inserted after other
57 +messages in the queue, if any, with equal \fImsg_prio\fR. The value of
58 +\fImsg_prio\fR must range from zero to \fBMQ_PRIO_MAX - 1\fR.
58 59 .sp
59 60 .LP
60 61 If the specified message queue is full and \fBO_NONBLOCK\fR is not set in the
61 62 message queue description associated with \fImqdes\fR (see \fBmq_open\fR(3C)
62 63 and \fBmq_setattr\fR(3C)), \fBmq_send()\fR blocks until space becomes available
63 64 to enqueue the message, or until \fBmq_send()\fR is interrupted by a signal. If
64 65 more than one thread is waiting to send when space becomes available in the
65 66 message queue, then the thread of the highest priority which has been waiting
66 67 the longest is unblocked to send its message. Otherwise, it is unspecified
67 68 which waiting thread is unblocked. If the specified message queue is full and
68 69 \fBO_NONBLOCK\fR is set in the message queue description associated with
69 70 \fImqdes\fR, the message is not queued and \fBmq_send()\fR returns an error.
70 71 .sp
71 72 .LP
72 73 The \fBmq_timedsend()\fR function adds a message to the message queue specified
73 74 by \fImqdes\fR in the manner defined for the \fBmq_send()\fR function. However,
74 75 if the specified message queue is full and \fBO_NONBLOCK\fR is not set in the
75 76 message queue description associated with \fImqdes\fR, the wait for sufficient
76 77 room in the queue is terminated when the specified timeout expires. If
77 78 \fBO_NONBLOCK\fR is set in the message queue description, this function is
78 79 equivalent to \fBmq_send()\fR.
79 80 .sp
80 81 .LP
81 82 The \fBmq_reltimedsend_np()\fR function is identical to the
82 83 \fBmq_timedsend()\fR function, except that the timeout is specified as a
83 84 relative time interval.
84 85 .sp
85 86 .LP
86 87 For \fBmq_timedsend()\fR, the timeout expires when the absolute time specified
87 88 by \fIabs_timeout\fR passes, as measured by the \fBCLOCK_REALTIME\fR clock
88 89 (that is, when the value of that clock equals or exceeds \fIabs_timeout\fR), or
89 90 if the absolute time specified by \fIabs_timeout\fR has already been passed at
90 91 the time of the call.
91 92 .sp
92 93 .LP
93 94 For \fBmq_reltimedsend_np()\fR, the timeout expires when the time interval
94 95 specified by \fIrel_timeout\fR passes, as measured by the \fBCLOCK_REALTIME\fR
95 96 clock, or if the time interval specified by \fIrel_timeout\fR is negative at
96 97 the time of the call.
97 98 .sp
98 99 .LP
99 100 The resolution of the timeout is the resolution of the \fBCLOCK_REALTIME\fR
100 101 clock. The \fBtimespec\fR argument is defined in the <\fBtime.h\fR> header.
101 102 .sp
102 103 .LP
103 104 Under no circumstance does the operation fail with a timeout if there is
104 105 sufficient room in the queue to add the message immediately. The validity of
105 106 the timeout parameter need not be checked when there is sufficient room in the
106 107 queue.
107 108 .SH RETURN VALUES
108 109 .sp
109 110 .LP
110 111 Upon successful completion, \fBmq_send()\fR, \fBmq_timedsend()\fR, and
111 112 \fBmq_reltimedsend_np()\fR return \fB0\fR. Otherwise, no message is enqueued,
112 113 the functions return \fB\(mi1\fR, and \fBerrno\fR is set to indicate the error.
113 114 .SH ERRORS
114 115 .sp
115 116 .LP
116 117 The \fBmq_send()\fR, \fBmq_timedsend()\fR, and \fBmq_reltimedsend_np()\fR
117 118 functions will fail if:
118 119 .sp
119 120 .ne 2
120 121 .na
121 122 \fB\fBEAGAIN\fR \fR
122 123 .ad
123 124 .RS 13n
124 125 The \fBO_NONBLOCK\fR flag is set in the message queue description associated
125 126 with \fImqdes\fR, and the specified message queue is full.
126 127 .RE
127 128
128 129 .sp
129 130 .ne 2
130 131 .na
131 132 \fB\fBEBADF\fR \fR
132 133 .ad
133 134 .RS 13n
134 135 The \fImqdes\fR argument is not a valid message queue descriptor open for
135 136 writing.
136 137 .RE
137 138
138 139 .sp
139 140 .ne 2
140 141 .na
141 142 \fB\fBEINTR\fR \fR
142 143 .ad
143 144 .RS 13n
144 145 A signal interrupted the function call.
145 146 .RE
146 147
147 148 .sp
148 149 .ne 2
149 150 .na
150 151 \fB\fBEINVAL\fR\fR
151 152 .ad
152 153 .RS 13n
153 154 The value of \fImsg_prio\fR was outside the valid range.
154 155 .RE
155 156
156 157 .sp
157 158 .ne 2
158 159 .na
159 160 \fB\fBEINVAL\fR\fR
160 161 .ad
161 162 .RS 13n
162 163 The process or thread would have blocked, and the timeout parameter specified a
163 164 nanoseconds field value less than zero or greater than or equal to 1,000
164 165 million.
165 166 .RE
166 167
167 168 .sp
168 169 .ne 2
169 170 .na
170 171 \fB\fBEMSGSIZE\fR \fR
171 172 .ad
172 173 .RS 13n
173 174 The specified message length, \fImsg_len\fR, exceeds the message size attribute
174 175 of the message queue.
175 176 .RE
176 177
177 178 .sp
178 179 .ne 2
179 180 .na
180 181 \fB\fBETIMEDOUT\fR\fR
181 182 .ad
182 183 .RS 13n
183 184 The \fBO_NONBLOCK\fR flag was not set when the message queue was opened, but
184 185 the timeout expired before the message could be added to the queue.
185 186 .RE
186 187
187 188 .SH ATTRIBUTES
188 189 .sp
189 190 .LP
190 191 See \fBattributes\fR(5) for descriptions of the following attributes:
191 192 .sp
192 193
193 194 .sp
194 195 .TS
195 196 box;
196 197 l | l
197 198 l | l .
198 199 ATTRIBUTE TYPE ATTRIBUTE VALUE
199 200 _
200 201 Interface Stability Committed
201 202 _
202 203 MT-Level MT-Safe
203 204 _
204 205 Standard See below.
205 206 .TE
206 207
207 208 .sp
208 209 .LP
209 210 For \fBmq_send()\fR and \fBmq_timedsend()\fR, see \fBstandards\fR(5).
210 211 .SH SEE ALSO
211 212 .sp
212 213 .LP
213 214 \fBsysconf\fR(3C), \fBmqueue.h\fR(3HEAD), \fBmq_open\fR(3C),
214 215 \fBmq_receive\fR(3C), \fBmq_setattr\fR(3C), \fBattributes\fR(5),
215 216 \fBstandards\fR(5)
↓ open down ↓ |
148 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX