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 SunOS 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]
Copyright 1989 AT&T
Portions Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
#include <mqueue.h> int mq_notify(mqd_t mqdes, const struct sigevent *notification);
The mq_notify() function provides an asynchronous mechanism for processes to receive notice that messages are available in a message queue, rather than synchronously blocking (waiting) in mq_receive(3C).
If notification is not NULL, this function registers the calling process to be notified of message arrival at an empty message queue associated with the message queue descriptor, mqdes. The notification specified by notification will be sent to the process when the message queue transitions from empty to non-empty. See signal.h(3HEAD). At any time, only one process may be registered for notification by a specific message queue. If the calling process or any other process has already registered for notification of message arrival at the specified message queue, subsequent attempts to register for that message queue will fail.
If notification is NULL and the process is currently registered for notification by the specified message queue, the existing registration is removed. The message queue is then available for future registration.
When the notification is sent to the registered process, its registration is removed. The message queue is then available for registration.
If a process has registered for notification of message arrival at a message queue and some processes is blocked in mq_receive(3C) waiting to receive a message when a message arrives at the queue, the arriving message will be received by the appropriate mq_receive(3C), and no notification will be sent to the registered process. The resulting behavior is as if the message queue remains empty, and this notification will not be sent until the next arrival of a message at this queue.
Any notification registration is removed if the calling process either closes the message queue or exits.
Upon successful completion, mq_notify() returns 0; otherwise, it returns -1 and sets errno to indicate the error.
The mq_notify() function will fail if: EBADF
The mqdes argument is not a valid message queue descriptor.
A process is already registered for notification by the message queue.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability Committed |
| MT-Level MT-Safe |
| Standard See standards(5). |
mq_close(3C), mq_open(3C), mq_receive(3C), mq_send(3C), mqueue.h(3HEAD), siginfo.h(3HEAD), signal.h(3HEAD), attributes(5), standards(5)