.TH "mqueue" 3teegris "Sun Oct 28 2018" "Version 2.0" "Samsung Internal API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mqueue \- Message queue library API
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBMQ_MAX_NAME\fP   1024"
.br
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef int \fBmqd_t\fP"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBmqd_t\fP \fBmq_open\fP (const char *pathname, int flags,\&.\&.\&.)"
.br
.RI "\fICreate new message queue or open an existing queue\&. \fP"
.ti -1c
.RI "int \fBmq_unlink\fP (const char *pathname)"
.br
.RI "\fIRemove specified message queue name\&. \fP"
.ti -1c
.RI "int \fBmq_close\fP (\fBmqd_t\fP fd)"
.br
.RI "\fIClose a message queue descriptor\&. \fP"
.ti -1c
.RI "int \fBmq_send\fP (\fBmqd_t\fP fd, const char *msg_ptr, size_t msg_len, unsigned msg_prio)"
.br
.RI "\fISend a message to a message queue\&. \fP"
.ti -1c
.RI "\fBssize_t\fP \fBmq_receive\fP (\fBmqd_t\fP fd, char *msg_ptr, size_t msg_len, unsigned *msg_prio)"
.br
.RI "\fIReceive a message from a message queue\&. \fP"
.in -1c
.SH "Detailed Description"
.PP 

.SH "Macro Definition Documentation"
.PP 
.SS "#define MQ_MAX_NAME   1024"

.PP
\fC#include <\fBmqueue\&.h\fP>\fPmax length of the mq name 
.SH "Typedef Documentation"
.PP 
.SS "\fBmqd_t\fP"

.PP
\fC#include <\fBmqueue\&.h\fP>\fPtype for message queue functions 
.SH "Function Documentation"
.PP 
.SS "int mq_close (\fBmqd_t\fP fd)"

.PP
\fC#include <\fBmqueue\&.h\fP>\fP
.PP
Close a message queue descriptor\&. 
.PP
\fBParameters:\fP
.RS 4
\fIfd\fP message queue descriptor 
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success 
.PP
-1 with errno on error 
.RE
.PP

.SS "\fBmqd_t\fP mq_open (const char * pathname, int flags,  \&.\&.\&.)"

.PP
\fC#include <\fBmqueue\&.h\fP>\fP
.PP
Create new message queue or open an existing queue\&. 
.PP
\fBParameters:\fP
.RS 4
\fIpathname\fP mqueue identifier 
.br
\fIflags\fP control flags 
.RE
.PP
\fBReturns:\fP
.RS 4
message queue descriptor on success 
.PP
-1 with errno on error 
.RE
.PP

.SS "\fBssize_t\fP mq_receive (\fBmqd_t\fP fd, char * msg_ptr, size_t msg_len, unsigned * msg_prio)"

.PP
\fC#include <\fBmqueue\&.h\fP>\fP
.PP
Receive a message from a message queue\&. 
.PP
\fBParameters:\fP
.RS 4
\fIfd\fP message queue descriptor 
.br
\fImsg_ptr\fP message pointer 
.br
\fImsg_len\fP length of the message 
.br
\fImsg_prio\fP priority of the message 
.RE
.PP
\fBReturns:\fP
.RS 4
number of bytes in the received message on success 
.PP
-1 with errno on error 
.RE
.PP

.SS "int mq_send (\fBmqd_t\fP fd, const char * msg_ptr, size_t msg_len, unsigned msg_prio)"

.PP
\fC#include <\fBmqueue\&.h\fP>\fP
.PP
Send a message to a message queue\&. 
.PP
\fBParameters:\fP
.RS 4
\fIfd\fP message queue descriptor 
.br
\fImsg_ptr\fP message pointer 
.br
\fImsg_len\fP length of the message 
.br
\fImsg_prio\fP priority of the message 
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success 
.PP
-1 with errno on error 
.RE
.PP

.SS "int mq_unlink (const char * pathname)"

.PP
\fC#include <\fBmqueue\&.h\fP>\fP
.PP
Remove specified message queue name\&. 
.PP
\fBParameters:\fP
.RS 4
\fIpathname\fP name of the path 
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success 
.PP
-1 with errno on error 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for Samsung Internal API reference from the source code\&.
