share/man/man3head/ipc.h.3head

   1 '\" te
   2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" 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 Sun OS 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.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" 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.
   8 .\" 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.
   9 .\" 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]
  10 .TH IPC.H 3HEAD "Sep 10, 2004"
  11 .SH NAME
  12 ipc.h, ipc \- XSI interprocess communication access structure
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <\fBsys/ipc.h\fR>
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The <\fBsys/ipc.h\fR> header is used by three mechanisms for interprocess
  23 communication (IPC): messages, semaphores, and shared memory. All use a common
  24 structure type, \fBipc_perm\fR, to pass information used in determining
  25 permission to perform an IPC operation.
  26 .sp
  27 .LP
  28 The \fBipc_perm\fR structure contains the following members:
  29 .sp
  30 .in +2
  31 .nf
  32 uid_t  uid     /* owner's user ID */
  33 gid_t  gid     /* owner's group ID */
  34 uid_t  cuid    /* creator's user ID */
  35 gid_t  cgid    /* creator's group ID */
  36 mode_t mode    /* read/write permission
  37 .fi
  38 .in -2
  39
  40 .sp
  41 .LP
  42 The \fBuid_t\fR, \fBgid_t\fR, \fBmode_t\fR, and \fBkey_t\fR types are defined
  43 as described in <\fBsys/types.h\fR>. See \fBtypes.h\fR(3HEAD).
  44 .sp
  45 .LP
  46 Definitions are provided for the constants listed below.
  47 .sp
  48 .LP
  49 Mode bits:
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBIPC_CREAT\fR\fR
  54 .ad
  55 .RS 14n
  56 Create entry if key does not exist.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBIPC_EXCL\fR\fR
  63 .ad
  64 .RS 14n
  65 Fail if key exists.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBIPC_NOWAIT\fR\fR
  72 .ad
  73 .RS 14n
  74 Error if request must wait.
  75 .RE
  76
  77 .sp
  78 .LP
  79 Keys:
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBIPC_PRIVATE\fR\fR
  84 .ad
  85 .RS 15n
  86 Private key.
  87 .RE
  88
  89 .sp
  90 .LP
  91 Control commands:
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBIPC_RMID\fR\fR
  96 .ad
  97 .RS 12n
  98 Remove identifier.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBIPC_SET\fR\fR
 105 .ad
 106 .RS 12n
 107 Set options.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBIPC_STAT\fR\fR
 114 .ad
 115 .RS 12n
 116 Get options.
 117 .RE
 118
 119 .SH ATTRIBUTES
 120 .sp
 121 .LP
 122 See \fBattributes\fR(5) for descriptions of the following attributes:
 123 .sp
 124
 125 .sp
 126 .TS
 127 box;
 128 c | c
 129 l | l .
 130 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 131 _
 132 Interface Stability     Standard
 133 .TE
 134
 135 .SH SEE ALSO
 136 .sp
 137 .LP
 138 \fBftok\fR(3C), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)