#include <sys/msg.h>
ssize_t msgrcv(int msqid, void *msgp, size_t
msgsz, long
msgtyp,
int msgflg);
The msgrcv() function operates on XSI message queues (see the Base Definitions volume of IEEE Std 1003.1-2001, Section 3.224, Message Queue). It is unspecified whether this function interoperates with the realtime interprocess communication facilities defined in Realtime .
The msgrcv() function shall read a message from the queue associated with the message queue identifier specified by msqid and place it in the user-defined buffer pointed to by msgp.
The application shall ensure that the argument msgp points to a user-defined buffer that contains first a field of type long specifying the type of the message, and then a data portion that holds the data bytes of the message. The structure below is an example of what this user-defined buffer might look like:
struct mymsg {
long mtype; /* Message type. */
char mtext[1]; /* Message text. */
}
The structure member mtype is the received message's type as specified by the sending process.
The structure member mtext is the text of the message.
The argument msgsz specifies the size in bytes of mtext. The received message shall be truncated to msgsz bytes if it is larger than msgsz and (msgflg & MSG_NOERROR) is non-zero. The truncated part of the message shall be lost and no indication of the truncation shall be given to the calling process.
If the value of msgsz is greater than {SSIZE_MAX}, the result is implementation-defined.
The argument msgtyp specifies the type of message requested as follows:
The argument msgflg specifies the action to be taken if a message of the desired type is not on the queue. These are as follows:
Upon successful completion, the following actions are taken with respect to the data structure associated with msqid:
Upon successful completion, msgrcv() shall return a value equal to the number of bytes actually placed into the buffer mtext. Otherwise, no message shall be received, msgrcv() shall return (ssize_t)-1, and errno shall be set to indicate the error.
The msgrcv() function shall fail if:
The following sections are informative.
The following example receives the first message on the queue (based on the value of the msgtyp argument, 0). The queue is identified by the msqid argument (assuming that the value has previously been set). This call specifies that an error should be reported if no message is available, but not if the message is too large. The message size is calculated directly using the sizeof operator.
#include <sys/msg.h>
...
int result;
int msqid;
struct message {
long type;
char text[20];
} msg;
long msgtyp = 0;
...
result = msgrcv(msqid, (void *) &msg, sizeof(msg.text),
msgtyp, MSG_NOERROR | IPC_NOWAIT);
The POSIX Realtime Extension defines alternative interfaces for interprocess communication (IPC). Application developers who need to use IPC should design their applications so that modules using the IPC routines described in XSI Interprocess Communication can be easily modified to use the alternative interfaces.
XSI Interprocess Communication , Realtime , mq_close() , mq_getattr() , mq_notify() , mq_open() , mq_receive() , mq_send() , mq_setattr() , mq_unlink() , msgctl() , msgget() , msgsnd() , sigaction() , the Base Definitions volume of IEEE Std 1003.1-2001, <sys/msg.h>