Manpage of MQ_OPEN

MQ_OPEN

Section: Linux Programmer's Manual (3)
Updated: 2015-12-28
Index
 

NAME

mq_open - open a message queue  

SYNOPSIS

#include <fcntl.h>           /* For O_* constants */
#include <sys/stat.h>        /* For mode constants */
#include <mqueue.h>mqd_t mq_open(const char *name, int oflag);mqd_t mq_open(const char *name, int oflag, mode_t mode,              struct mq_attr *attr);

Link with -lrt.  

DESCRIPTION

mq_open() creates a new POSIX message queue or opens an existing queue. The queue is identified by name. For details of the construction of name, see mq_overview(7).

The oflagargument specifies flags that control the operation of the call. (Definitions of the flags values can be obtained by including <fcntl.h>.) Exactly one of the following must be specified in oflag:

O_RDONLY
Open the queue to receive messages only.
O_WRONLY
Open the queue to send messages only.
O_RDWR
Open the queue to both send and receive messages.

Zero or more of the following flags can additionally be ORed in oflag:

O_CLOEXEC (since Linux 2.6.26)
Set the close-on-exec flag for the message queue descriptor. See open(2) for a discussion of why this flag is useful.
O_CREAT
Create the message queue if it does not exist. The owner (user ID) of the message queue is set to the effective user ID of the calling process. The group ownership (group ID) is set to the effective group ID of the calling process.
O_EXCL
If O_CREATwas specified in oflag, and a queue with the given namealready exists, then fail with the error EEXIST.
O_NONBLOCK
Open the queue in nonblocking mode. In circumstances where mq_receive(3) and mq_send(3) would normally block, these functions instead fail with the error EAGAIN.

If O_CREATis specified in oflag, then two additional arguments must be supplied. The modeargument specifies the permissions to be placed on the new queue, as for open(2). (Symbolic definitions for the permissions bits can be obtained by including <sys/stat.h>.) The permissions settings are masked against the process umask.

The attrargument specifies attributes for the queue. See mq_getattr(3) for details. If attris NULL, then the queue is created with implementation-defined default attributes. Since Linux 3.5, two /procfiles can be used to control these defaults; see mq_overview(7) for details.  

RETURN VALUE

On success, mq_open() returns a message queue descriptor for use by other message queue functions. On error, mq_open() returns (mqd_t) -1,with errnoset to indicate the error.  

ERRORS

EACCES
The queue exists, but the caller does not have permission to open it in the specified mode.
EACCES
namecontained more than one slash.
EEXIST
Both O_CREATand O_EXCLwere specified in oflag, but a queue with this namealready exists.
EINVAL
namedoesn't follow the format in mq_overview(7).
EINVAL
O_CREATwas specified in oflag, and attrwas not NULL, but attr->mq_maxmsgor attr->mq_msqsizewas invalid. Both of these fields must be greater than zero. In a process that is unprivileged (does not have the CAP_SYS_RESOURCEcapability), attr->mq_maxmsgmust be less than or equal to the msg_maxlimit, and attr->mq_msgsizemust be less than or equal to the msgsize_maxlimit. In addition, even in a privileged process, attr->mq_maxmsgcannot exceed the HARD_MAXlimit. (See mq_overview(7) for details of these limits.)
EMFILE
The per-process limit on the number of open file and message queue descriptors has been reached (see the description of RLIMIT_NOFILEin getrlimit(2)).
ENAMETOOLONG
namewas too long.
ENFILE
The system-wide limit on the total number of open files and message queues has been reached.
ENOENT
The O_CREATflag was not specified in oflag, and no queue with this nameexists.
ENOENT
namewas just "/" followed by no other characters.
ENOMEM
Insufficient memory.
ENOSPC
Insufficient space for the creation of a new message queue. This probably occurred because the queues_maxlimit was encountered; see mq_overview(7).
 

ATTRIBUTES

For an explanation of the terms used in this section, see attributes(7).
InterfaceAttributeValue
mq_open() Thread safetyMT-Safe
 

CONFORMING TO

POSIX.1-2001, POSIX.1-2008.  

NOTES

 

C library/kernel differences

The mq_open() library function is implemented on top of a system call of the same name. The library function performs the check that the namestarts with a slash (/), giving the EINVALerror if it does not. The kernel system call expects nameto contain no preceding slash, so the C library function passes namewithout the preceding slash (i.e., name+1) to the system call.  

BUGS

In kernels before 2.6.14, the process umask was not applied to the permissions specified in mode.  

SEE ALSO

mq_close(3), mq_getattr(3), mq_notify(3), mq_receive(3), mq_send(3), mq_unlink(3), mq_overview(7)


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
ERRORS
ATTRIBUTES
CONFORMING TO
NOTES
C library/kernel differences
BUGS
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 16:30:07 GMT, October 09, 2016 Click Here!