Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
2 | .\" | |
3 | .\" Standard preamble: | |
4 | .\" ======================================================================== | |
5 | .de Sh \" Subsection heading | |
6 | .br | |
7 | .if t .Sp | |
8 | .ne 5 | |
9 | .PP | |
10 | \fB\\$1\fR | |
11 | .PP | |
12 | .. | |
13 | .de Sp \" Vertical space (when we can't use .PP) | |
14 | .if t .sp .5v | |
15 | .if n .sp | |
16 | .. | |
17 | .de Vb \" Begin verbatim text | |
18 | .ft CW | |
19 | .nf | |
20 | .ne \\$1 | |
21 | .. | |
22 | .de Ve \" End verbatim text | |
23 | .ft R | |
24 | .fi | |
25 | .. | |
26 | .\" Set up some character translations and predefined strings. \*(-- will | |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a | |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to | |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' | |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. | |
32 | .tr \(*W-|\(bv\*(Tr | |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
34 | .ie n \{\ | |
35 | . ds -- \(*W- | |
36 | . ds PI pi | |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
39 | . ds L" "" | |
40 | . ds R" "" | |
41 | . ds C` "" | |
42 | . ds C' "" | |
43 | 'br\} | |
44 | .el\{\ | |
45 | . ds -- \|\(em\| | |
46 | . ds PI \(*p | |
47 | . ds L" `` | |
48 | . ds R" '' | |
49 | 'br\} | |
50 | .\" | |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for | |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index | |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the | |
54 | .\" output yourself in some meaningful fashion. | |
55 | .if \nF \{\ | |
56 | . de IX | |
57 | . tm Index:\\$1\t\\n%\t"\\$2" | |
58 | .. | |
59 | . nr % 0 | |
60 | . rr F | |
61 | .\} | |
62 | .\" | |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes | |
64 | .\" way too many mistakes in technical documents. | |
65 | .hy 0 | |
66 | .if n .na | |
67 | .\" | |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
70 | . \" fudge factors for nroff and troff | |
71 | .if n \{\ | |
72 | . ds #H 0 | |
73 | . ds #V .8m | |
74 | . ds #F .3m | |
75 | . ds #[ \f1 | |
76 | . ds #] \fP | |
77 | .\} | |
78 | .if t \{\ | |
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
80 | . ds #V .6m | |
81 | . ds #F 0 | |
82 | . ds #[ \& | |
83 | . ds #] \& | |
84 | .\} | |
85 | . \" simple accents for nroff and troff | |
86 | .if n \{\ | |
87 | . ds ' \& | |
88 | . ds ` \& | |
89 | . ds ^ \& | |
90 | . ds , \& | |
91 | . ds ~ ~ | |
92 | . ds / | |
93 | .\} | |
94 | .if t \{\ | |
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
101 | .\} | |
102 | . \" troff and (daisy-wheel) nroff accents | |
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
110 | .ds ae a\h'-(\w'a'u*4/10)'e | |
111 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
112 | . \" corrections for vroff | |
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
115 | . \" for low resolution devices (crt and lpr) | |
116 | .if \n(.H>23 .if \n(.V>19 \ | |
117 | \{\ | |
118 | . ds : e | |
119 | . ds 8 ss | |
120 | . ds o a | |
121 | . ds d- d\h'-1'\(ga | |
122 | . ds D- D\h'-1'\(hy | |
123 | . ds th \o'bp' | |
124 | . ds Th \o'LP' | |
125 | . ds ae ae | |
126 | . ds Ae AE | |
127 | .\} | |
128 | .rm #[ #] #H #V #F C | |
129 | .\" ======================================================================== | |
130 | .\" | |
131 | .IX Title "IPC::Semaphore 3" | |
132 | .TH IPC::Semaphore 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide" | |
133 | .SH "NAME" | |
134 | IPC::Semaphore \- SysV Semaphore IPC object class | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | .Vb 2 | |
138 | \& use IPC::SysV qw(IPC_PRIVATE S_IRWXU IPC_CREAT); | |
139 | \& use IPC::Semaphore; | |
140 | .Ve | |
141 | .PP | |
142 | .Vb 1 | |
143 | \& $sem = new IPC::Semaphore(IPC_PRIVATE, 10, S_IRWXU | IPC_CREAT); | |
144 | .Ve | |
145 | .PP | |
146 | .Vb 1 | |
147 | \& $sem->setall( (0) x 10); | |
148 | .Ve | |
149 | .PP | |
150 | .Vb 1 | |
151 | \& @sem = $sem->getall; | |
152 | .Ve | |
153 | .PP | |
154 | .Vb 1 | |
155 | \& $ncnt = $sem->getncnt; | |
156 | .Ve | |
157 | .PP | |
158 | .Vb 1 | |
159 | \& $zcnt = $sem->getzcnt; | |
160 | .Ve | |
161 | .PP | |
162 | .Vb 1 | |
163 | \& $ds = $sem->stat; | |
164 | .Ve | |
165 | .PP | |
166 | .Vb 1 | |
167 | \& $sem->remove; | |
168 | .Ve | |
169 | .SH "DESCRIPTION" | |
170 | .IX Header "DESCRIPTION" | |
171 | A class providing an object based interface to SysV \s-1IPC\s0 semaphores. | |
172 | .SH "METHODS" | |
173 | .IX Header "METHODS" | |
174 | .IP "new ( \s-1KEY\s0 , \s-1NSEMS\s0 , \s-1FLAGS\s0 )" 4 | |
175 | .IX Item "new ( KEY , NSEMS , FLAGS )" | |
176 | Create a new semaphore set associated with \f(CW\*(C`KEY\*(C'\fR. \f(CW\*(C`NSEMS\*(C'\fR is the number | |
177 | of semaphores in the set. A new set is created if | |
178 | .RS 4 | |
179 | .IP "*" 4 | |
180 | \&\f(CW\*(C`KEY\*(C'\fR is equal to \f(CW\*(C`IPC_PRIVATE\*(C'\fR | |
181 | .IP "*" 4 | |
182 | \&\f(CW\*(C`KEY\*(C'\fR does not already have a semaphore identifier | |
183 | associated with it, and \f(CW\*(C`\f(CI\s-1FLAGS\s0\f(CW & IPC_CREAT\*(C'\fR is true. | |
184 | .RE | |
185 | .RS 4 | |
186 | .Sp | |
187 | On creation of a new semaphore set \f(CW\*(C`FLAGS\*(C'\fR is used to set the | |
188 | permissions. | |
189 | .RE | |
190 | .IP "getall" 4 | |
191 | .IX Item "getall" | |
192 | Returns the values of the semaphore set as an array. | |
193 | .IP "getncnt ( \s-1SEM\s0 )" 4 | |
194 | .IX Item "getncnt ( SEM )" | |
195 | Returns the number of processes waiting for the semaphore \f(CW\*(C`SEM\*(C'\fR to | |
196 | become greater than its current value | |
197 | .IP "getpid ( \s-1SEM\s0 )" 4 | |
198 | .IX Item "getpid ( SEM )" | |
199 | Returns the process id of the last process that performed an operation | |
200 | on the semaphore \f(CW\*(C`SEM\*(C'\fR. | |
201 | .IP "getval ( \s-1SEM\s0 )" 4 | |
202 | .IX Item "getval ( SEM )" | |
203 | Returns the current value of the semaphore \f(CW\*(C`SEM\*(C'\fR. | |
204 | .IP "getzcnt ( \s-1SEM\s0 )" 4 | |
205 | .IX Item "getzcnt ( SEM )" | |
206 | Returns the number of processes waiting for the semaphore \f(CW\*(C`SEM\*(C'\fR to | |
207 | become zero. | |
208 | .IP "id" 4 | |
209 | .IX Item "id" | |
210 | Returns the system identifier for the semaphore set. | |
211 | .IP "op ( \s-1OPLIST\s0 )" 4 | |
212 | .IX Item "op ( OPLIST )" | |
213 | \&\f(CW\*(C`OPLIST\*(C'\fR is a list of operations to pass to \f(CW\*(C`semop\*(C'\fR. \f(CW\*(C`OPLIST\*(C'\fR is | |
214 | a concatenation of smaller lists, each which has three values. The | |
215 | first is the semaphore number, the second is the operation and the last | |
216 | is a flags value. See semop for more details. For example | |
217 | .Sp | |
218 | .Vb 4 | |
219 | \& $sem->op( | |
220 | \& 0, -1, IPC_NOWAIT, | |
221 | \& 1, 1, IPC_NOWAIT | |
222 | \& ); | |
223 | .Ve | |
224 | .IP "remove" 4 | |
225 | .IX Item "remove" | |
226 | Remove and destroy the semaphore set from the system. | |
227 | .IP "set ( \s-1STAT\s0 )" 4 | |
228 | .IX Item "set ( STAT )" | |
229 | .PD 0 | |
230 | .IP "set ( \s-1NAME\s0 => \s-1VALUE\s0 [, \s-1NAME\s0 => \s-1VALUE\s0 ...] )" 4 | |
231 | .IX Item "set ( NAME => VALUE [, NAME => VALUE ...] )" | |
232 | .PD | |
233 | \&\f(CW\*(C`set\*(C'\fR will set the following values of the \f(CW\*(C`stat\*(C'\fR structure associated | |
234 | with the semaphore set. | |
235 | .Sp | |
236 | .Vb 3 | |
237 | \& uid | |
238 | \& gid | |
239 | \& mode (only the permission bits) | |
240 | .Ve | |
241 | .Sp | |
242 | \&\f(CW\*(C`set\*(C'\fR accepts either a stat object, as returned by the \f(CW\*(C`stat\*(C'\fR method, | |
243 | or a list of \fIname\fR\-\fIvalue\fR pairs. | |
244 | .IP "setall ( \s-1VALUES\s0 )" 4 | |
245 | .IX Item "setall ( VALUES )" | |
246 | Sets all values in the semaphore set to those given on the \f(CW\*(C`VALUES\*(C'\fR list. | |
247 | \&\f(CW\*(C`VALUES\*(C'\fR must contain the correct number of values. | |
248 | .IP "setval ( N , \s-1VALUE\s0 )" 4 | |
249 | .IX Item "setval ( N , VALUE )" | |
250 | Set the \f(CW\*(C`N\*(C'\fRth value in the semaphore set to \f(CW\*(C`VALUE\*(C'\fR | |
251 | .IP "stat" 4 | |
252 | .IX Item "stat" | |
253 | Returns an object of type \f(CW\*(C`IPC::Semaphore::stat\*(C'\fR which is a sub-class of | |
254 | \&\f(CW\*(C`Class::Struct\*(C'\fR. It provides the following fields. For a description | |
255 | of these fields see your system documentation. | |
256 | .Sp | |
257 | .Vb 8 | |
258 | \& uid | |
259 | \& gid | |
260 | \& cuid | |
261 | \& cgid | |
262 | \& mode | |
263 | \& ctime | |
264 | \& otime | |
265 | \& nsems | |
266 | .Ve | |
267 | .SH "SEE ALSO" | |
268 | .IX Header "SEE ALSO" | |
269 | IPC::SysV Class::Struct semget semctl semop | |
270 | .SH "AUTHOR" | |
271 | .IX Header "AUTHOR" | |
272 | Graham Barr <gbarr@pobox.com> | |
273 | .SH "COPYRIGHT" | |
274 | .IX Header "COPYRIGHT" | |
275 | Copyright (c) 1997 Graham Barr. All rights reserved. | |
276 | This program is free software; you can redistribute it and/or modify it | |
277 | under the same terms as Perl itself. |