|
Packit |
7cfc04 |
'\" et
|
|
Packit |
7cfc04 |
.TH sys_msg.h "0P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
|
|
Packit |
7cfc04 |
.SH PROLOG
|
|
Packit |
7cfc04 |
This manual page is part of the POSIX Programmer's Manual.
|
|
Packit |
7cfc04 |
The Linux implementation of this interface may differ (consult
|
|
Packit |
7cfc04 |
the corresponding Linux manual page for details of Linux behavior),
|
|
Packit |
7cfc04 |
or the interface may not be implemented on Linux.
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
.SH NAME
|
|
Packit |
7cfc04 |
sys/msg.h
|
|
Packit |
7cfc04 |
\(em XSI message queue structures
|
|
Packit |
7cfc04 |
.SH SYNOPSIS
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
#include <sys/msg.h>
|
|
Packit |
7cfc04 |
.fi
|
|
Packit |
7cfc04 |
.SH DESCRIPTION
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
.IR <sys/msg.h>
|
|
Packit |
7cfc04 |
header shall define the following data types through
|
|
Packit |
7cfc04 |
.BR typedef :
|
|
Packit |
7cfc04 |
.IP "\fBmsgqnum_t\fP" 14
|
|
Packit |
7cfc04 |
Used for the number of messages in the message queue.
|
|
Packit |
7cfc04 |
.IP "\fBmsglen_t\fP" 14
|
|
Packit |
7cfc04 |
Used for the number of bytes allowed in a message queue.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
These types shall be unsigned integer types that are able to store
|
|
Packit |
7cfc04 |
values at least as large as a type
|
|
Packit |
7cfc04 |
.BR "unsigned short" .
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
.IR <sys/msg.h>
|
|
Packit |
7cfc04 |
header shall define the following symbolic constant as a message
|
|
Packit |
7cfc04 |
operation flag:
|
|
Packit |
7cfc04 |
.IP MSG_NOERROR 14
|
|
Packit |
7cfc04 |
No error if big message.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
.IR <sys/msg.h>
|
|
Packit |
7cfc04 |
header shall define the
|
|
Packit |
7cfc04 |
.BR msqid_ds
|
|
Packit |
7cfc04 |
structure, which shall include the following members:
|
|
Packit |
7cfc04 |
.sp
|
|
Packit |
7cfc04 |
.RS 4
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
\fB
|
|
Packit |
7cfc04 |
struct ipc_perm msg_perm \fROperation permission structure.\fR
|
|
Packit |
7cfc04 |
msgqnum_t msg_qnum \fRNumber of messages currently on queue.\fR
|
|
Packit |
7cfc04 |
msglen_t msg_qbytes \fRMaximum number of bytes allowed on queue.\fR
|
|
Packit |
7cfc04 |
pid_t msg_lspid \fRProcess ID of last \fImsgsnd\fP\^(\|).\fR
|
|
Packit |
7cfc04 |
pid_t msg_lrpid \fRProcess ID of last \fImsgrcv\fP\^(\|).\fR
|
|
Packit |
7cfc04 |
time_t msg_stime \fRTime of last \fImsgsnd\fP\^(\|).\fR
|
|
Packit |
7cfc04 |
time_t msg_rtime \fRTime of last \fImsgrcv\fP\^(\|).\fR
|
|
Packit |
7cfc04 |
time_t msg_ctime \fRTime of last change.\fR
|
|
Packit |
7cfc04 |
.fi \fR
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
.RE
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
.IR <sys/msg.h>
|
|
Packit |
7cfc04 |
header shall define the
|
|
Packit |
7cfc04 |
.BR pid_t ,
|
|
Packit |
7cfc04 |
.BR size_t ,
|
|
Packit |
7cfc04 |
.BR ssize_t ,
|
|
Packit |
7cfc04 |
and
|
|
Packit |
7cfc04 |
.BR time_t
|
|
Packit |
7cfc04 |
types as described in
|
|
Packit |
7cfc04 |
.IR <sys/types.h> .
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The following shall be declared as functions and may also be defined
|
|
Packit |
7cfc04 |
as macros. Function prototypes shall be provided.
|
|
Packit |
7cfc04 |
.sp
|
|
Packit |
7cfc04 |
.RS 4
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
\fB
|
|
Packit |
7cfc04 |
int msgctl(int, int, struct msqid_ds *);
|
|
Packit |
7cfc04 |
int msgget(key_t, int);
|
|
Packit |
7cfc04 |
ssize_t msgrcv(int, void *, size_t, long, int);
|
|
Packit |
7cfc04 |
int msgsnd(int, const void *, size_t, int);
|
|
Packit |
7cfc04 |
.fi \fR
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
.RE
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
In addition, the
|
|
Packit |
7cfc04 |
.IR <sys/msg.h>
|
|
Packit |
7cfc04 |
header shall include the
|
|
Packit |
7cfc04 |
.IR <sys/ipc.h>
|
|
Packit |
7cfc04 |
header.
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.IR "The following sections are informative."
|
|
Packit |
7cfc04 |
.SH "APPLICATION USAGE"
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH RATIONALE
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "FUTURE DIRECTIONS"
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "SEE ALSO"
|
|
Packit |
7cfc04 |
.IR "\fB<sys_ipc.h>\fP",
|
|
Packit |
7cfc04 |
.IR "\fB<sys_types.h>\fP"
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The System Interfaces volume of POSIX.1\(hy2008,
|
|
Packit |
7cfc04 |
.IR "\fImsgctl\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fImsgget\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fImsgrcv\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fImsgsnd\fR\^(\|)"
|
|
Packit |
7cfc04 |
.SH COPYRIGHT
|
|
Packit |
7cfc04 |
Portions of this text are reprinted and reproduced in electronic form
|
|
Packit |
7cfc04 |
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
|
|
Packit |
7cfc04 |
-- Portable Operating System Interface (POSIX), The Open Group Base
|
|
Packit |
7cfc04 |
Specifications Issue 7, Copyright (C) 2013 by the Institute of
|
|
Packit |
7cfc04 |
Electrical and Electronics Engineers, Inc and The Open Group.
|
|
Packit |
7cfc04 |
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
|
|
Packit |
7cfc04 |
event of any discrepancy between this version and the original IEEE and
|
|
Packit |
7cfc04 |
The Open Group Standard, the original IEEE and The Open Group Standard
|
|
Packit |
7cfc04 |
is the referee document. The original Standard can be obtained online at
|
|
Packit |
7cfc04 |
http://www.unix.org/online.html .
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
Any typographical or formatting errors that appear
|
|
Packit |
7cfc04 |
in this page are most likely
|
|
Packit |
7cfc04 |
to have been introduced during the conversion of the source files to
|
|
Packit |
7cfc04 |
man page format. To report such errors, see
|
|
Packit |
7cfc04 |
https://www.kernel.org/doc/man-pages/reporting_bugs.html .
|