Copyright 1989 AT&T @(#)msgrcv.2 1.33 98/05/12 Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
#include <sys/msg.h> ssize_t msgrcv(int msqid, void *msgp, size_t msgsz, long int msgtyp, int msgflg);
The msgrcv() function reads a message from the queue associated with the message queue identifier specified by msqid and places it in the user-defined buffer pointed to by msgp.
The msgp argument points to a user-defined buffer that must contain first a field of type long int that will specify the type of the message, and then a data portion that will hold the data bytes of the message. The structure below is an example of what this user-defined buffer might look like:
struct mymsg {
long int mtype; /* message type */
char mtext[1]; /* message text */
}
The mtype member is the received message's type as specified by the sending process.
The mtext member is the text of the message.
The msgsz argument specifies the size in bytes of mtext. The received message is truncated to msgsz bytes if it is larger than msgsz and (msgflg&MSG_NOERROR) is non-zero. The truncated part of the message is lost and no indication of the truncation is given to the calling process.
The msgtyp argument specifies the type of message requested as follows:
If msgtyp is 0, the first message on the queue is received.
If msgtyp is greater than 0, the first message of type msgtyp is received.
If msgtyp is less than 0, the first message of the lowest type that is less than or equal to the absolute value of msgtyp is received.
The msgflg argument specifies which of the following actions is to be taken if a message of the desired type is not on the queue:
If (msgflg&IPC_NOWAIT) is non-zero, the calling process will return immediately with a return value of -1 and errno set to ENOMSG.
If (msgflg&IPC_NOWAIT) is 0, the calling process will suspend execution until one of the following occurs:
A message of the desired type is placed on the queue.
The message queue identifier msqid is removed from the system (see msgctl(2)); when this occurs, errno is set equal to EIDRM and -1 is returned.
The calling process receives a signal that is to be caught; in this case a message is not received and the calling process resumes execution in the manner prescribed in sigaction(2).
Upon successful completion, the following actions are taken with respect to the data structure associated with msqid (see Intro(2)):
msg_qnum is decremented by 1.
msg_lrpid is set equal to the process ID of the calling process.
msg_rtime is set equal to the current time.
Upon successful completion, msgrcv() returns a value equal to the number of bytes actually placed into the buffer mtext. Otherwise, -1 is returned, no message is received, and errno is set to indicate the error.
The msgrcv() function will fail if: E2BIG
The value of mtext is greater than msgsz and (msgflg&MSG_NOERROR) is 0.
Operation permission is denied to the calling process. See Intro(2).
The message queue identifier msqid is removed from the system.
The msgrcv() function was interrupted by a signal.
The msqid argument is not a valid message queue identifier.
The queue does not contain a message of the desired type and (msgflg&IPC_NOWAIT) is non-zero.
The msgrcv() function may fail if: EFAULT
The msgp argument points to an illegal address.
The value passed as the msgp argument should be converted to type void *.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability Standard |
Intro(2), msgctl(2), msgget(2), msgsnd(2), sigaction(2), attributes(5), standards(5)