usr/src/man/man3head/ipc.h.3head

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH IPC.H 3HEAD "Sep 10, 2004"
  47 .SH NAME
  48 ipc.h, ipc \- XSI interprocess communication access structure
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <\fBsys/ipc.h\fR>
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The <\fBsys/ipc.h\fR> header is used by three mechanisms for interprocess
  59 communication (IPC): messages, semaphores, and shared memory. All use a common
  60 structure type, \fBipc_perm\fR, to pass information used in determining
  61 permission to perform an IPC operation.
  62 .sp
  63 .LP
  64 The \fBipc_perm\fR structure contains the following members:
  65 .sp
  66 .in +2
  67 .nf
  68 uid_t  uid     /* owner's user ID */
  69 gid_t  gid     /* owner's group ID */
  70 uid_t  cuid    /* creator's user ID */
  71 gid_t  cgid    /* creator's group ID */
  72 mode_t mode    /* read/write permission
  73 .fi
  74 .in -2
  75
  76 .sp
  77 .LP
  78 The \fBuid_t\fR, \fBgid_t\fR, \fBmode_t\fR, and \fBkey_t\fR types are defined
  79 as described in <\fBsys/types.h\fR>. See \fBtypes.h\fR(3HEAD).
  80 .sp
  81 .LP
  82 Definitions are provided for the constants listed below.
  83 .sp
  84 .LP
  85 Mode bits:
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBIPC_CREAT\fR\fR
  90 .ad
  91 .RS 14n
  92 Create entry if key does not exist.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBIPC_EXCL\fR\fR
  99 .ad
 100 .RS 14n
 101 Fail if key exists.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBIPC_NOWAIT\fR\fR
 108 .ad
 109 .RS 14n
 110 Error if request must wait.
 111 .RE
 112
 113 .sp
 114 .LP
 115 Keys:
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBIPC_PRIVATE\fR\fR
 120 .ad
 121 .RS 15n
 122 Private key.
 123 .RE
 124
 125 .sp
 126 .LP
 127 Control commands:
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fBIPC_RMID\fR\fR
 132 .ad
 133 .RS 12n
 134 Remove identifier.
 135 .RE
 136
 137 .sp
 138 .ne 2
 139 .na
 140 \fB\fBIPC_SET\fR\fR
 141 .ad
 142 .RS 12n
 143 Set options.
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fBIPC_STAT\fR\fR
 150 .ad
 151 .RS 12n
 152 Get options.
 153 .RE
 154
 155 .SH ATTRIBUTES
 156 .sp
 157 .LP
 158 See \fBattributes\fR(5) for descriptions of the following attributes:
 159 .sp
 160
 161 .sp
 162 .TS
 163 box;
 164 c | c
 165 l | l .
 166 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 167 _
 168 Interface Stability     Standard
 169 .TE
 170
 171 .SH SEE ALSO
 172 .sp
 173 .LP
 174 \fBftok\fR(3C), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)