.\".\" Copyright (C) 1997 Jerry Epplin.  All rights reserved..\".\" Permission is granted to make and distribute verbatim copies of this.\" manual provided the copyright notice and this permission notice are.\" preserved on all copies..\".\" Permission is granted to copy and distribute modified versions of this.\" manual under the conditions for verbatim copying, provided that the.\" entire resulting derived work is distributed under the terms of a.\" permission notice identical to this one.\" .\" The author assumes no responsibility for errors or omissions, or for.\" damages resulting from the use of the information contained herein..\" .\" Formatted or processed versions of this manual, if unaccompanied by.\" the source, must acknowledge the copyright and authors of this work..\".TH RT_MQ_RECEIVE 2 "26 July 1997" "rt_ipc" "rt_ipc".SH NAMErt_mq_receive \- message queue 'receive' operation.SH SYNOPSIS.nf.B #define MODULE.B #include <linux/module.h> .B #include <linux/kernel.h> .B #include <linux/version.h> .B #include <linux/errno.h> .B #include "rt_ipc.h".fi.sp.BI "int rt_mq_receive(rt_mq_t *" mq ", char *" msg ", RTIME " wait ");.SH DESCRIPTION.B rt_mq_receivedequeues the data.I msgfrom the message queue.IR mq .The data will be of the size with which.B rt_mq_initwas called.An optional timeout can be specified.  If .I waitis RT_WAIT_FOREVER, the function does not time out.  If.I waitis RT_NO_WAIT and the semaphore is not available,.B rt_mq_receivereturns immediately.  If.I waitis any other value, it represent a time at which the call to.B rt_mq_receiveshould time out.  If that time is reached,.B rt_mq_receivereturns with -ETIME..SH "RETURN VALUE"On success, 0 is returned.  On failure, a negative value is returnedas described below..SH ERRORS.IP \fB-ETIME\fPThe timeout period expired..IP \fB-EAGAIN\fP.I waitwas RT_NO_WAIT, and no data was available for dequeueing..IP \fB-EINVAL\fP.I mqdoes not point to a valid rt_mq_t..SH "AUTHOR"Jerry Epplin <JerryEpplin@worldnet.att.net>.SH "SEE ALSO".BR rt_mq_destroy (2),.BR rt_mq_init (2),.BR rt_mq_send (2),.BR rt_task_ipc_delete (2), .BR rt_task_ipc_init (2)