lib/libc/sys/mq_getattr.2

   1 .\" Copyright (c) 2005 David Xu <davidxu@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  17 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
  20 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  23 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  24 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  25 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  26 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd November 29, 2005
  31 .Dt MQ_GETATTR 2
  32 .Os
  33 .Sh NAME
  34 .Nm mq_getattr
  35 .Nd "get message queue attributes (REALTIME)"
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In mqueue.h
  40 .Ft int
  41 .Fn mq_getattr "mqd_t mqdes" "struct mq_attr *mqstat"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn mq_getattr
  45 system call obtains status information and attributes of the message queue and
  46 the open message queue description associated with the message queue
  47 descriptor.
  48 .Pp
  49 The
  50 .Fa mqdes
  51 argument specifies a message queue descriptor.
  52 .Pp
  53 The results are returned in the
  54 .Vt mq_attr
  55 structure referenced by the
  56 .Fa mqstat
  57 argument.
  58 .Pp
  59 Upon return, the following members will have the values associated with the
  60 open message queue description as set when the message queue was opened and
  61 as modified by subsequent
  62 .Fn mq_setattr
  63 calls:
  64 .Va mq_flags .
  65 .Pp
  66 The following attributes of the message queue will be returned as set at
  67 message queue creation:
  68 .Va mq_maxmsg , mq_msgsize .
  69 .Pp
  70 Upon return, the following members within the
  71 .Vt mq_attr
  72 structure referenced by the
  73 .Fa mqstat
  74 argument will be set to the current state
  75 of the message queue:
  76 .Bl -tag -width ".Va mq_flags"
  77 .It Va mq_flags
  78 The number of messages currently on the queue.
  79 .El
  80 .Sh RETURN VALUES
  81 .Rv -std
  82 .Sh ERRORS
  83 The
  84 .Fn mq_getattr
  85 system call
  86 will fail if:
  87 .Bl -tag -width Er
  88 .It Bq Er EBADF
  89 The
  90 .Fa mqdes
  91 argument is not a valid message queue descriptor.
  92 .El
  93 .Sh SEE ALSO
  94 .Xr mq_open 2 ,
  95 .Xr mq_send 2 ,
  96 .Xr mq_setattr 2 ,
  97 .Xr mq_timedsend 2
  98 .Sh STANDARDS
  99 The
 100 .Fn mq_getattr
 101 system call conforms to
 102 .St -p1003.1-2004 .
 103 .Sh HISTORY
 104 Support for
 105 .Tn POSIX
 106 message queues first appeared in
 107 .Fx 7.0 .