.\"
.\" 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
.\" http://www.opengroup.org/bookstore/.
.\"
.\" 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 SunOS 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.
.\"
.\" This notice shall appear on any product containing this material.
.\"
.\" 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.
.\"
.\" 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.
.\"
.\" 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]
.\"
.\"
.\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
.\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
.\"
.TH IPC.H 3HEAD "Sep 10, 2004"
.SH NAME
ipc.h, ipc \- XSI interprocess communication access structure
.SH SYNOPSIS
.LP
.nf
#include <\fBsys/ipc.h\fR>
.fi

.SH DESCRIPTION
.sp
.LP
The <\fBsys/ipc.h\fR> header is used by three mechanisms for interprocess
communication (IPC): messages, semaphores, and shared memory. All use a common
structure type, \fBipc_perm\fR, to pass information used in determining
permission to perform an IPC operation.
.sp
.LP
The \fBipc_perm\fR structure contains the following members:
.sp
.in +2
.nf
uid_t  uid     /* owner's user ID */
gid_t  gid     /* owner's group ID */
uid_t  cuid    /* creator's user ID */
gid_t  cgid    /* creator's group ID */
mode_t mode    /* read/write permission
.fi
.in -2

.sp
.LP
The \fBuid_t\fR, \fBgid_t\fR, \fBmode_t\fR, and \fBkey_t\fR types are defined
as described in <\fBsys/types.h\fR>. See \fBtypes.h\fR(3HEAD).
.sp
.LP
Definitions are provided for the constants listed below.
.sp
.LP
Mode bits:
.sp
.ne 2
.na
\fB\fBIPC_CREAT\fR\fR
.ad
.RS 14n
Create entry if key does not exist.
.RE

.sp
.ne 2
.na
\fB\fBIPC_EXCL\fR\fR
.ad
.RS 14n
Fail if key exists.
.RE

.sp
.ne 2
.na
\fB\fBIPC_NOWAIT\fR\fR
.ad
.RS 14n
Error if request must wait.
.RE

.sp
.LP
Keys:
.sp
.ne 2
.na
\fB\fBIPC_PRIVATE\fR\fR
.ad
.RS 15n
Private key.
.RE

.sp
.LP
Control commands:
.sp
.ne 2
.na
\fB\fBIPC_RMID\fR\fR
.ad
.RS 12n
Remove identifier.
.RE

.sp
.ne 2
.na
\fB\fBIPC_SET\fR\fR
.ad
.RS 12n
Set options.
.RE

.sp
.ne 2
.na
\fB\fBIPC_STAT\fR\fR
.ad
.RS 12n
Get options.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Standard
.TE

.SH SEE ALSO
.sp
.LP
\fBftok\fR(3C), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)