usr/src/man/man3c/mq_send.3c

   1 '\" te
   2 .\" Copyright (c) 2014, Ryan Zezeski.
   3 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   4 .\" Copyright 1989 AT&T
   5 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
   6 .\" 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
   7 .\" http://www.opengroup.org/bookstore/.
   8 .\" 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.
   9 .\"  This notice shall appear on any product containing this material.
  10 .\" 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.
  11 .\" 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.
  12 .\" 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]
  13 .TH MQ_SEND 3C "Oct 23, 2014"
  14 .SH NAME
  15 mq_send, mq_timedsend, mq_reltimedsend_np \- send a message to a message queue
  16 .SH SYNOPSIS
  17 .LP
  18 .nf
  19 #include <mqueue.h>
  20
  21 \fBint\fR \fBmq_send\fR(\fBmqd_t\fR \fImqdes\fR, \fBconst char *\fR\fImsg_ptr\fR, \fBsize_t\fR \fImsg_len\fR,
  22      \fBunsigned\fR \fImsg_prio\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 #include <mqueue.h>
  28 #include <time.h>
  29
  30 \fBint\fR \fBmq_timedsend\fR(\fBmqd_t\fR \fImqdes\fR, \fBconst char *\fR\fImsg_ptr\fR,
  31      \fBsize_t\fR \fImsg_len\fR, \fBunsigned\fR \fImsg_prio\fR,
  32      \fBconst struct timespec *restrict\fR \fIabs_timeout\fR);
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBint\fR \fBmq_reltimedsend_np\fR(\fBmqd_t\fR \fImqdes\fR, \fBconst char *\fR\fImsg_ptr\fR,
  38      \fBsize_t\fR \fImsg_len\fR, \fBunsigned\fR \fImsg_prio\fR,
  39      \fBconst struct timespec *restrict\fR \fIrel_timeout\fR);
  40 .fi
  41
  42 .SH DESCRIPTION
  43 .LP
  44 The \fBmq_send()\fR function adds the message pointed to by the argument
  45 \fImsg_ptr\fR to the message queue specified by \fImqdes\fR. The \fImsg_len\fR
  46 argument specifies the length of the message in bytes pointed to by
  47 \fImsg_ptr\fR. The value of \fImsg_len\fR is less than or equal to the
  48 \fImq_msgsize\fR attribute of the message queue, or \fBmq_send()\fR fails.
  49 .sp
  50 .LP
  51 If the specified message queue is not full, \fBmq_send()\fR behaves as
  52 if the message is inserted into the message queue at the position
  53 indicated by the \fImsg_prio\fR argument. A message with a larger
  54 numeric value of \fImsg_prio\fR is inserted before messages with lower
  55 values of \fImsg_prio\fR.  A message will be inserted after other
  56 messages in the queue, if any, with equal \fImsg_prio\fR. The value of
  57 \fImsg_prio\fR must range from zero to \fBMQ_PRIO_MAX - 1\fR.
  58 .sp
  59 .LP
  60 If the specified message queue is full and \fBO_NONBLOCK\fR is not set in the
  61 message queue description associated with \fImqdes\fR (see \fBmq_open\fR(3C)
  62 and \fBmq_setattr\fR(3C)), \fBmq_send()\fR blocks until space becomes available
  63 to enqueue the message, or until \fBmq_send()\fR is interrupted by a signal. If
  64 more than one thread is waiting to send when space becomes available in the
  65 message queue, then the thread of the highest priority which has been waiting
  66 the longest is unblocked to send its message. Otherwise, it is unspecified
  67 which waiting thread is unblocked. If the specified message queue is full and
  68 \fBO_NONBLOCK\fR is set in the message queue description associated with
  69 \fImqdes\fR, the message is not queued and \fBmq_send()\fR returns an error.
  70 .sp
  71 .LP
  72 The \fBmq_timedsend()\fR function adds a message to the message queue specified
  73 by \fImqdes\fR in the manner defined for the \fBmq_send()\fR function. However,
  74 if the specified message queue is full and \fBO_NONBLOCK\fR is not set in the
  75 message queue description associated with \fImqdes\fR, the wait for sufficient
  76 room in the queue is terminated when the specified timeout expires. If
  77 \fBO_NONBLOCK\fR is set in the message queue description, this function is
  78 equivalent to \fBmq_send()\fR.
  79 .sp
  80 .LP
  81 The \fBmq_reltimedsend_np()\fR function is identical to the
  82 \fBmq_timedsend()\fR function, except that the timeout is specified as a
  83 relative time interval.
  84 .sp
  85 .LP
  86 For \fBmq_timedsend()\fR, the timeout expires when the absolute time specified
  87 by \fIabs_timeout\fR passes, as measured by the \fBCLOCK_REALTIME\fR clock
  88 (that is, when the value of that clock equals or exceeds \fIabs_timeout\fR), or
  89 if the absolute time specified by \fIabs_timeout\fR has already been passed at
  90 the time of the call.
  91 .sp
  92 .LP
  93 For \fBmq_reltimedsend_np()\fR, the timeout expires when the time interval
  94 specified by \fIrel_timeout\fR passes, as measured by the \fBCLOCK_REALTIME\fR
  95 clock, or if the time interval specified by \fIrel_timeout\fR is negative at
  96 the time of the call.
  97 .sp
  98 .LP
  99 The resolution of the timeout is the resolution of the \fBCLOCK_REALTIME\fR
 100 clock. The \fBtimespec\fR argument is defined in the <\fBtime.h\fR> header.
 101 .sp
 102 .LP
 103 Under no circumstance does the operation fail with a timeout if there is
 104 sufficient room in the queue to add the message immediately. The validity of
 105 the timeout parameter need not be checked when there is sufficient room in the
 106 queue.
 107 .SH RETURN VALUES
 108 .LP
 109 Upon successful completion, \fBmq_send()\fR, \fBmq_timedsend()\fR, and
 110 \fBmq_reltimedsend_np()\fR return \fB0\fR. Otherwise, no message is enqueued,
 111 the functions return \fB\(mi1\fR, and \fBerrno\fR is set to indicate the error.
 112 .SH ERRORS
 113 .LP
 114 The \fBmq_send()\fR, \fBmq_timedsend()\fR, and \fBmq_reltimedsend_np()\fR
 115 functions will fail if:
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBEAGAIN\fR \fR
 120 .ad
 121 .RS 13n
 122 The  \fBO_NONBLOCK\fR flag is set in the message queue description associated
 123 with \fImqdes\fR, and the specified message queue is full.
 124 .RE
 125
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fBEBADF\fR \fR
 130 .ad
 131 .RS 13n
 132 The \fImqdes\fR argument is not a valid message queue descriptor open for
 133 writing.
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fBEINTR\fR \fR
 140 .ad
 141 .RS 13n
 142 A signal interrupted the function call.
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fBEINVAL\fR\fR
 149 .ad
 150 .RS 13n
 151 The value of \fImsg_prio\fR was outside the valid range.
 152 .RE
 153
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fBEINVAL\fR\fR
 158 .ad
 159 .RS 13n
 160 The process or thread would have blocked, and the timeout parameter specified a
 161 nanoseconds field value less than zero or greater than or equal to 1,000
 162 million.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fBEMSGSIZE\fR \fR
 169 .ad
 170 .RS 13n
 171 The specified message length, \fImsg_len\fR, exceeds the message size attribute
 172 of the message queue.
 173 .RE
 174
 175 .sp
 176 .ne 2
 177 .na
 178 \fB\fBETIMEDOUT\fR\fR
 179 .ad
 180 .RS 13n
 181 The \fBO_NONBLOCK\fR flag was not set when the message queue was opened, but
 182 the timeout expired before the message could be added to the queue.
 183 .RE
 184
 185 .SH ATTRIBUTES
 186 .LP
 187 See \fBattributes\fR(5) for descriptions of the following attributes:
 188 .sp
 189
 190 .sp
 191 .TS
 192 box;
 193 l | l
 194 l | l .
 195 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 196 _
 197 Interface Stability     Committed
 198 _
 199 MT-Level        MT-Safe
 200 _
 201 Standard        See below.
 202 .TE
 203
 204 .sp
 205 .LP
 206 For \fBmq_send()\fR and \fBmq_timedsend()\fR, see \fBstandards\fR(5).
 207 .SH SEE ALSO
 208 .LP
 209 \fBsysconf\fR(3C), \fBmqueue.h\fR(3HEAD), \fBmq_open\fR(3C),
 210 \fBmq_receive\fR(3C), \fBmq_setattr\fR(3C), \fBattributes\fR(5),
 211 \fBstandards\fR(5)