1MSGGET(3P)                 POSIX Programmer's Manual                MSGGET(3P)
2
3
4

PROLOG

6       This  manual  page is part of the POSIX Programmer's Manual.  The Linux
7       implementation of this interface may differ (consult the  corresponding
8       Linux  manual page for details of Linux behavior), or the interface may
9       not be implemented on Linux.
10

NAME

12       msgget - get the XSI message queue identifier
13

SYNOPSIS

15       #include <sys/msg.h>
16
17       int msgget(key_t key, int msgflg);
18
19

DESCRIPTION

21       The msgget() function operates on XSI message queues (see the Base Def‐
22       initions volume of IEEE Std 1003.1-2001, Section 3.224, Message Queue).
23       It is unspecified whether this function interoperates with the realtime
24       interprocess communication facilities defined in Realtime .
25
26       The msgget() function shall return the message queue identifier associ‐
27       ated with the argument key.
28
29       A message queue identifier, associated message queue, and  data  struc‐
30       ture (see <sys/msg.h>), shall be created for the argument key if one of
31       the following is true:
32
33        * The argument key is equal to IPC_PRIVATE.
34
35        * The argument key does not already have a  message  queue  identifier
36          associated with it, and (msgflg & IPC_CREAT) is non-zero.
37
38       Upon creation, the data structure associated with the new message queue
39       identifier shall be initialized as follows:
40
41        * msg_perm.cuid, msg_perm.uid, msg_perm.cgid, and  msg_perm.gid  shall
42          be  set  equal  to  the  effective  user  ID and effective group ID,
43          respectively, of the calling process.
44
45        * The low-order 9 bits of msg_perm.mode shall be set equal to the low-
46          order 9 bits of msgflg.
47
48        * msg_qnum,  msg_lspid,  msg_lrpid,  msg_stime, and msg_rtime shall be
49          set equal to 0.
50
51        * msg_ctime shall be set equal to the current time.
52
53        * msg_qbytes shall be set equal to the system limit.
54

RETURN VALUE

56       Upon successful completion, msgget() shall return a non-negative  inte‐
57       ger,  namely  a message queue identifier. Otherwise, it shall return -1
58       and set errno to indicate the error.
59

ERRORS

61       The msgget() function shall fail if:
62
63       EACCES A message queue identifier exists  for  the  argument  key,  but
64              operation  permission  as  specified  by the low-order 9 bits of
65              msgflg would not be granted; see XSI Interprocess  Communication
66              .
67
68       EEXIST A  message  queue  identifier  exists  for  the argument key but
69              ((msgflg & IPC_CREAT) && (msgflg & IPC_EXCL)) is non-zero.
70
71       ENOENT A message queue identifier does not exist for the  argument  key
72              and (msgflg & IPC_CREAT) is 0.
73
74       ENOSPC A  message  queue  identifier  is  to be created but the system-
75              imposed limit on the maximum number  of  allowed  message  queue
76              identifiers system-wide would be exceeded.
77
78
79       The following sections are informative.
80

EXAMPLES

82       None.
83

APPLICATION USAGE

85       The  POSIX Realtime Extension defines alternative interfaces for inter‐
86       process communication (IPC). Application developers who need to use IPC
87       should design their applications so that modules using the IPC routines
88       described in XSI Interprocess Communication can be easily  modified  to
89       use the alternative interfaces.
90

RATIONALE

92       None.
93

FUTURE DIRECTIONS

95       None.
96

SEE ALSO

98       XSI  Interprocess  Communication,  Realtime,  mq_close(), mq_getattr(),
99       mq_notify(),   mq_open(),   mq_receive(),   mq_send(),    mq_setattr(),
100       mq_unlink(),  msgctl(), msgrcv(), msgsnd(), the Base Definitions volume
101       of IEEE Std 1003.1-2001, <sys/msg.h>
102

104       Portions of this text are reprinted and reproduced in  electronic  form
105       from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
106       -- Portable Operating System Interface (POSIX),  The  Open  Group  Base
107       Specifications  Issue  6,  Copyright  (C) 2001-2003 by the Institute of
108       Electrical and Electronics Engineers, Inc and The Open  Group.  In  the
109       event of any discrepancy between this version and the original IEEE and
110       The Open Group Standard, the original IEEE and The Open Group  Standard
111       is  the  referee document. The original Standard can be obtained online
112       at http://www.opengroup.org/unix/online.html .
113
114
115
116IEEE/The Open Group                  2003                           MSGGET(3P)
Impressum