File: function.flock.html

package info (click to toggle)
php3 3%3A3.0.18-0potato1.1
  • links: PTS
  • area: main
  • in suites: potato
  • size: 17,736 kB
  • ctags: 11,198
  • sloc: ansic: 108,120; sh: 2,512; php: 2,024; yacc: 1,887; makefile: 1,038; perl: 537; pascal: 238; awk: 90; cpp: 28; sql: 11
file content (269 lines) | stat: -rw-r--r-- 3,758 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<HTML
><HEAD
><TITLE
>flock</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="Filesystem functions"
HREF="ref.filesystem.html"><LINK
REL="PREVIOUS"
TITLE="filetype"
HREF="function.filetype.html"><LINK
REL="NEXT"
TITLE="fopen"
HREF="function.fopen.html"><META
NAME="HTTP_EQUIV"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.filetype.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.fopen.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.flock"
>flock</A
></H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN11120"
></A
><P
>    (PHP3 &#62;= 3.0.7, PHP4 )</P
>flock&nbsp;--&nbsp;Portable advisory file locking</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN11123"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><A
NAME="AEN11125"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>bool <B
CLASS="function"
>flock</B
></CODE
> (int fp, int operation [, int 
       wouldblock])</CODE
></P
><P
></P
></DIV
><P
>&#13;     PHP supports a portable way of locking complete files in an
     advisory way (which means all accessing programs have to use the
     same way of locking or it will not work).
    </P
><P
>&#13;     <B
CLASS="function"
>flock()</B
> operates on <TT
CLASS="parameter"
><I
>fp</I
></TT
>
     which must be an open file
     pointer. <TT
CLASS="parameter"
><I
>operation</I
></TT
> is one of the following
     values:
    </P
><P
>&#13;     <P
></P
><UL
><LI
><P
>&#13;	To acquire a shared lock (reader), set
	<TT
CLASS="parameter"
><I
>operation</I
></TT
> to LOCK_SH (set to 1 prior to
	PHP 4.0.1).
       </P
></LI
><LI
><P
>&#13;	To acquire an exclusive lock (writer), set
	<TT
CLASS="parameter"
><I
>operation</I
></TT
> to LOCK_EX (set to 2 prior to
	PHP 4.0.1).
       </P
></LI
><LI
><P
>&#13;	To release a lock (shared or exclusive), set
	<TT
CLASS="parameter"
><I
>operation</I
></TT
> to LOCK_UN (set to 3 prior to
	PHP 4.0.1).
       </P
></LI
><LI
><P
>&#13;	If you don't want <B
CLASS="function"
>flock()</B
> to block while
	locking, add LOCK_NB (4 prior to PHP 4.0.1) to
	<TT
CLASS="parameter"
><I
>operation</I
></TT
>.
       </P
></LI
></UL
>
    </P
><P
>&#13;     <B
CLASS="function"
>Flock()</B
> allows you to perform a simple
     reader/writer model which can be used on virtually every platform
     (including most Unices and even Windows).  The optional 3rd
     argument is set to true if the lock would block (EWOULDBLOCK
     errno condition)
    </P
><P
>&#13;     <B
CLASS="function"
>Flock()</B
> returns true on success and false on
     error (e.g. when a lock could not be acquired).
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.filetype.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.fopen.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>filetype</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.filesystem.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>fopen</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>