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

sys_msg.h.0p (3451B)


  1. '\" et
  2. .TH sys_msg.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. sys/msg.h
  12. \(em XSI message queue structures
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <sys/msg.h>
  17. .fi
  18. .SH DESCRIPTION
  19. The
  20. .IR <sys/msg.h>
  21. header shall define the following data types through
  22. .BR typedef :
  23. .IP "\fBmsgqnum_t\fP" 14
  24. Used for the number of messages in the message queue.
  25. .IP "\fBmsglen_t\fP" 14
  26. Used for the number of bytes allowed in a message queue.
  27. .P
  28. These types shall be unsigned integer types that are able to store
  29. values at least as large as a type
  30. .BR "unsigned short" .
  31. .P
  32. The
  33. .IR <sys/msg.h>
  34. header shall define the following symbolic constant as a message
  35. operation flag:
  36. .IP MSG_NOERROR 14
  37. No error if big message.
  38. .P
  39. The
  40. .IR <sys/msg.h>
  41. header shall define the
  42. .BR msqid_ds
  43. structure, which shall include the following members:
  44. .sp
  45. .RS 4
  46. .nf
  47. struct ipc_perm msg_perm \fROperation permission structure.\fR
  48. msgqnum_t msg_qnum \fRNumber of messages currently on queue.\fR
  49. msglen_t msg_qbytes \fRMaximum number of bytes allowed on queue.\fR
  50. pid_t msg_lspid \fRProcess ID of last \fImsgsnd\fP\^(\|).\fR
  51. pid_t msg_lrpid \fRProcess ID of last \fImsgrcv\fP\^(\|).\fR
  52. time_t msg_stime \fRTime of last \fImsgsnd\fP\^(\|).\fR
  53. time_t msg_rtime \fRTime of last \fImsgrcv\fP\^(\|).\fR
  54. time_t msg_ctime \fRTime of last change.\fR
  55. .fi
  56. .P
  57. .RE
  58. .P
  59. The
  60. .IR <sys/msg.h>
  61. header shall define the
  62. .BR pid_t ,
  63. .BR size_t ,
  64. .BR ssize_t ,
  65. and
  66. .BR time_t
  67. types as described in
  68. .IR <sys/types.h> .
  69. .P
  70. The following shall be declared as functions and may also be defined
  71. as macros. Function prototypes shall be provided.
  72. .sp
  73. .RS 4
  74. .nf
  75. int msgctl(int, int, struct msqid_ds *);
  76. int msgget(key_t, int);
  77. ssize_t msgrcv(int, void *, size_t, long, int);
  78. int msgsnd(int, const void *, size_t, int);
  79. .fi
  80. .P
  81. .RE
  82. .P
  83. In addition, the
  84. .IR <sys/msg.h>
  85. header shall include the
  86. .IR <sys/ipc.h>
  87. header.
  88. .LP
  89. .IR "The following sections are informative."
  90. .SH "APPLICATION USAGE"
  91. None.
  92. .SH RATIONALE
  93. None.
  94. .SH "FUTURE DIRECTIONS"
  95. None.
  96. .SH "SEE ALSO"
  97. .IR "\fB<sys_ipc.h>\fP",
  98. .IR "\fB<sys_types.h>\fP"
  99. .P
  100. The System Interfaces volume of POSIX.1\(hy2017,
  101. .IR "\fImsgctl\fR\^(\|)",
  102. .IR "\fImsgget\fR\^(\|)",
  103. .IR "\fImsgrcv\fR\^(\|)",
  104. .IR "\fImsgsnd\fR\^(\|)"
  105. .\"
  106. .SH COPYRIGHT
  107. Portions of this text are reprinted and reproduced in electronic form
  108. from IEEE Std 1003.1-2017, Standard for Information Technology
  109. -- Portable Operating System Interface (POSIX), The Open Group Base
  110. Specifications Issue 7, 2018 Edition,
  111. Copyright (C) 2018 by the Institute of
  112. Electrical and Electronics Engineers, Inc and The Open Group.
  113. In the event of any discrepancy between this version and the original IEEE and
  114. The Open Group Standard, the original IEEE and The Open Group Standard
  115. is the referee document. The original Standard can be obtained online at
  116. http://www.opengroup.org/unix/online.html .
  117. .PP
  118. Any typographical or formatting errors that appear
  119. in this page are most likely
  120. to have been introduced during the conversion of the source files to
  121. man page format. To report such errors, see
  122. https://www.kernel.org/doc/man-pages/reporting_bugs.html .