logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

mqueue.h.0p (3824B)

    

  1. '\" et
  2. .TH mqueue.h "0P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. mqueue.h
  12. \(em message queues
  13. (\fBREALTIME\fP)
  14. .SH SYNOPSIS
  15. .LP
  16. .nf
  17. #include <mqueue.h>
  18. .fi
  19. .SH DESCRIPTION
  20. The
  21. .IR <mqueue.h> 
  22. header shall define the
  23. .BR mqd_t
  24. type, which is used for message queue descriptors. This is not an
  25. array type.
  26. .P
  27. The
  28. .IR <mqueue.h> 
  29. header shall define the
  30. .BR pthread_attr_t ,
  31. .BR size_t ,
  32. and
  33. .BR ssize_t
  34. types as described in
  35. .IR <sys/types.h> .
  36. .P
  37. The
  38. .IR <mqueue.h> 
  39. header shall define the
  40. .BR "struct timespec"
  41. structure as described in
  42. .IR <time.h> .
  43. .P
  44. The tag
  45. .BR sigevent
  46. shall be declared as naming an incomplete structure type, the contents
  47. of which are described in the
  48. .IR <signal.h> 
  49. header.
  50. .P
  51. The
  52. .IR <mqueue.h> 
  53. header shall define the
  54. .BR mq_attr
  55. structure, which is used in getting and setting the attributes of a
  56. message queue. Attributes are initially set when the message queue is
  57. created. An
  58. .BR mq_attr
  59. structure shall have at least the following fields:
  60. .sp
  61. .RS 4
  62. .nf
  64. long    mq_flags    \fRMessage queue flags.\fP
  65. long    mq_maxmsg   \fRMaximum number of messages.\fP
  66. long    mq_msgsize  \fRMaximum message size.\fP
  67. long    mq_curmsgs  \fRNumber of messages currently queued.\fP
  68. .fi
  69. .P
  70. .RE
  71. .P
  72. The following shall be declared as functions and may also be defined
  73. as macros. Function prototypes shall be provided.
  74. .sp
  75. .RS 4
  76. .nf
  78. int      mq_close(mqd_t);
  79. int      mq_getattr(mqd_t, struct mq_attr *);
  80. int      mq_notify(mqd_t, const struct sigevent *);
  81. mqd_t    mq_open(const char *, int, ...);
  82. ssize_t  mq_receive(mqd_t, char *, size_t, unsigned *);
  83. int      mq_send(mqd_t, const char *, size_t, unsigned);
  84. int      mq_setattr(mqd_t, const struct mq_attr *restrict,
  85.              struct mq_attr *restrict);
  86. ssize_t  mq_timedreceive(mqd_t, char *restrict, size_t,
  87.              unsigned *restrict, const struct timespec *restrict);
  88. int      mq_timedsend(mqd_t, const char *, size_t, unsigned,
  89.              const struct timespec *);
  90. int      mq_unlink(const char *);
  91. .fi
  92. .P
  93. .RE
  94. .P
  95. Inclusion of the
  96. .IR <mqueue.h> 
  97. header may make visible symbols defined in the headers
  98. .IR <fcntl.h> ,
  99. .IR <signal.h> ,
  100. and
  101. .IR <time.h> .
  102. .LP
  103. .IR "The following sections are informative."
  104. .SH "APPLICATION USAGE"
  105. None.
  106. .SH RATIONALE
  107. None.
  108. .SH "FUTURE DIRECTIONS"
  109. None.
  110. .SH "SEE ALSO"
  111. .IR "\fB<fcntl.h>\fP",
  112. .IR "\fB<signal.h>\fP",
  113. .IR "\fB<sys_types.h>\fP",
  114. .IR "\fB<time.h>\fP"
  115. .P
  116. The System Interfaces volume of POSIX.1\(hy2017,
  117. .IR "\fImq_close\fR\^(\|)",
  118. .IR "\fImq_getattr\fR\^(\|)",
  119. .IR "\fImq_notify\fR\^(\|)",
  120. .IR "\fImq_open\fR\^(\|)",
  121. .IR "\fImq_receive\fR\^(\|)",
  122. .IR "\fImq_send\fR\^(\|)",
  123. .IR "\fImq_setattr\fR\^(\|)",
  124. .IR "\fImq_unlink\fR\^(\|)"
  125. .\"
  126. .SH COPYRIGHT
  127. Portions of this text are reprinted and reproduced in electronic form
  128. from IEEE Std 1003.1-2017, Standard for Information Technology
  129. -- Portable Operating System Interface (POSIX), The Open Group Base
  130. Specifications Issue 7, 2018 Edition,
  131. Copyright (C) 2018 by the Institute of
  132. Electrical and Electronics Engineers, Inc and The Open Group.
  133. In the event of any discrepancy between this version and the original IEEE and
  134. The Open Group Standard, the original IEEE and The Open Group Standard
  135. is the referee document. The original Standard can be obtained online at
  136. http://www.opengroup.org/unix/online.html .
  137. .PP
  138. Any typographical or formatting errors that appear
  139. in this page are most likely
  140. to have been introduced during the conversion of the source files to
  141. man page format. To report such errors, see
  142. https://www.kernel.org/doc/man-pages/reporting_bugs.html .