OSDN Git Service

b07777f4d16891d19bae7b19743fe5ad91d245de
[linuxjm/LDP_man-pages.git] / po4a / mqueue / po / mqueue.pot
1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
5 #
6 #, fuzzy
7 msgid ""
8 msgstr ""
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "POT-Creation-Date: 2013-03-22 01:06+0900\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
14 "Language: \n"
15 "MIME-Version: 1.0\n"
16 "Content-Type: text/plain; charset=CHARSET\n"
17 "Content-Transfer-Encoding: 8bit\n"
18
19 #. type: TH
20 #: build/C/man3/mq_close.3:26
21 #, no-wrap
22 msgid "MQ_CLOSE"
23 msgstr ""
24
25 #. type: TH
26 #: build/C/man3/mq_close.3:26 build/C/man3/mq_getattr.3:26 build/C/man3/mq_unlink.3:26
27 #, no-wrap
28 msgid "2010-08-29"
29 msgstr ""
30
31 #. type: TH
32 #: build/C/man3/mq_close.3:26 build/C/man3/mq_getattr.3:26 build/C/man2/mq_getsetattr.2:26 build/C/man3/mq_notify.3:26 build/C/man3/mq_open.3:26 build/C/man7/mq_overview.7:26 build/C/man3/mq_receive.3:26 build/C/man3/mq_send.3:26 build/C/man3/mq_unlink.3:26 build/C/man2/msgctl.2:37 build/C/man2/msgget.2:35 build/C/man2/msgop.2:40
33 #, no-wrap
34 msgid "Linux"
35 msgstr ""
36
37 #. type: TH
38 #: build/C/man3/mq_close.3:26 build/C/man3/mq_getattr.3:26 build/C/man2/mq_getsetattr.2:26 build/C/man3/mq_notify.3:26 build/C/man3/mq_open.3:26 build/C/man7/mq_overview.7:26 build/C/man3/mq_receive.3:26 build/C/man3/mq_send.3:26 build/C/man3/mq_unlink.3:26 build/C/man2/msgctl.2:37 build/C/man2/msgget.2:35 build/C/man2/msgop.2:40
39 #, no-wrap
40 msgid "Linux Programmer's Manual"
41 msgstr ""
42
43 #. type: SH
44 #: build/C/man3/mq_close.3:27 build/C/man3/mq_getattr.3:27 build/C/man2/mq_getsetattr.2:27 build/C/man3/mq_notify.3:27 build/C/man3/mq_open.3:27 build/C/man7/mq_overview.7:27 build/C/man3/mq_receive.3:27 build/C/man3/mq_send.3:27 build/C/man3/mq_unlink.3:27 build/C/man2/msgctl.2:38 build/C/man2/msgget.2:36 build/C/man2/msgop.2:41
45 #, no-wrap
46 msgid "NAME"
47 msgstr ""
48
49 #. type: Plain text
50 #: build/C/man3/mq_close.3:29
51 msgid "mq_close - close a message queue descriptor"
52 msgstr ""
53
54 #. type: SH
55 #: build/C/man3/mq_close.3:29 build/C/man3/mq_getattr.3:29 build/C/man2/mq_getsetattr.2:29 build/C/man3/mq_notify.3:29 build/C/man3/mq_open.3:29 build/C/man3/mq_receive.3:29 build/C/man3/mq_send.3:29 build/C/man3/mq_unlink.3:29 build/C/man2/msgctl.2:40 build/C/man2/msgget.2:38 build/C/man2/msgop.2:43
56 #, no-wrap
57 msgid "SYNOPSIS"
58 msgstr ""
59
60 #. type: Plain text
61 #: build/C/man3/mq_close.3:32 build/C/man3/mq_getattr.3:32 build/C/man3/mq_notify.3:32 build/C/man3/mq_receive.3:32 build/C/man3/mq_send.3:32 build/C/man3/mq_unlink.3:32
62 #, no-wrap
63 msgid "B<#include E<lt>mqueue.hE<gt>>\n"
64 msgstr ""
65
66 #. type: Plain text
67 #: build/C/man3/mq_close.3:34
68 #, no-wrap
69 msgid "B<int mq_close(mqd_t >I<mqdes>B<);>\n"
70 msgstr ""
71
72 #. type: Plain text
73 #: build/C/man3/mq_close.3:37 build/C/man3/mq_getattr.3:40 build/C/man3/mq_notify.3:37 build/C/man3/mq_open.3:41 build/C/man3/mq_receive.3:45 build/C/man3/mq_send.3:45 build/C/man3/mq_unlink.3:37
74 msgid "Link with I<-lrt>."
75 msgstr ""
76
77 #. type: SH
78 #: build/C/man3/mq_close.3:37 build/C/man3/mq_getattr.3:40 build/C/man2/mq_getsetattr.2:40 build/C/man3/mq_notify.3:37 build/C/man3/mq_open.3:41 build/C/man7/mq_overview.7:29 build/C/man3/mq_receive.3:57 build/C/man3/mq_send.3:57 build/C/man3/mq_unlink.3:37 build/C/man2/msgctl.2:48 build/C/man2/msgget.2:46 build/C/man2/msgop.2:56
79 #, no-wrap
80 msgid "DESCRIPTION"
81 msgstr ""
82
83 #. type: Plain text
84 #: build/C/man3/mq_close.3:41
85 msgid "B<mq_close>()  closes the message queue descriptor I<mqdes>."
86 msgstr ""
87
88 #. type: Plain text
89 #: build/C/man3/mq_close.3:47
90 msgid ""
91 "If the calling process has attached a notification request to this message "
92 "queue via I<mqdes>, then this request is removed, and another process can "
93 "now attach a notification request."
94 msgstr ""
95
96 #. type: SH
97 #: build/C/man3/mq_close.3:47 build/C/man3/mq_getattr.3:118 build/C/man3/mq_notify.3:134 build/C/man3/mq_open.3:123 build/C/man3/mq_receive.3:113 build/C/man3/mq_send.3:119 build/C/man3/mq_unlink.3:44 build/C/man2/msgctl.2:226 build/C/man2/msgget.2:137 build/C/man2/msgop.2:287
98 #, no-wrap
99 msgid "RETURN VALUE"
100 msgstr ""
101
102 #. type: Plain text
103 #: build/C/man3/mq_close.3:53
104 msgid ""
105 "On success B<mq_close>()  returns 0; on error, -1 is returned, with I<errno> "
106 "set to indicate the error."
107 msgstr ""
108
109 #. type: SH
110 #: build/C/man3/mq_close.3:53 build/C/man3/mq_getattr.3:126 build/C/man3/mq_notify.3:140 build/C/man3/mq_open.3:135 build/C/man3/mq_receive.3:122 build/C/man3/mq_send.3:127 build/C/man3/mq_unlink.3:50 build/C/man2/msgctl.2:251 build/C/man2/msgget.2:143 build/C/man2/msgop.2:300
111 #, no-wrap
112 msgid "ERRORS"
113 msgstr ""
114
115 #. type: TP
116 #: build/C/man3/mq_close.3:54 build/C/man3/mq_getattr.3:127 build/C/man3/mq_notify.3:141 build/C/man3/mq_receive.3:129 build/C/man3/mq_send.3:134
117 #, no-wrap
118 msgid "B<EBADF>"
119 msgstr ""
120
121 #. type: Plain text
122 #: build/C/man3/mq_close.3:59 build/C/man3/mq_getattr.3:132 build/C/man3/mq_notify.3:146
123 msgid "The descriptor specified in I<mqdes> is invalid."
124 msgstr ""
125
126 #. type: SH
127 #: build/C/man3/mq_close.3:59 build/C/man3/mq_getattr.3:137 build/C/man2/mq_getsetattr.2:50 build/C/man3/mq_notify.3:174 build/C/man3/mq_open.3:224 build/C/man7/mq_overview.7:263 build/C/man3/mq_receive.3:156 build/C/man3/mq_send.3:161 build/C/man3/mq_unlink.3:62 build/C/man2/msgctl.2:311 build/C/man2/msgget.2:183 build/C/man2/msgop.2:399
128 #, no-wrap
129 msgid "CONFORMING TO"
130 msgstr ""
131
132 #. type: Plain text
133 #: build/C/man3/mq_close.3:61 build/C/man3/mq_getattr.3:139 build/C/man3/mq_notify.3:176 build/C/man3/mq_open.3:226 build/C/man7/mq_overview.7:265 build/C/man3/mq_receive.3:158 build/C/man3/mq_send.3:163 build/C/man3/mq_unlink.3:64
134 msgid "POSIX.1-2001."
135 msgstr ""
136
137 #. type: SH
138 #: build/C/man3/mq_close.3:61 build/C/man3/mq_getattr.3:139 build/C/man2/mq_getsetattr.2:52 build/C/man7/mq_overview.7:265 build/C/man3/mq_receive.3:158 build/C/man3/mq_send.3:163 build/C/man2/msgctl.2:314 build/C/man2/msgget.2:185 build/C/man2/msgop.2:401
139 #, no-wrap
140 msgid "NOTES"
141 msgstr ""
142
143 #. type: Plain text
144 #: build/C/man3/mq_close.3:65
145 msgid ""
146 "All open message queues are automatically closed on process termination, or "
147 "upon B<execve>(2)."
148 msgstr ""
149
150 #. type: SH
151 #: build/C/man3/mq_close.3:65 build/C/man3/mq_getattr.3:147 build/C/man2/mq_getsetattr.2:56 build/C/man3/mq_notify.3:243 build/C/man3/mq_open.3:230 build/C/man7/mq_overview.7:281 build/C/man3/mq_receive.3:164 build/C/man3/mq_send.3:169 build/C/man3/mq_unlink.3:64 build/C/man2/msgctl.2:352 build/C/man2/msgget.2:230 build/C/man2/msgop.2:446
152 #, no-wrap
153 msgid "SEE ALSO"
154 msgstr ""
155
156 #. type: Plain text
157 #: build/C/man3/mq_close.3:73
158 msgid ""
159 "B<mq_getattr>(3), B<mq_notify>(3), B<mq_open>(3), B<mq_receive>(3), "
160 "B<mq_send>(3), B<mq_unlink>(3), B<mq_overview>(7)"
161 msgstr ""
162
163 #. type: SH
164 #: build/C/man3/mq_close.3:73 build/C/man3/mq_getattr.3:155 build/C/man2/mq_getsetattr.2:59 build/C/man3/mq_notify.3:252 build/C/man3/mq_open.3:238 build/C/man7/mq_overview.7:294 build/C/man3/mq_receive.3:173 build/C/man3/mq_send.3:178 build/C/man3/mq_unlink.3:72 build/C/man2/msgctl.2:359 build/C/man2/msgget.2:238 build/C/man2/msgop.2:452
165 #, no-wrap
166 msgid "COLOPHON"
167 msgstr ""
168
169 #. type: Plain text
170 #: build/C/man3/mq_close.3:80 build/C/man3/mq_getattr.3:162 build/C/man2/mq_getsetattr.2:66 build/C/man3/mq_notify.3:259 build/C/man3/mq_open.3:245 build/C/man7/mq_overview.7:301 build/C/man3/mq_receive.3:180 build/C/man3/mq_send.3:185 build/C/man3/mq_unlink.3:79 build/C/man2/msgctl.2:366 build/C/man2/msgget.2:245 build/C/man2/msgop.2:459
171 msgid ""
172 "This page is part of release 3.50 of the Linux I<man-pages> project.  A "
173 "description of the project, and information about reporting bugs, can be "
174 "found at http://www.kernel.org/doc/man-pages/."
175 msgstr ""
176
177 #. type: TH
178 #: build/C/man3/mq_getattr.3:26
179 #, no-wrap
180 msgid "MQ_GETATTR"
181 msgstr ""
182
183 #. type: Plain text
184 #: build/C/man3/mq_getattr.3:29
185 msgid "mq_getattr, mq_setattr - get/set message queue attributes"
186 msgstr ""
187
188 #. type: Plain text
189 #: build/C/man3/mq_getattr.3:34
190 #, no-wrap
191 msgid "B<int mq_getattr(mqd_t >I<mqdes>B<, struct mq_attr *>I<attr>B<);>\n"
192 msgstr ""
193
194 #. type: Plain text
195 #: build/C/man3/mq_getattr.3:37
196 #, no-wrap
197 msgid ""
198 "B<int mq_setattr(mqd_t >I<mqdes>B<, struct mq_attr *>I<newattr>B<,>\n"
199 "B<                 struct mq_attr *>I<oldattr>B<);>\n"
200 msgstr ""
201
202 #. type: Plain text
203 #: build/C/man3/mq_getattr.3:47
204 msgid ""
205 "B<mq_getattr>()  and B<mq_setattr>()  respectively retrieve and modify "
206 "attributes of the message queue referred to by the descriptor I<mqdes>."
207 msgstr ""
208
209 #. type: Plain text
210 #: build/C/man3/mq_getattr.3:54
211 msgid ""
212 "B<mq_getattr>()  returns an I<mq_attr> structure in the buffer pointed by "
213 "I<attr>.  This structure is defined as:"
214 msgstr ""
215
216 #. type: Plain text
217 #: build/C/man3/mq_getattr.3:63
218 #, no-wrap
219 msgid ""
220 "struct mq_attr {\n"
221 "    long mq_flags;       /* Flags: 0 or O_NONBLOCK */\n"
222 "    long mq_maxmsg;      /* Max. # of messages on queue */\n"
223 "    long mq_msgsize;     /* Max. message size (bytes) */\n"
224 "    long mq_curmsgs;     /* # of messages currently in queue */\n"
225 "};\n"
226 msgstr ""
227
228 #. type: Plain text
229 #: build/C/man3/mq_getattr.3:73
230 msgid ""
231 "The I<mq_flags> field contains flags associated with the open message queue "
232 "description.  This field is initialized when the queue is created by "
233 "B<mq_open>(3).  The only flag that can appear in this field is "
234 "B<O_NONBLOCK>."
235 msgstr ""
236
237 #. type: Plain text
238 #: build/C/man3/mq_getattr.3:94
239 msgid ""
240 "The I<mq_maxmsg> and I<mq_msgsize> fields are set when the message queue is "
241 "created by B<mq_open>(3).  The I<mq_maxmsg> field is an upper limit on the "
242 "number of messages that may be placed on the queue using B<mq_send>(3).  The "
243 "I<mq_msgsize> field is an upper limit on the size of messages that may be "
244 "placed on the queue.  Both of these fields must have a value greater than "
245 "zero.  Two I</proc> files that place ceilings on the values for these fields "
246 "are described in B<mq_open>(3)."
247 msgstr ""
248
249 #. type: Plain text
250 #: build/C/man3/mq_getattr.3:98
251 msgid ""
252 "The I<mq_curmsgs> field returns the number of messages currently held in the "
253 "queue."
254 msgstr ""
255
256 #. type: Plain text
257 #: build/C/man3/mq_getattr.3:118
258 msgid ""
259 "B<mq_setattr>()  sets message queue attributes using information supplied in "
260 "the I<mq_attr> structure pointed to by I<newattr>.  The only attribute that "
261 "can be modified is the setting of the B<O_NONBLOCK> flag in I<mq_flags>.  "
262 "The other fields in I<newattr> are ignored.  If the I<oldattr> field is not "
263 "NULL, then the buffer that it points to is used to return an I<mq_attr> "
264 "structure that contains the same information that is returned by "
265 "B<mq_getattr>()."
266 msgstr ""
267
268 #. type: Plain text
269 #: build/C/man3/mq_getattr.3:126
270 msgid ""
271 "On success B<mq_getattr>()  and B<mq_setattr>()  return 0; on error, -1 is "
272 "returned, with I<errno> set to indicate the error."
273 msgstr ""
274
275 #. type: TP
276 #: build/C/man3/mq_getattr.3:132 build/C/man3/mq_notify.3:150 build/C/man3/mq_open.3:156 build/C/man3/mq_receive.3:138 build/C/man3/mq_send.3:143 build/C/man2/msgctl.2:282 build/C/man2/msgop.2:331 build/C/man2/msgop.2:387
277 #, no-wrap
278 msgid "B<EINVAL>"
279 msgstr ""
280
281 #. type: Plain text
282 #: build/C/man3/mq_getattr.3:137
283 msgid "I<newattr-E<gt>mq_flags> contained set bits other than B<O_NONBLOCK>."
284 msgstr ""
285
286 #. type: Plain text
287 #: build/C/man3/mq_getattr.3:147
288 msgid ""
289 "On Linux, B<mq_getattr>()  and B<mq_setattr>()  are library functions "
290 "layered on top of the B<mq_getsetattr>(2)  system call."
291 msgstr ""
292
293 #. type: Plain text
294 #: build/C/man3/mq_getattr.3:155
295 msgid ""
296 "B<mq_close>(3), B<mq_notify>(3), B<mq_open>(3), B<mq_receive>(3), "
297 "B<mq_send>(3), B<mq_unlink>(3), B<mq_overview>(7)"
298 msgstr ""
299
300 #. type: TH
301 #: build/C/man2/mq_getsetattr.2:26
302 #, no-wrap
303 msgid "MQ_GETSETATTR"
304 msgstr ""
305
306 #. type: TH
307 #: build/C/man2/mq_getsetattr.2:26
308 #, no-wrap
309 msgid "2012-07-13"
310 msgstr ""
311
312 #. type: Plain text
313 #: build/C/man2/mq_getsetattr.2:29
314 msgid "mq_getsetattr - get/set message queue attributes"
315 msgstr ""
316
317 #. type: Plain text
318 #: build/C/man2/mq_getsetattr.2:33
319 #, no-wrap
320 msgid ""
321 "B<#include E<lt>sys/types.hE<gt>>\n"
322 "B<#include E<lt>mqueue.hE<gt>>\n"
323 msgstr ""
324
325 #. type: Plain text
326 #: build/C/man2/mq_getsetattr.2:36
327 #, no-wrap
328 msgid ""
329 "B<int mq_getsetattr(mqd_t >I<mqdes>B<, struct mq_attr *>I<newattr>B<,>\n"
330 "B<                 struct mq_attr *>I<oldattr>B<);>\n"
331 msgstr ""
332
333 #. type: Plain text
334 #: build/C/man2/mq_getsetattr.2:40
335 msgid "I<Note>: There is no glibc wrapper for this system call; see NOTES."
336 msgstr ""
337
338 #. type: Plain text
339 #: build/C/man2/mq_getsetattr.2:42
340 msgid "Do not use this system call."
341 msgstr ""
342
343 #. type: Plain text
344 #: build/C/man2/mq_getsetattr.2:50
345 msgid ""
346 "This is the low-level system call used to implement B<mq_getattr>(3)  and "
347 "B<mq_setattr>(3).  For an explanation of how this system call operates, see "
348 "the description of B<mq_setattr>(3)."
349 msgstr ""
350
351 #. type: Plain text
352 #: build/C/man2/mq_getsetattr.2:52
353 msgid "This interface is nonstandard; avoid its use."
354 msgstr ""
355
356 #. type: Plain text
357 #: build/C/man2/mq_getsetattr.2:56
358 msgid ""
359 "Glibc does not provide a wrapper for this system call; call it using "
360 "B<syscall>(2).  (Actually, never call it unless you are writing a C "
361 "library!)"
362 msgstr ""
363
364 #. type: Plain text
365 #: build/C/man2/mq_getsetattr.2:59
366 msgid "B<mq_getattr>(3), B<mq_overview>(7)"
367 msgstr ""
368
369 #. type: TH
370 #: build/C/man3/mq_notify.3:26
371 #, no-wrap
372 msgid "MQ_NOTIFY"
373 msgstr ""
374
375 #. type: TH
376 #: build/C/man3/mq_notify.3:26
377 #, no-wrap
378 msgid "2010-10-04"
379 msgstr ""
380
381 #. type: Plain text
382 #: build/C/man3/mq_notify.3:29
383 msgid "mq_notify - register for notification when a message is available"
384 msgstr ""
385
386 #. type: Plain text
387 #: build/C/man3/mq_notify.3:34
388 #, no-wrap
389 msgid "B<int mq_notify(mqd_t >I<mqdes>B<, const struct sigevent *>I<sevp>B<);>\n"
390 msgstr ""
391
392 #. type: Plain text
393 #: build/C/man3/mq_notify.3:43
394 msgid ""
395 "B<mq_notify>()  allows the calling process to register or unregister for "
396 "delivery of an asynchronous notification when a new message arrives on the "
397 "empty message queue referred to by the descriptor I<mqdes>."
398 msgstr ""
399
400 #. type: Plain text
401 #: build/C/man3/mq_notify.3:51
402 msgid ""
403 "The I<sevp> argument is a pointer to a I<sigevent> structure.  For the "
404 "definition and general details of this structure, see B<sigevent>(7)."
405 msgstr ""
406
407 #. type: Plain text
408 #: build/C/man3/mq_notify.3:65
409 msgid ""
410 "If I<sevp> is a non-NULL pointer, then B<mq_notify>()  registers the calling "
411 "process to receive message notification.  The I<sigev_notify> field of the "
412 "I<sigevent> structure to which I<sevp> points specifies how notification is "
413 "to be performed.  This field has one of the following values:"
414 msgstr ""
415
416 #. type: TP
417 #: build/C/man3/mq_notify.3:65
418 #, no-wrap
419 msgid "B<SIGEV_NONE>"
420 msgstr ""
421
422 #.  When is SIGEV_NONE useful?
423 #. type: Plain text
424 #: build/C/man3/mq_notify.3:70
425 msgid ""
426 "A \"null\" notification: the calling process is registered as the target for "
427 "notification, but when a message arrives, no notification is sent."
428 msgstr ""
429
430 #. type: TP
431 #: build/C/man3/mq_notify.3:70
432 #, no-wrap
433 msgid "B<SIGEV_SIGNAL>"
434 msgstr ""
435
436 #.  I don't know of other implementations that set
437 #.  si_pid and si_uid -- MTK
438 #. type: Plain text
439 #: build/C/man3/mq_notify.3:90
440 msgid ""
441 "Notify the process by sending the signal specified in I<sigev_signo>.  See "
442 "B<sigevent>(7)  for general details.  The I<si_code> field of the "
443 "I<siginfo_t> structure will be set to B<SI_MESGQ>.  In addition, I<si_pid> "
444 "will be set to the PID of the process that sent the message, and I<si_uid> "
445 "will be set to the real user ID of the sending process."
446 msgstr ""
447
448 #. type: TP
449 #: build/C/man3/mq_notify.3:90
450 #, no-wrap
451 msgid "B<SIGEV_THREAD>"
452 msgstr ""
453
454 #. type: Plain text
455 #: build/C/man3/mq_notify.3:98
456 msgid ""
457 "Upon message delivery, invoke I<sigev_notify_function> as if it were the "
458 "start function of a new thread.  See B<sigevent>(7)  for details."
459 msgstr ""
460
461 #. type: Plain text
462 #: build/C/man3/mq_notify.3:101
463 msgid ""
464 "Only one process can be registered to receive notification from a message "
465 "queue."
466 msgstr ""
467
468 #. type: Plain text
469 #: build/C/man3/mq_notify.3:108
470 msgid ""
471 "If I<sevp> is NULL, and the calling process is currently registered to "
472 "receive notifications for this message queue, then the registration is "
473 "removed; another process can then register to receive a message notification "
474 "for this queue."
475 msgstr ""
476
477 #. type: Plain text
478 #: build/C/man3/mq_notify.3:115
479 msgid ""
480 "Message notification only occurs when a new message arrives and the queue "
481 "was previously empty.  If the queue was not empty at the time B<mq_notify>()  "
482 "was called, then a notification will only occur after the queue is emptied "
483 "and a new message arrives."
484 msgstr ""
485
486 #. type: Plain text
487 #: build/C/man3/mq_notify.3:123
488 msgid ""
489 "If another process or thread is waiting to read a message from an empty "
490 "queue using B<mq_receive>(3), then any message notification registration is "
491 "ignored: the message is delivered to the process or thread calling "
492 "B<mq_receive>(3), and the message notification registration remains in "
493 "effect."
494 msgstr ""
495
496 #. type: Plain text
497 #: build/C/man3/mq_notify.3:134
498 msgid ""
499 "Notification occurs once: after a notification is delivered, the "
500 "notification registration is removed, and another process can register for "
501 "message notification.  If the notified process wishes to receive the next "
502 "notification, it can use B<mq_notify>()  to request a further notification.  "
503 "This should be done before emptying all unread messages from the queue.  "
504 "(Placing the queue in nonblocking mode is useful for emptying the queue of "
505 "messages without blocking once it is empty.)"
506 msgstr ""
507
508 #. type: Plain text
509 #: build/C/man3/mq_notify.3:140
510 msgid ""
511 "On success B<mq_notify>()  returns 0; on error, -1 is returned, with "
512 "I<errno> set to indicate the error."
513 msgstr ""
514
515 #. type: TP
516 #: build/C/man3/mq_notify.3:146
517 #, no-wrap
518 msgid "B<EBUSY>"
519 msgstr ""
520
521 #. type: Plain text
522 #: build/C/man3/mq_notify.3:150
523 msgid ""
524 "Another process has already registered to receive notification for this "
525 "message queue."
526 msgstr ""
527
528 #. type: Plain text
529 #: build/C/man3/mq_notify.3:160
530 msgid ""
531 "I<sevp-E<gt>sigev_notify> is not one of the permitted values; or "
532 "I<sevp-E<gt>sigev_notify> is B<SIGEV_SIGNAL> and I<sevp-E<gt>sigev_signo> is "
533 "not a valid signal number."
534 msgstr ""
535
536 #. type: TP
537 #: build/C/man3/mq_notify.3:160 build/C/man3/mq_open.3:214 build/C/man2/msgget.2:173 build/C/man2/msgop.2:342
538 #, no-wrap
539 msgid "B<ENOMEM>"
540 msgstr ""
541
542 #. type: Plain text
543 #: build/C/man3/mq_notify.3:163 build/C/man3/mq_open.3:217
544 msgid "Insufficient memory."
545 msgstr ""
546
547 #.  Linux does not do this
548 #. type: Plain text
549 #: build/C/man3/mq_notify.3:174
550 msgid ""
551 "POSIX.1-2008 says that an implementation I<may> generate an B<EINVAL> error "
552 "if I<sevp> is NULL, and the caller is not currently registered to receive "
553 "notifications for the queue I<mqdes>."
554 msgstr ""
555
556 #. type: SH
557 #: build/C/man3/mq_notify.3:176 build/C/man7/mq_overview.7:278
558 #, no-wrap
559 msgid "EXAMPLE"
560 msgstr ""
561
562 #. type: Plain text
563 #: build/C/man3/mq_notify.3:182
564 msgid ""
565 "The following program registers a notification request for the message queue "
566 "named in its command-line argument.  Notification is performed by creating a "
567 "thread.  The thread executes a function which reads one message from the "
568 "queue and then terminates the process."
569 msgstr ""
570
571 #. type: Plain text
572 #: build/C/man3/mq_notify.3:189
573 #, no-wrap
574 msgid ""
575 "#include E<lt>pthread.hE<gt>\n"
576 "#include E<lt>mqueue.hE<gt>\n"
577 "#include E<lt>stdio.hE<gt>\n"
578 "#include E<lt>stdlib.hE<gt>\n"
579 "#include E<lt>unistd.hE<gt>\n"
580 msgstr ""
581
582 #. type: Plain text
583 #: build/C/man3/mq_notify.3:192
584 #, no-wrap
585 msgid ""
586 "#define handle_error(msg) \\e\n"
587 "    do { perror(msg); exit(EXIT_FAILURE); } while (0)\n"
588 msgstr ""
589
590 #. type: Plain text
591 #: build/C/man3/mq_notify.3:200
592 #, no-wrap
593 msgid ""
594 "static void                     /* Thread start function */\n"
595 "tfunc(union sigval sv)\n"
596 "{\n"
597 "    struct mq_attr attr;\n"
598 "    ssize_t nr;\n"
599 "    void *buf;\n"
600 "    mqd_t mqdes = *((mqd_t *) sv.sival_ptr);\n"
601 msgstr ""
602
603 #. type: Plain text
604 #: build/C/man3/mq_notify.3:202
605 #, no-wrap
606 msgid "    /* Determine max. msg size; allocate buffer to receive msg */\n"
607 msgstr ""
608
609 #. type: Plain text
610 #: build/C/man3/mq_notify.3:208
611 #, no-wrap
612 msgid ""
613 "    if (mq_getattr(mqdes, &attr) == -1)\n"
614 "        handle_error(\"mq_getattr\");\n"
615 "    buf = malloc(attr.mq_msgsize);\n"
616 "    if (buf == NULL)\n"
617 "        handle_error(\"malloc\");\n"
618 msgstr ""
619
620 #. type: Plain text
621 #: build/C/man3/mq_notify.3:212
622 #, no-wrap
623 msgid ""
624 "    nr = mq_receive(mqdes, buf, attr.mq_msgsize, NULL);\n"
625 "    if (nr == -1)\n"
626 "        handle_error(\"mq_receive\");\n"
627 msgstr ""
628
629 #. type: Plain text
630 #: build/C/man3/mq_notify.3:217
631 #, no-wrap
632 msgid ""
633 "    printf(\"Read %ld bytes from MQ\\en\", (long) nr);\n"
634 "    free(buf);\n"
635 "    exit(EXIT_SUCCESS);         /* Terminate the process */\n"
636 "}\n"
637 msgstr ""
638
639 #. type: Plain text
640 #: build/C/man3/mq_notify.3:223
641 #, no-wrap
642 msgid ""
643 "int\n"
644 "main(int argc, char *argv[])\n"
645 "{\n"
646 "    mqd_t mqdes;\n"
647 "    struct sigevent sev;\n"
648 msgstr ""
649
650 #. type: Plain text
651 #: build/C/man3/mq_notify.3:228
652 #, no-wrap
653 msgid ""
654 "    if (argc != 2) {\n"
655 "\tfprintf(stderr, \"Usage: %s E<lt>mq-nameE<gt>\\en\", argv[0]);\n"
656 "\texit(EXIT_FAILURE);\n"
657 "    }\n"
658 msgstr ""
659
660 #. type: Plain text
661 #: build/C/man3/mq_notify.3:232
662 #, no-wrap
663 msgid ""
664 "    mqdes = mq_open(argv[1], O_RDONLY);\n"
665 "    if (mqdes == (mqd_t) -1)\n"
666 "        handle_error(\"mq_open\");\n"
667 msgstr ""
668
669 #. type: Plain text
670 #: build/C/man3/mq_notify.3:239
671 #, no-wrap
672 msgid ""
673 "    sev.sigev_notify = SIGEV_THREAD;\n"
674 "    sev.sigev_notify_function = tfunc;\n"
675 "    sev.sigev_notify_attributes = NULL;\n"
676 "    sev.sigev_value.sival_ptr = &mqdes;   /* Arg. to thread func. */\n"
677 "    if (mq_notify(mqdes, &sev) == -1)\n"
678 "        handle_error(\"mq_notify\");\n"
679 msgstr ""
680
681 #. type: Plain text
682 #: build/C/man3/mq_notify.3:242
683 #, no-wrap
684 msgid ""
685 "    pause();    /* Process will be terminated by thread function */\n"
686 "}\n"
687 msgstr ""
688
689 #. type: Plain text
690 #: build/C/man3/mq_notify.3:252
691 msgid ""
692 "B<mq_close>(3), B<mq_getattr>(3), B<mq_open>(3), B<mq_receive>(3), "
693 "B<mq_send>(3), B<mq_unlink>(3), B<mq_overview>(7), B<sigevent>(7)"
694 msgstr ""
695
696 #. type: TH
697 #: build/C/man3/mq_open.3:26
698 #, no-wrap
699 msgid "MQ_OPEN"
700 msgstr ""
701
702 #. type: TH
703 #: build/C/man3/mq_open.3:26
704 #, no-wrap
705 msgid "2009-02-20"
706 msgstr ""
707
708 #. type: Plain text
709 #: build/C/man3/mq_open.3:29
710 msgid "mq_open - open a message queue"
711 msgstr ""
712
713 #. type: Plain text
714 #: build/C/man3/mq_open.3:34
715 #, no-wrap
716 msgid ""
717 "B<#include E<lt>fcntl.hE<gt>>           /* For O_* constants */\n"
718 "B<#include E<lt>sys/stat.hE<gt>>        /* For mode constants */\n"
719 "B<#include E<lt>mqueue.hE<gt>>\n"
720 msgstr ""
721
722 #. type: Plain text
723 #: build/C/man3/mq_open.3:38
724 #, no-wrap
725 msgid ""
726 "B<mqd_t mq_open(const char *>I<name>B<, int >I<oflag>B<);>\n"
727 "B<mqd_t mq_open(const char *>I<name>B<, int >I<oflag>B<, mode_t "
728 ">I<mode>B<,>\n"
729 "B<              struct mq_attr *>I<attr>B<);>\n"
730 msgstr ""
731
732 #. type: Plain text
733 #: build/C/man3/mq_open.3:50
734 msgid ""
735 "B<mq_open>()  creates a new POSIX message queue or opens an existing queue.  "
736 "The queue is identified by I<name>.  For details of the construction of "
737 "I<name>, see B<mq_overview>(7)."
738 msgstr ""
739
740 #. type: Plain text
741 #: build/C/man3/mq_open.3:58
742 msgid ""
743 "The I<oflag> argument specifies flags that control the operation of the "
744 "call.  (Definitions of the flags values can be obtained by including "
745 "I<E<lt>fcntl.hE<gt>>.)  Exactly one of the following must be specified in "
746 "I<oflag>:"
747 msgstr ""
748
749 #. type: TP
750 #: build/C/man3/mq_open.3:58
751 #, no-wrap
752 msgid "B<O_RDONLY>"
753 msgstr ""
754
755 #. type: Plain text
756 #: build/C/man3/mq_open.3:61
757 msgid "Open the queue to receive messages only."
758 msgstr ""
759
760 #. type: TP
761 #: build/C/man3/mq_open.3:61
762 #, no-wrap
763 msgid "B<O_WRONLY>"
764 msgstr ""
765
766 #. type: Plain text
767 #: build/C/man3/mq_open.3:64
768 msgid "Open the queue to send messages only."
769 msgstr ""
770
771 #. type: TP
772 #: build/C/man3/mq_open.3:64
773 #, no-wrap
774 msgid "B<O_RDWR>"
775 msgstr ""
776
777 #. type: Plain text
778 #: build/C/man3/mq_open.3:67
779 msgid "Open the queue to both send and receive messages."
780 msgstr ""
781
782 #. type: Plain text
783 #: build/C/man3/mq_open.3:72
784 msgid "Zero or more of the following flags can additionally be I<OR>ed in I<oflag>:"
785 msgstr ""
786
787 #. type: TP
788 #: build/C/man3/mq_open.3:72
789 #, no-wrap
790 msgid "B<O_NONBLOCK>"
791 msgstr ""
792
793 #. type: Plain text
794 #: build/C/man3/mq_open.3:81
795 msgid ""
796 "Open the queue in nonblocking mode.  In circumstances where B<mq_receive>(3)  "
797 "and B<mq_send>(3)  would normally block, these functions instead fail with "
798 "the error B<EAGAIN>."
799 msgstr ""
800
801 #. type: TP
802 #: build/C/man3/mq_open.3:81
803 #, no-wrap
804 msgid "B<O_CREAT>"
805 msgstr ""
806
807 #.  In reality the file system IDs are used on Linux.
808 #. type: Plain text
809 #: build/C/man3/mq_open.3:89
810 msgid ""
811 "Create the message queue if it does not exist.  The owner (user ID) of the "
812 "message queue is set to the effective user ID of the calling process.  The "
813 "group ownership (group ID) is set to the effective group ID of the calling "
814 "process."
815 msgstr ""
816
817 #. type: TP
818 #: build/C/man3/mq_open.3:89
819 #, no-wrap
820 msgid "B<O_EXCL>"
821 msgstr ""
822
823 #. type: Plain text
824 #: build/C/man3/mq_open.3:99
825 msgid ""
826 "If B<O_CREAT> was specified in I<oflag>, and a queue with the given I<name> "
827 "already exists, then fail with the error B<EEXIST>."
828 msgstr ""
829
830 #. type: Plain text
831 #: build/C/man3/mq_open.3:123
832 msgid ""
833 "If B<O_CREAT> is specified in I<oflag>, then two additional arguments must "
834 "be supplied.  The I<mode> argument specifies the permissions to be placed on "
835 "the new queue, as for B<open>(2).  (Symbolic definitions for the permissions "
836 "bits can be obtained by including I<E<lt>sys/stat.hE<gt>>.)  The permissions "
837 "settings are masked against the process umask.  The I<attr> argument "
838 "specifies attributes for the queue.  See B<mq_getattr>(3)  for details.  If "
839 "I<attr> is NULL, then the queue is created with implementation-defined "
840 "default attributes."
841 msgstr ""
842
843 #. type: Plain text
844 #: build/C/man3/mq_open.3:135
845 msgid ""
846 "On success, B<mq_open>()  returns a message queue descriptor for use by "
847 "other message queue functions.  On error, B<mq_open>()  returns I<(mqd_t)\\ "
848 "-1>, with I<errno> set to indicate the error."
849 msgstr ""
850
851 #. type: TP
852 #: build/C/man3/mq_open.3:136 build/C/man3/mq_open.3:140 build/C/man3/mq_unlink.3:51 build/C/man2/msgctl.2:255 build/C/man2/msgget.2:147 build/C/man2/msgop.2:306 build/C/man2/msgop.2:361
853 #, no-wrap
854 msgid "B<EACCES>"
855 msgstr ""
856
857 #. type: Plain text
858 #: build/C/man3/mq_open.3:140
859 msgid ""
860 "The queue exists, but the caller does not have permission to open it in the "
861 "specified mode."
862 msgstr ""
863
864 #.  Note that this isn't consistent with the same case for sem_open()
865 #. type: Plain text
866 #: build/C/man3/mq_open.3:145
867 msgid "I<name> contained more than one slash."
868 msgstr ""
869
870 #. type: TP
871 #: build/C/man3/mq_open.3:145 build/C/man2/msgget.2:155
872 #, no-wrap
873 msgid "B<EEXIST>"
874 msgstr ""
875
876 #. type: Plain text
877 #: build/C/man3/mq_open.3:156
878 msgid ""
879 "Both B<O_CREAT> and B<O_EXCL> were specified in I<oflag>, but a queue with "
880 "this I<name> already exists."
881 msgstr ""
882
883 #. type: Plain text
884 #: build/C/man3/mq_open.3:188
885 msgid ""
886 "B<O_CREAT> was specified in I<oflag>, and I<attr> was not NULL, but "
887 "I<attr-E<gt>mq_maxmsg> or I<attr-E<gt>mq_msqsize> was invalid.  Both of "
888 "these fields must be greater than zero.  In a process that is unprivileged "
889 "(does not have the B<CAP_SYS_RESOURCE> capability), I<attr-E<gt>mq_maxmsg> "
890 "must be less than or equal to the I<msg_max> limit, and "
891 "I<attr-E<gt>mq_msgsize> must be less than or equal to the I<msgsize_max> "
892 "limit.  In addition, even in a privileged process, I<attr-E<gt>mq_maxmsg> "
893 "cannot exceed the B<HARD_MAX> limit.  (See B<mq_overview>(7)  for details of "
894 "these limits.)"
895 msgstr ""
896
897 #. type: TP
898 #: build/C/man3/mq_open.3:188
899 #, no-wrap
900 msgid "B<EMFILE>"
901 msgstr ""
902
903 #. type: Plain text
904 #: build/C/man3/mq_open.3:192
905 msgid "The process already has the maximum number of files and message queues open."
906 msgstr ""
907
908 #. type: TP
909 #: build/C/man3/mq_open.3:192 build/C/man3/mq_unlink.3:54
910 #, no-wrap
911 msgid "B<ENAMETOOLONG>"
912 msgstr ""
913
914 #. type: Plain text
915 #: build/C/man3/mq_open.3:196 build/C/man3/mq_unlink.3:58
916 msgid "I<name> was too long."
917 msgstr ""
918
919 #. type: TP
920 #: build/C/man3/mq_open.3:196
921 #, no-wrap
922 msgid "B<ENFILE>"
923 msgstr ""
924
925 #. type: Plain text
926 #: build/C/man3/mq_open.3:200
927 msgid ""
928 "The system limit on the total number of open files and message queues has "
929 "been reached."
930 msgstr ""
931
932 #. type: TP
933 #: build/C/man3/mq_open.3:200 build/C/man3/mq_open.3:209 build/C/man3/mq_unlink.3:58 build/C/man2/msgget.2:165
934 #, no-wrap
935 msgid "B<ENOENT>"
936 msgstr ""
937
938 #. type: Plain text
939 #: build/C/man3/mq_open.3:209
940 msgid ""
941 "The B<O_CREAT> flag was not specified in I<oflag>, and no queue with this "
942 "I<name> exists."
943 msgstr ""
944
945 #.  Note that this isn't consistent with the same case for sem_open()
946 #. type: Plain text
947 #: build/C/man3/mq_open.3:214
948 msgid "I<name> was just \"/\" followed by no other characters."
949 msgstr ""
950
951 #. type: TP
952 #: build/C/man3/mq_open.3:217 build/C/man2/msgget.2:177
953 #, no-wrap
954 msgid "B<ENOSPC>"
955 msgstr ""
956
957 #. type: Plain text
958 #: build/C/man3/mq_open.3:224
959 msgid ""
960 "Insufficient space for the creation of a new message queue.  This probably "
961 "occurred because the I<queues_max> limit was encountered; see "
962 "B<mq_overview>(7)."
963 msgstr ""
964
965 #. type: SH
966 #: build/C/man3/mq_open.3:226 build/C/man2/msgget.2:224
967 #, no-wrap
968 msgid "BUGS"
969 msgstr ""
970
971 #. type: Plain text
972 #: build/C/man3/mq_open.3:230
973 msgid ""
974 "In kernels before 2.6.14, the process umask was not applied to the "
975 "permissions specified in I<mode>."
976 msgstr ""
977
978 #. type: Plain text
979 #: build/C/man3/mq_open.3:238
980 msgid ""
981 "B<mq_close>(3), B<mq_getattr>(3), B<mq_notify>(3), B<mq_receive>(3), "
982 "B<mq_send>(3), B<mq_unlink>(3), B<mq_overview>(7)"
983 msgstr ""
984
985 #. type: TH
986 #: build/C/man7/mq_overview.7:26
987 #, no-wrap
988 msgid "MQ_OVERVIEW"
989 msgstr ""
990
991 #. type: TH
992 #: build/C/man7/mq_overview.7:26
993 #, no-wrap
994 msgid "2009-09-27"
995 msgstr ""
996
997 #. type: Plain text
998 #: build/C/man7/mq_overview.7:29
999 msgid "mq_overview - overview of POSIX message queues"
1000 msgstr ""
1001
1002 #. type: Plain text
1003 #: build/C/man7/mq_overview.7:37
1004 msgid ""
1005 "POSIX message queues allow processes to exchange data in the form of "
1006 "messages.  This API is distinct from that provided by System V message "
1007 "queues (B<msgget>(2), B<msgsnd>(2), B<msgrcv>(2), etc.), but provides "
1008 "similar functionality."
1009 msgstr ""
1010
1011 #. type: Plain text
1012 #: build/C/man7/mq_overview.7:52
1013 msgid ""
1014 "Message queues are created and opened using B<mq_open>(3); this function "
1015 "returns a I<message queue descriptor> (I<mqd_t>), which is used to refer to "
1016 "the open message queue in later calls.  Each message queue is identified by "
1017 "a name of the form I</somename>; that is, a null-terminated string of up to "
1018 "B<NAME_MAX> (i.e., 255) characters consisting of an initial slash, followed "
1019 "by one or more characters, none of which are slashes.  Two processes can "
1020 "operate on the same queue by passing the same name to B<mq_open>(3)."
1021 msgstr ""
1022
1023 #. type: Plain text
1024 #: build/C/man7/mq_overview.7:68
1025 msgid ""
1026 "Messages are transferred to and from a queue using B<mq_send>(3)  and "
1027 "B<mq_receive>(3).  When a process has finished using the queue, it closes it "
1028 "using B<mq_close>(3), and when the queue is no longer required, it can be "
1029 "deleted using B<mq_unlink>(3).  Queue attributes can be retrieved and (in "
1030 "some cases) modified using B<mq_getattr>(3)  and B<mq_setattr>(3).  A "
1031 "process can request asynchronous notification of the arrival of a message on "
1032 "a previously empty queue using B<mq_notify>(3)."
1033 msgstr ""
1034
1035 #. type: Plain text
1036 #: build/C/man7/mq_overview.7:81
1037 msgid ""
1038 "A message queue descriptor is a reference to an I<open message queue "
1039 "description> (cf.  B<open>(2)).  After a B<fork>(2), a child inherits copies "
1040 "of its parent's message queue descriptors, and these descriptors refer to "
1041 "the same open message queue descriptions as the corresponding descriptors in "
1042 "the parent.  Corresponding descriptors in the two processes share the flags "
1043 "(I<mq_flags>)  that are associated with the open message queue description."
1044 msgstr ""
1045
1046 #. type: Plain text
1047 #: build/C/man7/mq_overview.7:94
1048 msgid ""
1049 "Each message has an associated I<priority>, and messages are always "
1050 "delivered to the receiving process highest priority first.  Message "
1051 "priorities range from 0 (low) to I<sysconf(_SC_MQ_PRIO_MAX)\\ -\\ 1> "
1052 "(high).  On Linux, I<sysconf(_SC_MQ_PRIO_MAX)> returns 32768, but "
1053 "POSIX.1-2001 only requires an implementation to support priorities in the "
1054 "range 0 to 31; some implementations only provide this range."
1055 msgstr ""
1056
1057 #. type: Plain text
1058 #: build/C/man7/mq_overview.7:97
1059 msgid ""
1060 "The remainder of this section describes some specific details of the Linux "
1061 "implementation of POSIX message queues."
1062 msgstr ""
1063
1064 #. type: SS
1065 #: build/C/man7/mq_overview.7:97
1066 #, no-wrap
1067 msgid "Library interfaces and system calls"
1068 msgstr ""
1069
1070 #. type: Plain text
1071 #: build/C/man7/mq_overview.7:103
1072 msgid ""
1073 "In most cases the B<mq_*()> library interfaces listed above are implemented "
1074 "on top of underlying system calls of the same name.  Deviations from this "
1075 "scheme are indicated in the following table:"
1076 msgstr ""
1077
1078 #. type: tbl table
1079 #: build/C/man7/mq_overview.7:107
1080 #, no-wrap
1081 msgid "Library interface\tSystem call\n"
1082 msgstr ""
1083
1084 #. type: tbl table
1085 #: build/C/man7/mq_overview.7:108
1086 #, no-wrap
1087 msgid "mq_close(3)\tclose(2)\n"
1088 msgstr ""
1089
1090 #. type: tbl table
1091 #: build/C/man7/mq_overview.7:109
1092 #, no-wrap
1093 msgid "mq_getattr(3)\tmq_getsetattr(2)\n"
1094 msgstr ""
1095
1096 #. type: tbl table
1097 #: build/C/man7/mq_overview.7:110
1098 #, no-wrap
1099 msgid "mq_notify(3)\tmq_notify(2)\n"
1100 msgstr ""
1101
1102 #. type: tbl table
1103 #: build/C/man7/mq_overview.7:111
1104 #, no-wrap
1105 msgid "mq_open(3)\tmq_open(2)\n"
1106 msgstr ""
1107
1108 #. type: tbl table
1109 #: build/C/man7/mq_overview.7:112
1110 #, no-wrap
1111 msgid "mq_receive(3)\tmq_timedreceive(2)\n"
1112 msgstr ""
1113
1114 #. type: tbl table
1115 #: build/C/man7/mq_overview.7:113
1116 #, no-wrap
1117 msgid "mq_send(3)\tmq_timedsend(2)\n"
1118 msgstr ""
1119
1120 #. type: tbl table
1121 #: build/C/man7/mq_overview.7:114
1122 #, no-wrap
1123 msgid "mq_setattr(3)\tmq_getsetattr(2)\n"
1124 msgstr ""
1125
1126 #. type: tbl table
1127 #: build/C/man7/mq_overview.7:115
1128 #, no-wrap
1129 msgid "mq_timedreceive(3)\tmq_timedreceive(2)\n"
1130 msgstr ""
1131
1132 #. type: tbl table
1133 #: build/C/man7/mq_overview.7:116
1134 #, no-wrap
1135 msgid "mq_timedsend(3)\tmq_timedsend(2)\n"
1136 msgstr ""
1137
1138 #. type: tbl table
1139 #: build/C/man7/mq_overview.7:117
1140 #, no-wrap
1141 msgid "mq_unlink(3)\tmq_unlink(2)\n"
1142 msgstr ""
1143
1144 #. type: SS
1145 #: build/C/man7/mq_overview.7:120
1146 #, no-wrap
1147 msgid "Versions"
1148 msgstr ""
1149
1150 #. type: Plain text
1151 #: build/C/man7/mq_overview.7:123
1152 msgid ""
1153 "POSIX message queues have been supported on Linux since kernel 2.6.6.  Glibc "
1154 "support has been provided since version 2.3.4."
1155 msgstr ""
1156
1157 #. type: SS
1158 #: build/C/man7/mq_overview.7:123
1159 #, no-wrap
1160 msgid "Kernel configuration"
1161 msgstr ""
1162
1163 #. type: Plain text
1164 #: build/C/man7/mq_overview.7:128
1165 msgid ""
1166 "Support for POSIX message queues is configurable via the "
1167 "B<CONFIG_POSIX_MQUEUE> kernel configuration option.  This option is enabled "
1168 "by default."
1169 msgstr ""
1170
1171 #. type: SS
1172 #: build/C/man7/mq_overview.7:128
1173 #, no-wrap
1174 msgid "Persistence"
1175 msgstr ""
1176
1177 #. type: Plain text
1178 #: build/C/man7/mq_overview.7:133
1179 msgid ""
1180 "POSIX message queues have kernel persistence: if not removed by "
1181 "B<mq_unlink>(3), a message queue will exist until the system is shut down."
1182 msgstr ""
1183
1184 #. type: SS
1185 #: build/C/man7/mq_overview.7:133
1186 #, no-wrap
1187 msgid "Linking"
1188 msgstr ""
1189
1190 #. type: Plain text
1191 #: build/C/man7/mq_overview.7:138
1192 msgid ""
1193 "Programs using the POSIX message queue API must be compiled with I<cc -lrt> "
1194 "to link against the real-time library, I<librt>."
1195 msgstr ""
1196
1197 #. type: SS
1198 #: build/C/man7/mq_overview.7:138
1199 #, no-wrap
1200 msgid "/proc interfaces"
1201 msgstr ""
1202
1203 #. type: Plain text
1204 #: build/C/man7/mq_overview.7:141
1205 msgid ""
1206 "The following interfaces can be used to limit the amount of kernel memory "
1207 "consumed by POSIX message queues:"
1208 msgstr ""
1209
1210 #. type: TP
1211 #: build/C/man7/mq_overview.7:141
1212 #, no-wrap
1213 msgid "I</proc/sys/fs/mqueue/msg_max>"
1214 msgstr ""
1215
1216 #. type: Plain text
1217 #: build/C/man7/mq_overview.7:162
1218 msgid ""
1219 "This file can be used to view and change the ceiling value for the maximum "
1220 "number of messages in a queue.  This value acts as a ceiling on the "
1221 "I<attr-E<gt>mq_maxmsg> argument given to B<mq_open>(3).  The default value "
1222 "for I<msg_max> is 10.  The minimum value is 1 (10 in kernels before "
1223 "2.6.28).  The upper limit is B<HARD_MAX>: I<(131072\\ /\\ sizeof(void\\ *))> "
1224 "(32768 on Linux/86).  This limit is ignored for privileged processes "
1225 "(B<CAP_SYS_RESOURCE>), but the B<HARD_MAX> ceiling is nevertheless imposed."
1226 msgstr ""
1227
1228 #. type: TP
1229 #: build/C/man7/mq_overview.7:162
1230 #, no-wrap
1231 msgid "I</proc/sys/fs/mqueue/msgsize_max>"
1232 msgstr ""
1233
1234 #. type: Plain text
1235 #: build/C/man7/mq_overview.7:181
1236 msgid ""
1237 "This file can be used to view and change the ceiling on the maximum message "
1238 "size.  This value acts as a ceiling on the I<attr-E<gt>mq_msgsize> argument "
1239 "given to B<mq_open>(3).  The default value for I<msgsize_max> is 8192 "
1240 "bytes.  The minimum value is 128 (8192 in kernels before 2.6.28).  The upper "
1241 "limit for I<msgsize_max> is 1,048,576 (in kernels before 2.6.28, the upper "
1242 "limit was B<INT_MAX>; that is, 2,147,483,647 on Linux/86).  This limit is "
1243 "ignored for privileged processes (B<CAP_SYS_RESOURCE>)."
1244 msgstr ""
1245
1246 #. type: TP
1247 #: build/C/man7/mq_overview.7:181
1248 #, no-wrap
1249 msgid "I</proc/sys/fs/mqueue/queues_max>"
1250 msgstr ""
1251
1252 #. type: Plain text
1253 #: build/C/man7/mq_overview.7:191
1254 msgid ""
1255 "This file can be used to view and change the system-wide limit on the number "
1256 "of message queues that can be created.  Only privileged processes "
1257 "(B<CAP_SYS_RESOURCE>)  can create new message queues once this limit has "
1258 "been reached.  The default value for I<queues_max> is 256; it can be changed "
1259 "to any value in the range 0 to INT_MAX."
1260 msgstr ""
1261
1262 #. type: SS
1263 #: build/C/man7/mq_overview.7:191
1264 #, no-wrap
1265 msgid "Resource limit"
1266 msgstr ""
1267
1268 #. type: Plain text
1269 #: build/C/man7/mq_overview.7:198
1270 msgid ""
1271 "The B<RLIMIT_MSGQUEUE> resource limit, which places a limit on the amount of "
1272 "space that can be consumed by all of the message queues belonging to a "
1273 "process's real user ID, is described in B<getrlimit>(2)."
1274 msgstr ""
1275
1276 #. type: SS
1277 #: build/C/man7/mq_overview.7:198
1278 #, no-wrap
1279 msgid "Mounting the message queue file system"
1280 msgstr ""
1281
1282 #. type: Plain text
1283 #: build/C/man7/mq_overview.7:204
1284 msgid ""
1285 "On Linux, message queues are created in a virtual file system.  (Other "
1286 "implementations may also provide such a feature, but the details are likely "
1287 "to differ.)  This file system can be mounted (by the superuser) using the "
1288 "following commands:"
1289 msgstr ""
1290
1291 #. type: Plain text
1292 #: build/C/man7/mq_overview.7:209
1293 #, no-wrap
1294 msgid ""
1295 "#B< mkdir /dev/mqueue>\n"
1296 "#B< mount -t mqueue none /dev/mqueue>\n"
1297 msgstr ""
1298
1299 #. type: Plain text
1300 #: build/C/man7/mq_overview.7:213
1301 msgid "The sticky bit is automatically enabled on the mount directory."
1302 msgstr ""
1303
1304 #. type: Plain text
1305 #: build/C/man7/mq_overview.7:220
1306 msgid ""
1307 "After the file system has been mounted, the message queues on the system can "
1308 "be viewed and manipulated using the commands usually used for files (e.g., "
1309 "B<ls>(1)  and B<rm>(1))."
1310 msgstr ""
1311
1312 #. type: Plain text
1313 #: build/C/man7/mq_overview.7:223
1314 msgid ""
1315 "The contents of each file in the directory consist of a single line "
1316 "containing information about the queue:"
1317 msgstr ""
1318
1319 #. type: Plain text
1320 #: build/C/man7/mq_overview.7:228
1321 #, no-wrap
1322 msgid ""
1323 "$B< cat /dev/mqueue/mymq>\n"
1324 "QSIZE:129     NOTIFY:2    SIGNO:0    NOTIFY_PID:8260\n"
1325 msgstr ""
1326
1327 #. type: Plain text
1328 #: build/C/man7/mq_overview.7:232
1329 msgid "These fields are as follows:"
1330 msgstr ""
1331
1332 #. type: TP
1333 #: build/C/man7/mq_overview.7:232
1334 #, no-wrap
1335 msgid "B<QSIZE>"
1336 msgstr ""
1337
1338 #. type: Plain text
1339 #: build/C/man7/mq_overview.7:235
1340 msgid "Number of bytes of data in all messages in the queue."
1341 msgstr ""
1342
1343 #. type: TP
1344 #: build/C/man7/mq_overview.7:235
1345 #, no-wrap
1346 msgid "B<NOTIFY_PID>"
1347 msgstr ""
1348
1349 #. type: Plain text
1350 #: build/C/man7/mq_overview.7:241
1351 msgid ""
1352 "If this is nonzero, then the process with this PID has used B<mq_notify>(3)  "
1353 "to register for asynchronous message notification, and the remaining fields "
1354 "describe how notification occurs."
1355 msgstr ""
1356
1357 #. type: TP
1358 #: build/C/man7/mq_overview.7:241
1359 #, no-wrap
1360 msgid "B<NOTIFY>"
1361 msgstr ""
1362
1363 #. type: Plain text
1364 #: build/C/man7/mq_overview.7:251
1365 msgid ""
1366 "Notification method: 0 is B<SIGEV_SIGNAL>; 1 is B<SIGEV_NONE>; and 2 is "
1367 "B<SIGEV_THREAD>."
1368 msgstr ""
1369
1370 #. type: TP
1371 #: build/C/man7/mq_overview.7:251
1372 #, no-wrap
1373 msgid "B<SIGNO>"
1374 msgstr ""
1375
1376 #. type: Plain text
1377 #: build/C/man7/mq_overview.7:255
1378 msgid "Signal number to be used for B<SIGEV_SIGNAL>."
1379 msgstr ""
1380
1381 #. type: SS
1382 #: build/C/man7/mq_overview.7:255
1383 #, no-wrap
1384 msgid "Polling message queue descriptors"
1385 msgstr ""
1386
1387 #. type: Plain text
1388 #: build/C/man7/mq_overview.7:263
1389 msgid ""
1390 "On Linux, a message queue descriptor is actually a file descriptor, and can "
1391 "be monitored using B<select>(2), B<poll>(2), or B<epoll>(7).  This is not "
1392 "portable."
1393 msgstr ""
1394
1395 #. type: Plain text
1396 #: build/C/man7/mq_overview.7:275
1397 msgid ""
1398 "System V message queues (B<msgget>(2), B<msgsnd>(2), B<msgrcv>(2), etc.) are "
1399 "an older API for exchanging messages between processes.  POSIX message "
1400 "queues provide a better designed interface than System V message queues; on "
1401 "the other hand POSIX message queues are less widely available (especially on "
1402 "older systems) than System V message queues."
1403 msgstr ""
1404
1405 #. type: Plain text
1406 #: build/C/man7/mq_overview.7:278
1407 msgid ""
1408 "Linux does not currently (2.6.26) support the use of access control lists "
1409 "(ACLs) for POSIX message queues."
1410 msgstr ""
1411
1412 #. type: Plain text
1413 #: build/C/man7/mq_overview.7:281
1414 msgid ""
1415 "An example of the use of various message queue functions is shown in "
1416 "B<mq_notify>(3)."
1417 msgstr ""
1418
1419 #. type: Plain text
1420 #: build/C/man7/mq_overview.7:294
1421 msgid ""
1422 "B<getrlimit>(2), B<mq_getsetattr>(2), B<poll>(2), B<select>(2), "
1423 "B<mq_close>(3), B<mq_getattr>(3), B<mq_notify>(3), B<mq_open>(3), "
1424 "B<mq_receive>(3), B<mq_send>(3), B<mq_unlink>(3), B<epoll>(7)"
1425 msgstr ""
1426
1427 #. type: TH
1428 #: build/C/man3/mq_receive.3:26
1429 #, no-wrap
1430 msgid "MQ_RECEIVE"
1431 msgstr ""
1432
1433 #. type: TH
1434 #: build/C/man3/mq_receive.3:26 build/C/man3/mq_send.3:26
1435 #, no-wrap
1436 msgid "2010-09-20"
1437 msgstr ""
1438
1439 #. type: Plain text
1440 #: build/C/man3/mq_receive.3:29
1441 msgid "mq_receive, mq_timedreceive - receive a message from a message queue"
1442 msgstr ""
1443
1444 #. type: Plain text
1445 #: build/C/man3/mq_receive.3:35
1446 #, no-wrap
1447 msgid ""
1448 "B<ssize_t mq_receive(mqd_t >I<mqdes>B<, char *>I<msg_ptr>B<,>\n"
1449 "B<                   size_t >I<msg_len>B<, unsigned *>I<msg_prio>B<);>\n"
1450 msgstr ""
1451
1452 #. type: Plain text
1453 #: build/C/man3/mq_receive.3:38 build/C/man3/mq_send.3:38
1454 #, no-wrap
1455 msgid ""
1456 "B<#include E<lt>time.hE<gt>>\n"
1457 "B<#include E<lt>mqueue.hE<gt>>\n"
1458 msgstr ""
1459
1460 #. type: Plain text
1461 #: build/C/man3/mq_receive.3:42
1462 #, no-wrap
1463 msgid ""
1464 "B<ssize_t mq_timedreceive(mqd_t >I<mqdes>B<, char *>I<msg_ptr>B<,>\n"
1465 "B<                   size_t >I<msg_len>B<, unsigned *>I<msg_prio>B<,>\n"
1466 "B<                   const struct timespec *>I<abs_timeout>B<);>\n"
1467 msgstr ""
1468
1469 #. type: Plain text
1470 #: build/C/man3/mq_receive.3:50 build/C/man3/mq_send.3:50
1471 msgid "Feature Test Macro Requirements for glibc (see B<feature_test_macros>(7)):"
1472 msgstr ""
1473
1474 #. type: Plain text
1475 #: build/C/man3/mq_receive.3:53
1476 msgid "B<mq_timedreceive>():"
1477 msgstr ""
1478
1479 #. type: Plain text
1480 #: build/C/man3/mq_receive.3:55 build/C/man3/mq_send.3:55
1481 msgid "_XOPEN_SOURCE\\ E<gt>=\\ 600 || _POSIX_C_SOURCE\\ E<gt>=\\ 200112L"
1482 msgstr ""
1483
1484 #. type: Plain text
1485 #: build/C/man3/mq_receive.3:76
1486 msgid ""
1487 "B<mq_receive>()  removes the oldest message with the highest priority from "
1488 "the message queue referred to by the descriptor I<mqdes>, and places it in "
1489 "the buffer pointed to by I<msg_ptr>.  The I<msg_len> argument specifies the "
1490 "size of the buffer pointed to by I<msg_ptr>; this must be greater than the "
1491 "I<mq_msgsize> attribute of the queue (see B<mq_getattr>(3)).  If I<msg_prio> "
1492 "is not NULL, then the buffer to which it points is used to return the "
1493 "priority associated with the received message."
1494 msgstr ""
1495
1496 #. type: Plain text
1497 #: build/C/man3/mq_receive.3:86
1498 msgid ""
1499 "If the queue is empty, then, by default, B<mq_receive>()  blocks until a "
1500 "message becomes available, or the call is interrupted by a signal handler.  "
1501 "If the B<O_NONBLOCK> flag is enabled for the message queue description, then "
1502 "the call instead fails immediately with the error B<EAGAIN>."
1503 msgstr ""
1504
1505 #. type: Plain text
1506 #: build/C/man3/mq_receive.3:99
1507 msgid ""
1508 "B<mq_timedreceive>()  behaves just like B<mq_receive>(), except that if the "
1509 "queue is empty and the B<O_NONBLOCK> flag is not enabled for the message "
1510 "queue description, then I<abs_timeout> points to a structure which specifies "
1511 "a ceiling on the time for which the call will block.  This ceiling is an "
1512 "absolute timeout in seconds and nanoseconds since the Epoch, 1970-01-01 "
1513 "00:00:00 +0000 (UTC), and it is specified in the following structure:"
1514 msgstr ""
1515
1516 #. type: Plain text
1517 #: build/C/man3/mq_receive.3:106 build/C/man3/mq_send.3:112
1518 #, no-wrap
1519 msgid ""
1520 "struct timespec {\n"
1521 "    time_t tv_sec;        /* seconds */\n"
1522 "    long   tv_nsec;       /* nanoseconds */\n"
1523 "};\n"
1524 msgstr ""
1525
1526 #. type: Plain text
1527 #: build/C/man3/mq_receive.3:113
1528 msgid ""
1529 "If no message is available, and the timeout has already expired by the time "
1530 "of the call, B<mq_timedreceive>()  returns immediately."
1531 msgstr ""
1532
1533 #. type: Plain text
1534 #: build/C/man3/mq_receive.3:122
1535 msgid ""
1536 "On success, B<mq_receive>()  and B<mq_timedreceive>()  return the number of "
1537 "bytes in the received message; on error, -1 is returned, with I<errno> set "
1538 "to indicate the error."
1539 msgstr ""
1540
1541 #. type: TP
1542 #: build/C/man3/mq_receive.3:123 build/C/man3/mq_send.3:128 build/C/man2/msgop.2:312 build/C/man2/msgop.2:367
1543 #, no-wrap
1544 msgid "B<EAGAIN>"
1545 msgstr ""
1546
1547 #. type: Plain text
1548 #: build/C/man3/mq_receive.3:129
1549 msgid ""
1550 "The queue was empty, and the B<O_NONBLOCK> flag was set for the message "
1551 "queue description referred to by I<mqdes>."
1552 msgstr ""
1553
1554 #. type: Plain text
1555 #: build/C/man3/mq_receive.3:134 build/C/man3/mq_send.3:139
1556 msgid "The descriptor specified in I<mqdes> was invalid."
1557 msgstr ""
1558
1559 #. type: TP
1560 #: build/C/man3/mq_receive.3:134 build/C/man3/mq_send.3:139 build/C/man2/msgop.2:328 build/C/man2/msgop.2:382
1561 #, no-wrap
1562 msgid "B<EINTR>"
1563 msgstr ""
1564
1565 #. type: Plain text
1566 #: build/C/man3/mq_receive.3:138 build/C/man3/mq_send.3:143
1567 msgid "The call was interrupted by a signal handler; see B<signal>(7)."
1568 msgstr ""
1569
1570 #. type: Plain text
1571 #: build/C/man3/mq_receive.3:147 build/C/man3/mq_send.3:152
1572 msgid ""
1573 "The call would have blocked, and I<abs_timeout> was invalid, either because "
1574 "I<tv_sec> was less than zero, or because I<tv_nsec> was less than zero or "
1575 "greater than 1000 million."
1576 msgstr ""
1577
1578 #. type: TP
1579 #: build/C/man3/mq_receive.3:147 build/C/man3/mq_send.3:152
1580 #, no-wrap
1581 msgid "B<EMSGSIZE>"
1582 msgstr ""
1583
1584 #. type: Plain text
1585 #: build/C/man3/mq_receive.3:153
1586 msgid "I<msg_len> was less than the I<mq_msgsize> attribute of the message queue."
1587 msgstr ""
1588
1589 #. type: TP
1590 #: build/C/man3/mq_receive.3:153 build/C/man3/mq_send.3:158
1591 #, no-wrap
1592 msgid "B<ETIMEDOUT>"
1593 msgstr ""
1594
1595 #. type: Plain text
1596 #: build/C/man3/mq_receive.3:156 build/C/man3/mq_send.3:161
1597 msgid "The call timed out before a message could be transferred."
1598 msgstr ""
1599
1600 #. type: Plain text
1601 #: build/C/man3/mq_receive.3:164
1602 msgid ""
1603 "On Linux, B<mq_timedreceive>()  is a system call, and B<mq_receive>()  is a "
1604 "library function layered on top of that system call."
1605 msgstr ""
1606
1607 #. type: Plain text
1608 #: build/C/man3/mq_receive.3:173
1609 msgid ""
1610 "B<mq_close>(3), B<mq_getattr>(3), B<mq_notify>(3), B<mq_open>(3), "
1611 "B<mq_send>(3), B<mq_unlink>(3), B<mq_overview>(7), B<time>(7)"
1612 msgstr ""
1613
1614 #. type: TH
1615 #: build/C/man3/mq_send.3:26
1616 #, no-wrap
1617 msgid "MQ_SEND"
1618 msgstr ""
1619
1620 #. type: Plain text
1621 #: build/C/man3/mq_send.3:29
1622 msgid "mq_send, mq_timedsend - send a message to a message queue"
1623 msgstr ""
1624
1625 #. type: Plain text
1626 #: build/C/man3/mq_send.3:35
1627 #, no-wrap
1628 msgid ""
1629 "B<int mq_send(mqd_t >I<mqdes>B<, const char *>I<msg_ptr>B<,>\n"
1630 "B<              size_t >I<msg_len>B<, unsigned >I<msg_prio>B<);>\n"
1631 msgstr ""
1632
1633 #. type: Plain text
1634 #: build/C/man3/mq_send.3:42
1635 #, no-wrap
1636 msgid ""
1637 "B<int mq_timedsend(mqd_t >I<mqdes>B<, const char *>I<msg_ptr>B<,>\n"
1638 "B<              size_t >I<msg_len>B<, unsigned >I<msg_prio>B<,>\n"
1639 "B<              const struct timespec *>I<abs_timeout>B<);>\n"
1640 msgstr ""
1641
1642 #. type: Plain text
1643 #: build/C/man3/mq_send.3:53
1644 msgid "B<mq_timedsend>():"
1645 msgstr ""
1646
1647 #. type: Plain text
1648 #: build/C/man3/mq_send.3:71
1649 msgid ""
1650 "B<mq_send>()  adds the message pointed to by I<msg_ptr> to the message queue "
1651 "referred to by the descriptor I<mqdes>.  The I<msg_len> argument specifies "
1652 "the length of the message pointed to by I<msg_ptr>; this length must be less "
1653 "than or equal to the queue's I<mq_msgsize> attribute.  Zero-length messages "
1654 "are allowed."
1655 msgstr ""
1656
1657 #. type: Plain text
1658 #: build/C/man3/mq_send.3:79
1659 msgid ""
1660 "The I<msg_prio> argument is a nonnegative integer that specifies the "
1661 "priority of this message.  Messages are placed on the queue in decreasing "
1662 "order of priority, with newer messages of the same priority being placed "
1663 "after older messages with the same priority."
1664 msgstr ""
1665
1666 #. type: Plain text
1667 #: build/C/man3/mq_send.3:92
1668 msgid ""
1669 "If the message queue is already full (i.e., the number of messages on the "
1670 "queue equals the queue's I<mq_maxmsg> attribute), then, by default, "
1671 "B<mq_send>()  blocks until sufficient space becomes available to allow the "
1672 "message to be queued, or until the call is interrupted by a signal handler.  "
1673 "If the B<O_NONBLOCK> flag is enabled for the message queue description, then "
1674 "the call instead fails immediately with the error B<EAGAIN>."
1675 msgstr ""
1676
1677 #. type: Plain text
1678 #: build/C/man3/mq_send.3:105
1679 msgid ""
1680 "B<mq_timedsend>()  behaves just like B<mq_send>(), except that if the queue "
1681 "is full and the B<O_NONBLOCK> flag is not enabled for the message queue "
1682 "description, then I<abs_timeout> points to a structure which specifies a "
1683 "ceiling on the time for which the call will block.  This ceiling is an "
1684 "absolute timeout in seconds and nanoseconds since the Epoch, 1970-01-01 "
1685 "00:00:00 +0000 (UTC), and it is specified in the following structure:"
1686 msgstr ""
1687
1688 #. type: Plain text
1689 #: build/C/man3/mq_send.3:119
1690 msgid ""
1691 "If the message queue is full, and the timeout has already expired by the "
1692 "time of the call, B<mq_timedsend>()  returns immediately."
1693 msgstr ""
1694
1695 #. type: Plain text
1696 #: build/C/man3/mq_send.3:127
1697 msgid ""
1698 "On success, B<mq_send>()  and B<mq_timedsend>()  return zero; on error, -1 "
1699 "is returned, with I<errno> set to indicate the error."
1700 msgstr ""
1701
1702 #. type: Plain text
1703 #: build/C/man3/mq_send.3:134
1704 msgid ""
1705 "The queue was full, and the B<O_NONBLOCK> flag was set for the message queue "
1706 "description referred to by I<mqdes>."
1707 msgstr ""
1708
1709 #. type: Plain text
1710 #: build/C/man3/mq_send.3:158
1711 msgid ""
1712 "I<msg_len> was greater than the I<mq_msgsize> attribute of the message "
1713 "queue."
1714 msgstr ""
1715
1716 #. type: Plain text
1717 #: build/C/man3/mq_send.3:169
1718 msgid ""
1719 "On Linux, B<mq_timedsend>()  is a system call, and B<mq_send>()  is a "
1720 "library function layered on top of that system call."
1721 msgstr ""
1722
1723 #. type: Plain text
1724 #: build/C/man3/mq_send.3:178
1725 msgid ""
1726 "B<mq_close>(3), B<mq_getattr>(3), B<mq_notify>(3), B<mq_open>(3), "
1727 "B<mq_receive>(3), B<mq_unlink>(3), B<mq_overview>(7), B<time>(7)"
1728 msgstr ""
1729
1730 #. type: TH
1731 #: build/C/man3/mq_unlink.3:26
1732 #, no-wrap
1733 msgid "MQ_UNLINK"
1734 msgstr ""
1735
1736 #. type: Plain text
1737 #: build/C/man3/mq_unlink.3:29
1738 msgid "mq_unlink - remove a message queue"
1739 msgstr ""
1740
1741 #. type: Plain text
1742 #: build/C/man3/mq_unlink.3:34
1743 #, no-wrap
1744 msgid "B<int mq_unlink(const char *>I<name>B<);>\n"
1745 msgstr ""
1746
1747 #. type: Plain text
1748 #: build/C/man3/mq_unlink.3:44
1749 msgid ""
1750 "B<mq_unlink>()  removes the specified message queue I<name>.  The message "
1751 "queue name is removed immediately.  The queue itself is destroyed once any "
1752 "other processes that have the queue open close their descriptors referring "
1753 "to the queue."
1754 msgstr ""
1755
1756 #. type: Plain text
1757 #: build/C/man3/mq_unlink.3:50
1758 msgid ""
1759 "On success B<mq_unlink>()  returns 0; on error, -1 is returned, with "
1760 "I<errno> set to indicate the error."
1761 msgstr ""
1762
1763 #. type: Plain text
1764 #: build/C/man3/mq_unlink.3:54
1765 msgid "The caller does not have permission to unlink this message queue."
1766 msgstr ""
1767
1768 #. type: Plain text
1769 #: build/C/man3/mq_unlink.3:62
1770 msgid "There is no message queue with the given I<name>."
1771 msgstr ""
1772
1773 #. type: Plain text
1774 #: build/C/man3/mq_unlink.3:72
1775 msgid ""
1776 "B<mq_close>(3), B<mq_getattr>(3), B<mq_notify>(3), B<mq_open>(3), "
1777 "B<mq_receive>(3), B<mq_send>(3), B<mq_overview>(7)"
1778 msgstr ""
1779
1780 #. type: TH
1781 #: build/C/man2/msgctl.2:37
1782 #, no-wrap
1783 msgid "MSGCTL"
1784 msgstr ""
1785
1786 #. type: TH
1787 #: build/C/man2/msgctl.2:37 build/C/man2/msgget.2:35 build/C/man2/msgop.2:40
1788 #, no-wrap
1789 msgid "2012-05-31"
1790 msgstr ""
1791
1792 #. type: Plain text
1793 #: build/C/man2/msgctl.2:40
1794 msgid "msgctl - message control operations"
1795 msgstr ""
1796
1797 #. type: Plain text
1798 #: build/C/man2/msgctl.2:45 build/C/man2/msgget.2:43 build/C/man2/msgop.2:48
1799 #, no-wrap
1800 msgid ""
1801 "B<#include E<lt>sys/types.hE<gt>>\n"
1802 "B<#include E<lt>sys/ipc.hE<gt>>\n"
1803 "B<#include E<lt>sys/msg.hE<gt>>\n"
1804 msgstr ""
1805
1806 #. type: Plain text
1807 #: build/C/man2/msgctl.2:47
1808 #, no-wrap
1809 msgid "B<int msgctl(int >I<msqid>B<, int >I<cmd>B<, struct msqid_ds *>I<buf>B<);>\n"
1810 msgstr ""
1811
1812 #. type: Plain text
1813 #: build/C/man2/msgctl.2:54
1814 msgid ""
1815 "B<msgctl>()  performs the control operation specified by I<cmd> on the "
1816 "message queue with identifier I<msqid>."
1817 msgstr ""
1818
1819 #. type: Plain text
1820 #: build/C/man2/msgctl.2:58
1821 msgid ""
1822 "The I<msqid_ds> data structure is defined in I<E<lt>sys/msg.hE<gt>> as "
1823 "follows:"
1824 msgstr ""
1825
1826 #. type: Plain text
1827 #: build/C/man2/msgctl.2:75
1828 #, no-wrap
1829 msgid ""
1830 "struct msqid_ds {\n"
1831 "    struct ipc_perm msg_perm;     /* Ownership and permissions */\n"
1832 "    time_t          msg_stime;    /* Time of last msgsnd(2) */\n"
1833 "    time_t          msg_rtime;    /* Time of last msgrcv(2) */\n"
1834 "    time_t          msg_ctime;    /* Time of last change */\n"
1835 "    unsigned long   __msg_cbytes; /* Current number of bytes in\n"
1836 "                                     queue (nonstandard) */\n"
1837 "    msgqnum_t       msg_qnum;     /* Current number of messages\n"
1838 "                                     in queue */\n"
1839 "    msglen_t        msg_qbytes;   /* Maximum number of bytes\n"
1840 "                                     allowed in queue */\n"
1841 "    pid_t           msg_lspid;    /* PID of last msgsnd(2) */\n"
1842 "    pid_t           msg_lrpid;    /* PID of last msgrcv(2) */\n"
1843 "};\n"
1844 msgstr ""
1845
1846 #. type: Plain text
1847 #: build/C/man2/msgctl.2:83
1848 msgid ""
1849 "The I<ipc_perm> structure is defined as follows (the highlighted fields are "
1850 "settable using B<IPC_SET>):"
1851 msgstr ""
1852
1853 #. type: Plain text
1854 #: build/C/man2/msgctl.2:95
1855 #, no-wrap
1856 msgid ""
1857 "struct ipc_perm {\n"
1858 "    key_t          __key;       /* Key supplied to msgget(2) */\n"
1859 "    uid_t          B<uid>;         /* Effective UID of owner */\n"
1860 "    gid_t          B<gid>;         /* Effective GID of owner */\n"
1861 "    uid_t          cuid;        /* Effective UID of creator */\n"
1862 "    gid_t          cgid;        /* Effective GID of creator */\n"
1863 "    unsigned short B<mode>;        /* Permissions */\n"
1864 "    unsigned short __seq;       /* Sequence number */\n"
1865 "};\n"
1866 msgstr ""
1867
1868 #. type: Plain text
1869 #: build/C/man2/msgctl.2:101
1870 msgid "Valid values for I<cmd> are:"
1871 msgstr ""
1872
1873 #. type: TP
1874 #: build/C/man2/msgctl.2:101
1875 #, no-wrap
1876 msgid "B<IPC_STAT>"
1877 msgstr ""
1878
1879 #. type: Plain text
1880 #: build/C/man2/msgctl.2:110
1881 msgid ""
1882 "Copy information from the kernel data structure associated with I<msqid> "
1883 "into the I<msqid_ds> structure pointed to by I<buf>.  The caller must have "
1884 "read permission on the message queue."
1885 msgstr ""
1886
1887 #. type: TP
1888 #: build/C/man2/msgctl.2:110
1889 #, no-wrap
1890 msgid "B<IPC_SET>"
1891 msgstr ""
1892
1893 #. type: Plain text
1894 #: build/C/man2/msgctl.2:137
1895 msgid ""
1896 "Write the values of some members of the I<msqid_ds> structure pointed to by "
1897 "I<buf> to the kernel data structure associated with this message queue, "
1898 "updating also its I<msg_ctime> member.  The following members of the "
1899 "structure are updated: I<msg_qbytes>, I<msg_perm.uid>, I<msg_perm.gid>, and "
1900 "(the least significant 9 bits of)  I<msg_perm.mode>.  The effective UID of "
1901 "the calling process must match the owner (I<msg_perm.uid>)  or creator "
1902 "(I<msg_perm.cuid>)  of the message queue, or the caller must be privileged.  "
1903 "Appropriate privilege (Linux: the B<CAP_IPC_RESOURCE> capability) is "
1904 "required to raise the I<msg_qbytes> value beyond the system parameter "
1905 "B<MSGMNB>."
1906 msgstr ""
1907
1908 #. type: TP
1909 #: build/C/man2/msgctl.2:137
1910 #, no-wrap
1911 msgid "B<IPC_RMID>"
1912 msgstr ""
1913
1914 #. type: Plain text
1915 #: build/C/man2/msgctl.2:148
1916 msgid ""
1917 "Immediately remove the message queue, awakening all waiting reader and "
1918 "writer processes (with an error return and I<errno> set to B<EIDRM>).  The "
1919 "calling process must have appropriate privileges or its effective user ID "
1920 "must be either that of the creator or owner of the message queue."
1921 msgstr ""
1922
1923 #. type: TP
1924 #: build/C/man2/msgctl.2:148
1925 #, no-wrap
1926 msgid "B<IPC_INFO> (Linux-specific)"
1927 msgstr ""
1928
1929 #. type: Plain text
1930 #: build/C/man2/msgctl.2:161
1931 msgid ""
1932 "Returns information about system-wide message queue limits and parameters in "
1933 "the structure pointed to by I<buf>.  This structure is of type I<msginfo> "
1934 "(thus, a cast is required), defined in I<E<lt>sys/msg.hE<gt>> if the "
1935 "B<_GNU_SOURCE> feature test macro is defined:"
1936 msgstr ""
1937
1938 #. type: Plain text
1939 #: build/C/man2/msgctl.2:185
1940 #, no-wrap
1941 msgid ""
1942 "struct msginfo {\n"
1943 "    int msgpool; /* Size in kibibytes of buffer pool\n"
1944 "                    used to hold message data;\n"
1945 "                    unused within kernel */\n"
1946 "    int msgmap;  /* Maximum number of entries in message\n"
1947 "                    map; unused within kernel */\n"
1948 "    int msgmax;  /* Maximum number of bytes that can be\n"
1949 "                    written in a single message */\n"
1950 "    int msgmnb;  /* Maximum number of bytes that can be\n"
1951 "                    written to queue; used to initialize\n"
1952 "                    msg_qbytes during queue creation\n"
1953 "                    (msgget(2)) */\n"
1954 "    int msgmni;  /* Maximum number of message queues */\n"
1955 "    int msgssz;  /* Message segment size;\n"
1956 "                    unused within kernel */\n"
1957 "    int msgtql;  /* Maximum number of messages on all queues\n"
1958 "                    in system; unused within kernel */\n"
1959 "    unsigned short int msgseg;\n"
1960 "                 /* Maximum number of segments;\n"
1961 "                    unused within kernel */\n"
1962 "};\n"
1963 msgstr ""
1964
1965 #. type: Plain text
1966 #: build/C/man2/msgctl.2:198
1967 msgid ""
1968 "The I<msgmni>, I<msgmax>, and I<msgmnb> settings can be changed via I</proc> "
1969 "files of the same name; see B<proc>(5)  for details."
1970 msgstr ""
1971
1972 #. type: TP
1973 #: build/C/man2/msgctl.2:198
1974 #, no-wrap
1975 msgid "B<MSG_INFO> (Linux-specific)"
1976 msgstr ""
1977
1978 #. type: Plain text
1979 #: build/C/man2/msgctl.2:215
1980 msgid ""
1981 "Returns a I<msginfo> structure containing the same information as for "
1982 "B<IPC_INFO>, except that the following fields are returned with information "
1983 "about system resources consumed by message queues: the I<msgpool> field "
1984 "returns the number of message queues that currently exist on the system; the "
1985 "I<msgmap> field returns the total number of messages in all queues on the "
1986 "system; and the I<msgtql> field returns the total number of bytes in all "
1987 "messages in all queues on the system."
1988 msgstr ""
1989
1990 #. type: TP
1991 #: build/C/man2/msgctl.2:215
1992 #, no-wrap
1993 msgid "B<MSG_STAT> (Linux-specific)"
1994 msgstr ""
1995
1996 #. type: Plain text
1997 #: build/C/man2/msgctl.2:226
1998 msgid ""
1999 "Returns a I<msqid_ds> structure as for B<IPC_STAT>.  However, the I<msqid> "
2000 "argument is not a queue identifier, but instead an index into the kernel's "
2001 "internal array that maintains information about all message queues on the "
2002 "system."
2003 msgstr ""
2004
2005 #. type: Plain text
2006 #: build/C/man2/msgctl.2:247
2007 msgid ""
2008 "On success, B<IPC_STAT>, B<IPC_SET>, and B<IPC_RMID> return 0.  A successful "
2009 "B<IPC_INFO> or B<MSG_INFO> operation returns the index of the highest used "
2010 "entry in the kernel's internal array recording information about all message "
2011 "queues.  (This information can be used with repeated B<MSG_STAT> operations "
2012 "to obtain information about all queues on the system.)  A successful "
2013 "B<MSG_STAT> operation returns the identifier of the queue whose index was "
2014 "given in I<msqid>."
2015 msgstr ""
2016
2017 #. type: Plain text
2018 #: build/C/man2/msgctl.2:251
2019 msgid "On error, -1 is returned with I<errno> indicating the error."
2020 msgstr ""
2021
2022 #. type: Plain text
2023 #: build/C/man2/msgctl.2:255
2024 msgid "On failure, I<errno> is set to one of the following:"
2025 msgstr ""
2026
2027 #. type: Plain text
2028 #: build/C/man2/msgctl.2:268
2029 msgid ""
2030 "The argument I<cmd> is equal to B<IPC_STAT> or B<MSG_STAT>, but the calling "
2031 "process does not have read permission on the message queue I<msqid>, and "
2032 "does not have the B<CAP_IPC_OWNER> capability."
2033 msgstr ""
2034
2035 #. type: TP
2036 #: build/C/man2/msgctl.2:268 build/C/man2/msgop.2:320 build/C/man2/msgop.2:373
2037 #, no-wrap
2038 msgid "B<EFAULT>"
2039 msgstr ""
2040
2041 #. type: Plain text
2042 #: build/C/man2/msgctl.2:279
2043 msgid ""
2044 "The argument I<cmd> has the value B<IPC_SET> or B<IPC_STAT>, but the address "
2045 "pointed to by I<buf> isn't accessible."
2046 msgstr ""
2047
2048 #. type: TP
2049 #: build/C/man2/msgctl.2:279 build/C/man2/msgop.2:325 build/C/man2/msgop.2:378
2050 #, no-wrap
2051 msgid "B<EIDRM>"
2052 msgstr ""
2053
2054 #. type: Plain text
2055 #: build/C/man2/msgctl.2:282 build/C/man2/msgop.2:328
2056 msgid "The message queue was removed."
2057 msgstr ""
2058
2059 #. type: Plain text
2060 #: build/C/man2/msgctl.2:293
2061 msgid ""
2062 "Invalid value for I<cmd> or I<msqid>.  Or: for a B<MSG_STAT> operation, the "
2063 "index value specified in I<msqid> referred to an array slot that is "
2064 "currently unused."
2065 msgstr ""
2066
2067 #. type: TP
2068 #: build/C/man2/msgctl.2:293
2069 #, no-wrap
2070 msgid "B<EPERM>"
2071 msgstr ""
2072
2073 #. type: Plain text
2074 #: build/C/man2/msgctl.2:311
2075 msgid ""
2076 "The argument I<cmd> has the value B<IPC_SET> or B<IPC_RMID>, but the "
2077 "effective user ID of the calling process is not the creator (as found in "
2078 "I<msg_perm.cuid>)  or the owner (as found in I<msg_perm.uid>)  of the "
2079 "message queue, and the process is not privileged (Linux: it does not have "
2080 "the B<CAP_SYS_ADMIN> capability)."
2081 msgstr ""
2082
2083 #. type: Plain text
2084 #: build/C/man2/msgctl.2:314 build/C/man2/msgget.2:185 build/C/man2/msgop.2:401
2085 msgid "SVr4, POSIX.1-2001."
2086 msgstr ""
2087
2088 #.  Like Linux, the FreeBSD man pages still document
2089 #.  the inclusion of these header files.
2090 #. type: Plain text
2091 #: build/C/man2/msgctl.2:327 build/C/man2/msgget.2:198 build/C/man2/msgop.2:414
2092 msgid ""
2093 "The inclusion of I<E<lt>sys/types.hE<gt>> and I<E<lt>sys/ipc.hE<gt>> isn't "
2094 "required on Linux or by any version of POSIX.  However, some old "
2095 "implementations required the inclusion of these header files, and the SVID "
2096 "also documented their inclusion.  Applications intended to be portable to "
2097 "such old systems may need to include these header files."
2098 msgstr ""
2099
2100 #. type: Plain text
2101 #: build/C/man2/msgctl.2:338
2102 msgid ""
2103 "The B<IPC_INFO>, B<MSG_STAT> and B<MSG_INFO> operations are used by the "
2104 "B<ipcs>(1)  program to provide information on allocated resources.  In the "
2105 "future these may modified or moved to a /proc file system interface."
2106 msgstr ""
2107
2108 #. type: Plain text
2109 #: build/C/man2/msgctl.2:352
2110 msgid ""
2111 "Various fields in the I<struct msqid_ds> were typed as I<short> under Linux "
2112 "2.2 and have become I<long> under Linux 2.4.  To take advantage of this, a "
2113 "recompilation under glibc-2.1.91 or later should suffice.  (The kernel "
2114 "distinguishes old and new calls by an B<IPC_64> flag in I<cmd>.)"
2115 msgstr ""
2116
2117 #. type: Plain text
2118 #: build/C/man2/msgctl.2:359
2119 msgid ""
2120 "B<msgget>(2), B<msgrcv>(2), B<msgsnd>(2), B<capabilities>(7), "
2121 "B<mq_overview>(7), B<svipc>(7)"
2122 msgstr ""
2123
2124 #. type: TH
2125 #: build/C/man2/msgget.2:35
2126 #, no-wrap
2127 msgid "MSGGET"
2128 msgstr ""
2129
2130 #. type: Plain text
2131 #: build/C/man2/msgget.2:38
2132 msgid "msgget - get a message queue identifier"
2133 msgstr ""
2134
2135 #. type: Plain text
2136 #: build/C/man2/msgget.2:45
2137 #, no-wrap
2138 msgid "B<int msgget(key_t >I<key>B<, int >I<msgflg>B<);>\n"
2139 msgstr ""
2140
2141 #. type: Plain text
2142 #: build/C/man2/msgget.2:67
2143 msgid ""
2144 "The B<msgget>()  system call returns the message queue identifier associated "
2145 "with the value of the I<key> argument.  A new message queue is created if "
2146 "I<key> has the value B<IPC_PRIVATE> or I<key> isn't B<IPC_PRIVATE>, no "
2147 "message queue with the given key I<key> exists, and B<IPC_CREAT> is "
2148 "specified in I<msgflg>."
2149 msgstr ""
2150
2151 #. type: Plain text
2152 #: build/C/man2/msgget.2:86
2153 msgid ""
2154 "If I<msgflg> specifies both B<IPC_CREAT> and B<IPC_EXCL> and a message queue "
2155 "already exists for I<key>, then B<msgget>()  fails with I<errno> set to "
2156 "B<EEXIST>.  (This is analogous to the effect of the combination B<O_CREAT | "
2157 "O_EXCL> for B<open>(2).)"
2158 msgstr ""
2159
2160 #. type: Plain text
2161 #: build/C/man2/msgget.2:96
2162 msgid ""
2163 "Upon creation, the least significant bits of the argument I<msgflg> define "
2164 "the permissions of the message queue.  These permission bits have the same "
2165 "format and semantics as the permissions specified for the I<mode> argument "
2166 "of B<open>(2).  (The execute permissions are not used.)"
2167 msgstr ""
2168
2169 #. type: Plain text
2170 #: build/C/man2/msgget.2:103
2171 msgid ""
2172 "If a new message queue is created, then its associated data structure "
2173 "I<msqid_ds> (see B<msgctl>(2))  is initialized as follows:"
2174 msgstr ""
2175
2176 #. type: Plain text
2177 #: build/C/man2/msgget.2:108
2178 msgid ""
2179 "I<msg_perm.cuid> and I<msg_perm.uid> are set to the effective user ID of the "
2180 "calling process."
2181 msgstr ""
2182
2183 #. type: Plain text
2184 #: build/C/man2/msgget.2:113
2185 msgid ""
2186 "I<msg_perm.cgid> and I<msg_perm.gid> are set to the effective group ID of "
2187 "the calling process."
2188 msgstr ""
2189
2190 #. type: Plain text
2191 #: build/C/man2/msgget.2:118
2192 msgid ""
2193 "The least significant 9 bits of I<msg_perm.mode> are set to the least "
2194 "significant 9 bits of I<msgflg>."
2195 msgstr ""
2196
2197 #. type: Plain text
2198 #: build/C/man2/msgget.2:126
2199 msgid ""
2200 "I<msg_qnum>, I<msg_lspid>, I<msg_lrpid>, I<msg_stime> and I<msg_rtime> are "
2201 "set to 0."
2202 msgstr ""
2203
2204 #. type: Plain text
2205 #: build/C/man2/msgget.2:129
2206 msgid "I<msg_ctime> is set to the current time."
2207 msgstr ""
2208
2209 #. type: Plain text
2210 #: build/C/man2/msgget.2:133
2211 msgid "I<msg_qbytes> is set to the system limit B<MSGMNB>."
2212 msgstr ""
2213
2214 #. type: Plain text
2215 #: build/C/man2/msgget.2:137
2216 msgid ""
2217 "If the message queue already exists the permissions are verified, and a "
2218 "check is made to see if it is marked for destruction."
2219 msgstr ""
2220
2221 #. type: Plain text
2222 #: build/C/man2/msgget.2:143
2223 msgid ""
2224 "If successful, the return value will be the message queue identifier (a "
2225 "nonnegative integer), otherwise -1 with I<errno> indicating the error."
2226 msgstr ""
2227
2228 #. type: Plain text
2229 #: build/C/man2/msgget.2:147
2230 msgid "On failure, I<errno> is set to one of the following values:"
2231 msgstr ""
2232
2233 #. type: Plain text
2234 #: build/C/man2/msgget.2:155
2235 msgid ""
2236 "A message queue exists for I<key>, but the calling process does not have "
2237 "permission to access the queue, and does not have the B<CAP_IPC_OWNER> "
2238 "capability."
2239 msgstr ""
2240
2241 #. type: Plain text
2242 #: build/C/man2/msgget.2:165
2243 msgid ""
2244 "A message queue exists for I<key> and I<msgflg> specified both B<IPC_CREAT> "
2245 "and B<IPC_EXCL>."
2246 msgstr ""
2247
2248 #. type: Plain text
2249 #: build/C/man2/msgget.2:173
2250 msgid ""
2251 "No message queue exists for I<key> and I<msgflg> did not specify "
2252 "B<IPC_CREAT>."
2253 msgstr ""
2254
2255 #. type: Plain text
2256 #: build/C/man2/msgget.2:177
2257 msgid ""
2258 "A message queue has to be created but the system does not have enough memory "
2259 "for the new data structure."
2260 msgstr ""
2261
2262 #. type: Plain text
2263 #: build/C/man2/msgget.2:183
2264 msgid ""
2265 "A message queue has to be created but the system limit for the maximum "
2266 "number of message queues (B<MSGMNI>)  would be exceeded."
2267 msgstr ""
2268
2269 #. type: Plain text
2270 #: build/C/man2/msgget.2:208
2271 msgid ""
2272 "B<IPC_PRIVATE> isn't a flag field but a I<key_t> type.  If this special "
2273 "value is used for I<key>, the system call ignores everything but the least "
2274 "significant 9 bits of I<msgflg> and creates a new message queue (on "
2275 "success)."
2276 msgstr ""
2277
2278 #. type: Plain text
2279 #: build/C/man2/msgget.2:212
2280 msgid ""
2281 "The following is a system limit on message queue resources affecting a "
2282 "B<msgget>()  call:"
2283 msgstr ""
2284
2285 #. type: TP
2286 #: build/C/man2/msgget.2:212
2287 #, no-wrap
2288 msgid "B<MSGMNI>"
2289 msgstr ""
2290
2291 #. type: Plain text
2292 #: build/C/man2/msgget.2:218
2293 msgid ""
2294 "System wide maximum number of message queues: policy dependent (on Linux, "
2295 "this limit can be read and modified via I</proc/sys/kernel/msgmni>)."
2296 msgstr ""
2297
2298 #. type: SS
2299 #: build/C/man2/msgget.2:218
2300 #, no-wrap
2301 msgid "Linux notes"
2302 msgstr ""
2303
2304 #. type: Plain text
2305 #: build/C/man2/msgget.2:224
2306 msgid ""
2307 "Until version 2.3.20 Linux would return B<EIDRM> for a B<msgget>()  on a "
2308 "message queue scheduled for deletion."
2309 msgstr ""
2310
2311 #. type: Plain text
2312 #: build/C/man2/msgget.2:230
2313 msgid ""
2314 "The name choice B<IPC_PRIVATE> was perhaps unfortunate, B<IPC_NEW> would "
2315 "more clearly show its function."
2316 msgstr ""
2317
2318 #. type: Plain text
2319 #: build/C/man2/msgget.2:238
2320 msgid ""
2321 "B<msgctl>(2), B<msgrcv>(2), B<msgsnd>(2), B<ftok>(3), B<capabilities>(7), "
2322 "B<mq_overview>(7), B<svipc>(7)"
2323 msgstr ""
2324
2325 #. type: TH
2326 #: build/C/man2/msgop.2:40
2327 #, no-wrap
2328 msgid "MSGOP"
2329 msgstr ""
2330
2331 #. type: Plain text
2332 #: build/C/man2/msgop.2:43
2333 msgid "msgrcv, msgsnd - message operations"
2334 msgstr ""
2335
2336 #. type: Plain text
2337 #: build/C/man2/msgop.2:51
2338 #, no-wrap
2339 msgid ""
2340 "B<int msgsnd(int >I<msqid>B<, const void *>I<msgp>B<, size_t >I<msgsz>B<, "
2341 "int >I<msgflg>B<);>\n"
2342 msgstr ""
2343
2344 #. type: Plain text
2345 #: build/C/man2/msgop.2:55
2346 #, no-wrap
2347 msgid ""
2348 "B<ssize_t msgrcv(int >I<msqid>B<, void *>I<msgp>B<, size_t >I<msgsz>B<, long "
2349 ">I<msgtyp>B<,>\n"
2350 "B<               int >I<msgflg>B<);>\n"
2351 msgstr ""
2352
2353 #. type: Plain text
2354 #: build/C/man2/msgop.2:65
2355 msgid ""
2356 "The B<msgsnd>()  and B<msgrcv>()  system calls are used, respectively, to "
2357 "send messages to, and receive messages from, a message queue.  The calling "
2358 "process must have write permission on the message queue in order to send a "
2359 "message, and read permission to receive a message."
2360 msgstr ""
2361
2362 #. type: Plain text
2363 #: build/C/man2/msgop.2:70
2364 msgid ""
2365 "The I<msgp> argument is a pointer to caller-defined structure of the "
2366 "following general form:"
2367 msgstr ""
2368
2369 #. type: Plain text
2370 #: build/C/man2/msgop.2:77
2371 #, no-wrap
2372 msgid ""
2373 "struct msgbuf {\n"
2374 "    long mtype;       /* message type, must be E<gt> 0 */\n"
2375 "    char mtext[1];    /* message data */\n"
2376 "};\n"
2377 msgstr ""
2378
2379 #. type: Plain text
2380 #: build/C/man2/msgop.2:96
2381 msgid ""
2382 "The I<mtext> field is an array (or other structure) whose size is specified "
2383 "by I<msgsz>, a nonnegative integer value.  Messages of zero length (i.e., no "
2384 "I<mtext> field) are permitted.  The I<mtype> field must have a strictly "
2385 "positive integer value.  This value can be used by the receiving process for "
2386 "message selection (see the description of B<msgrcv>()  below)."
2387 msgstr ""
2388
2389 #. type: SS
2390 #: build/C/man2/msgop.2:96
2391 #, no-wrap
2392 msgid "msgsnd()"
2393 msgstr ""
2394
2395 #. type: Plain text
2396 #: build/C/man2/msgop.2:104
2397 msgid ""
2398 "The B<msgsnd>()  system call appends a copy of the message pointed to by "
2399 "I<msgp> to the message queue whose identifier is specified by I<msqid>."
2400 msgstr ""
2401
2402 #. type: Plain text
2403 #: build/C/man2/msgop.2:125
2404 msgid ""
2405 "If sufficient space is available in the queue, B<msgsnd>()  succeeds "
2406 "immediately.  (The queue capacity is defined by the I<msg_qbytes> field in "
2407 "the associated data structure for the message queue.  During queue creation "
2408 "this field is initialized to B<MSGMNB> bytes, but this limit can be modified "
2409 "using B<msgctl>(2).)  If insufficient space is available in the queue, then "
2410 "the default behavior of B<msgsnd>()  is to block until space becomes "
2411 "available.  If B<IPC_NOWAIT> is specified in I<msgflg>, then the call "
2412 "instead fails with the error B<EAGAIN>."
2413 msgstr ""
2414
2415 #. type: Plain text
2416 #: build/C/man2/msgop.2:129
2417 msgid "A blocked B<msgsnd>()  call may also fail if:"
2418 msgstr ""
2419
2420 #. type: IP
2421 #: build/C/man2/msgop.2:129 build/C/man2/msgop.2:136 build/C/man2/msgop.2:198 build/C/man2/msgop.2:203 build/C/man2/msgop.2:217 build/C/man2/msgop.2:256 build/C/man2/msgop.2:258 build/C/man2/msgop.2:264
2422 #, no-wrap
2423 msgid "*"
2424 msgstr ""
2425
2426 #. type: Plain text
2427 #: build/C/man2/msgop.2:136
2428 msgid ""
2429 "the queue is removed, in which case the system call fails with I<errno> set "
2430 "to B<EIDRM>; or"
2431 msgstr ""
2432
2433 #. type: Plain text
2434 #: build/C/man2/msgop.2:148
2435 msgid ""
2436 "a signal is caught, in which case the system call fails with I<errno> set to "
2437 "B<EINTR>;B<see> B<signal>(7).  (B<msgsnd>()  is never automatically "
2438 "restarted after being interrupted by a signal handler, regardless of the "
2439 "setting of the B<SA_RESTART> flag when establishing a signal handler.)"
2440 msgstr ""
2441
2442 #. type: Plain text
2443 #: build/C/man2/msgop.2:151 build/C/man2/msgop.2:278
2444 msgid ""
2445 "Upon successful completion the message queue data structure is updated as "
2446 "follows:"
2447 msgstr ""
2448
2449 #. type: Plain text
2450 #: build/C/man2/msgop.2:154
2451 msgid "I<msg_lspid> is set to the process ID of the calling process."
2452 msgstr ""
2453
2454 #. type: Plain text
2455 #: build/C/man2/msgop.2:157
2456 msgid "I<msg_qnum> is incremented by 1."
2457 msgstr ""
2458
2459 #. type: Plain text
2460 #: build/C/man2/msgop.2:160
2461 msgid "I<msg_stime> is set to the current time."
2462 msgstr ""
2463
2464 #. type: SS
2465 #: build/C/man2/msgop.2:160
2466 #, no-wrap
2467 msgid "msgrcv()"
2468 msgstr ""
2469
2470 #. type: Plain text
2471 #: build/C/man2/msgop.2:168
2472 msgid ""
2473 "The B<msgrcv>()  system call removes a message from the queue specified by "
2474 "I<msqid> and places it in the buffer pointed to by I<msgp>."
2475 msgstr ""
2476
2477 #. type: Plain text
2478 #: build/C/man2/msgop.2:194
2479 msgid ""
2480 "The argument I<msgsz> specifies the maximum size in bytes for the member "
2481 "I<mtext> of the structure pointed to by the I<msgp> argument.  If the "
2482 "message text has length greater than I<msgsz>, then the behavior depends on "
2483 "whether B<MSG_NOERROR> is specified in I<msgflg>.  If B<MSG_NOERROR> is "
2484 "specified, then the message text will be truncated (and the truncated part "
2485 "will be lost); if B<MSG_NOERROR> is not specified, then the message isn't "
2486 "removed from the queue and the system call fails returning -1 with I<errno> "
2487 "set to B<E2BIG>."
2488 msgstr ""
2489
2490 #. type: Plain text
2491 #: build/C/man2/msgop.2:198
2492 msgid "The argument I<msgtyp> specifies the type of message requested as follows:"
2493 msgstr ""
2494
2495 #. type: Plain text
2496 #: build/C/man2/msgop.2:203
2497 msgid "If I<msgtyp> is 0, then the first message in the queue is read."
2498 msgstr ""
2499
2500 #. type: Plain text
2501 #: build/C/man2/msgop.2:217
2502 msgid ""
2503 "If I<msgtyp> is greater than 0, then the first message in the queue of type "
2504 "I<msgtyp> is read, unless B<MSG_EXCEPT> was specified in I<msgflg>, in which "
2505 "case the first message in the queue of type not equal to I<msgtyp> will be "
2506 "read."
2507 msgstr ""
2508
2509 #. type: Plain text
2510 #: build/C/man2/msgop.2:225
2511 msgid ""
2512 "If I<msgtyp> is less than 0, then the first message in the queue with the "
2513 "lowest type less than or equal to the absolute value of I<msgtyp> will be "
2514 "read."
2515 msgstr ""
2516
2517 #. type: Plain text
2518 #: build/C/man2/msgop.2:230
2519 msgid ""
2520 "The I<msgflg> argument is a bit mask constructed by ORing together zero or "
2521 "more of the following flags:"
2522 msgstr ""
2523
2524 #. type: TP
2525 #: build/C/man2/msgop.2:230
2526 #, no-wrap
2527 msgid "B<IPC_NOWAIT>"
2528 msgstr ""
2529
2530 #. type: Plain text
2531 #: build/C/man2/msgop.2:237
2532 msgid ""
2533 "Return immediately if no message of the requested type is in the queue.  The "
2534 "system call fails with I<errno> set to B<ENOMSG>."
2535 msgstr ""
2536
2537 #. type: TP
2538 #: build/C/man2/msgop.2:237
2539 #, no-wrap
2540 msgid "B<MSG_EXCEPT>"
2541 msgstr ""
2542
2543 #. type: Plain text
2544 #: build/C/man2/msgop.2:245
2545 msgid ""
2546 "Used with I<msgtyp> greater than 0 to read the first message in the queue "
2547 "with message type that differs from I<msgtyp>."
2548 msgstr ""
2549
2550 #. type: TP
2551 #: build/C/man2/msgop.2:245
2552 #, no-wrap
2553 msgid "B<MSG_NOERROR>"
2554 msgstr ""
2555
2556 #. type: Plain text
2557 #: build/C/man2/msgop.2:250
2558 msgid "To truncate the message text if longer than I<msgsz> bytes."
2559 msgstr ""
2560
2561 #. type: Plain text
2562 #: build/C/man2/msgop.2:256
2563 msgid ""
2564 "If no message of the requested type is available and B<IPC_NOWAIT> isn't "
2565 "specified in I<msgflg>, the calling process is blocked until one of the "
2566 "following conditions occurs:"
2567 msgstr ""
2568
2569 #. type: Plain text
2570 #: build/C/man2/msgop.2:258
2571 msgid "A message of the desired type is placed in the queue."
2572 msgstr ""
2573
2574 #. type: Plain text
2575 #: build/C/man2/msgop.2:264
2576 msgid ""
2577 "The message queue is removed from the system.  In this case the system call "
2578 "fails with I<errno> set to B<EIDRM>."
2579 msgstr ""
2580
2581 #. type: Plain text
2582 #: build/C/man2/msgop.2:275
2583 msgid ""
2584 "The calling process catches a signal.  In this case the system call fails "
2585 "with I<errno> set to B<EINTR>.  (B<msgrcv>()  is never automatically "
2586 "restarted after being interrupted by a signal handler, regardless of the "
2587 "setting of the B<SA_RESTART> flag when establishing a signal handler.)"
2588 msgstr ""
2589
2590 #. type: Plain text
2591 #: build/C/man2/msgop.2:281
2592 msgid "I<msg_lrpid> is set to the process ID of the calling process."
2593 msgstr ""
2594
2595 #. type: Plain text
2596 #: build/C/man2/msgop.2:284
2597 msgid "I<msg_qnum> is decremented by 1."
2598 msgstr ""
2599
2600 #. type: Plain text
2601 #: build/C/man2/msgop.2:287
2602 msgid "I<msg_rtime> is set to the current time."
2603 msgstr ""
2604
2605 #. type: Plain text
2606 #: build/C/man2/msgop.2:300
2607 msgid ""
2608 "On failure both functions return -1 with I<errno> indicating the error, "
2609 "otherwise B<msgsnd>()  returns 0 and B<msgrcv>()  returns the number of "
2610 "bytes actually copied into the I<mtext> array."
2611 msgstr ""
2612
2613 #. type: Plain text
2614 #: build/C/man2/msgop.2:306
2615 msgid ""
2616 "When B<msgsnd>()  fails, I<errno> will be set to one among the following "
2617 "values:"
2618 msgstr ""
2619
2620 #. type: Plain text
2621 #: build/C/man2/msgop.2:312
2622 msgid ""
2623 "The calling process does not have write permission on the message queue, and "
2624 "does not have the B<CAP_IPC_OWNER> capability."
2625 msgstr ""
2626
2627 #. type: Plain text
2628 #: build/C/man2/msgop.2:320
2629 msgid ""
2630 "The message can't be sent due to the I<msg_qbytes> limit for the queue and "
2631 "B<IPC_NOWAIT> was specified in I<msgflg>."
2632 msgstr ""
2633
2634 #. type: Plain text
2635 #: build/C/man2/msgop.2:325 build/C/man2/msgop.2:378
2636 msgid "The address pointed to by I<msgp> isn't accessible."
2637 msgstr ""
2638
2639 #. type: Plain text
2640 #: build/C/man2/msgop.2:331
2641 msgid "Sleeping on a full message queue condition, the process caught a signal."
2642 msgstr ""
2643
2644 #. type: Plain text
2645 #: build/C/man2/msgop.2:342
2646 msgid ""
2647 "Invalid I<msqid> value, or nonpositive I<mtype> value, or invalid I<msgsz> "
2648 "value (less than 0 or greater than the system value B<MSGMAX>)."
2649 msgstr ""
2650
2651 #. type: Plain text
2652 #: build/C/man2/msgop.2:347
2653 msgid ""
2654 "The system does not have enough memory to make a copy of the message pointed "
2655 "to by I<msgp>."
2656 msgstr ""
2657
2658 #. type: Plain text
2659 #: build/C/man2/msgop.2:353
2660 msgid ""
2661 "When B<msgrcv>()  fails, I<errno> will be set to one among the following "
2662 "values:"
2663 msgstr ""
2664
2665 #. type: TP
2666 #: build/C/man2/msgop.2:353
2667 #, no-wrap
2668 msgid "B<E2BIG>"
2669 msgstr ""
2670
2671 #. type: Plain text
2672 #: build/C/man2/msgop.2:361
2673 msgid ""
2674 "The message text length is greater than I<msgsz> and B<MSG_NOERROR> isn't "
2675 "specified in I<msgflg>."
2676 msgstr ""
2677
2678 #. type: Plain text
2679 #: build/C/man2/msgop.2:367
2680 msgid ""
2681 "The calling process does not have read permission on the message queue, and "
2682 "does not have the B<CAP_IPC_OWNER> capability."
2683 msgstr ""
2684
2685 #. type: Plain text
2686 #: build/C/man2/msgop.2:373
2687 msgid ""
2688 "No message was available in the queue and B<IPC_NOWAIT> was specified in "
2689 "I<msgflg>."
2690 msgstr ""
2691
2692 #. type: Plain text
2693 #: build/C/man2/msgop.2:382
2694 msgid ""
2695 "While the process was sleeping to receive a message, the message queue was "
2696 "removed."
2697 msgstr ""
2698
2699 #. type: Plain text
2700 #: build/C/man2/msgop.2:387
2701 msgid ""
2702 "While the process was sleeping to receive a message, the process caught a "
2703 "signal; see B<signal>(7)."
2704 msgstr ""
2705
2706 #. type: Plain text
2707 #: build/C/man2/msgop.2:393
2708 msgid "I<msgqid> was invalid, or I<msgsz> was less than 0."
2709 msgstr ""
2710
2711 #. type: TP
2712 #: build/C/man2/msgop.2:393
2713 #, no-wrap
2714 msgid "B<ENOMSG>"
2715 msgstr ""
2716
2717 #. type: Plain text
2718 #: build/C/man2/msgop.2:399
2719 msgid ""
2720 "B<IPC_NOWAIT> was specified in I<msgflg> and no message of the requested "
2721 "type existed on the message queue."
2722 msgstr ""
2723
2724 #. type: Plain text
2725 #: build/C/man2/msgop.2:421
2726 msgid ""
2727 "The I<msgp> argument is declared as I<struct msgbuf *> with libc4, libc5, "
2728 "glibc 2.0, glibc 2.1.  It is declared as I<void *> with glibc 2.2 and later, "
2729 "as required by SUSv2 and SUSv3."
2730 msgstr ""
2731
2732 #. type: Plain text
2733 #: build/C/man2/msgop.2:425
2734 msgid ""
2735 "The following limits on message queue resources affect the B<msgsnd>()  "
2736 "call:"
2737 msgstr ""
2738
2739 #. type: TP
2740 #: build/C/man2/msgop.2:425
2741 #, no-wrap
2742 msgid "B<MSGMAX>"
2743 msgstr ""
2744
2745 #. type: Plain text
2746 #: build/C/man2/msgop.2:430
2747 msgid ""
2748 "Maximum size for a message text: 8192 bytes (on Linux, this limit can be "
2749 "read and modified via I</proc/sys/kernel/msgmax>)."
2750 msgstr ""
2751
2752 #. type: TP
2753 #: build/C/man2/msgop.2:430
2754 #, no-wrap
2755 msgid "B<MSGMNB>"
2756 msgstr ""
2757
2758 #. type: Plain text
2759 #: build/C/man2/msgop.2:440
2760 msgid ""
2761 "Default maximum size in bytes of a message queue: 16384 bytes (on Linux, "
2762 "this limit can be read and modified via I</proc/sys/kernel/msgmnb>).  The "
2763 "superuser can increase the size of a message queue beyond B<MSGMNB> by a "
2764 "B<msgctl>(2)  system call."
2765 msgstr ""
2766
2767 #. type: Plain text
2768 #: build/C/man2/msgop.2:446
2769 msgid ""
2770 "The implementation has no intrinsic limits for the system wide maximum "
2771 "number of message headers (B<MSGTQL>)  and for the system wide maximum size "
2772 "in bytes of the message pool (B<MSGPOOL>)."
2773 msgstr ""
2774
2775 #. type: Plain text
2776 #: build/C/man2/msgop.2:452
2777 msgid ""
2778 "B<msgctl>(2), B<msgget>(2), B<capabilities>(7), B<mq_overview>(7), "
2779 "B<svipc>(7)"
2780 msgstr ""