-
Notifications
You must be signed in to change notification settings - Fork 708
/
stream-lock.xml
135 lines (125 loc) · 3.28 KB
/
stream-lock.xml
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="streamwrapper.stream-lock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>streamWrapper::stream_lock</refname>
<refpurpose>Advisory file locking</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>streamWrapper::stream_lock</methodname>
<methodparam><type>int</type><parameter>operation</parameter></methodparam>
</methodsynopsis>
<para>
This method is called in response to <function>flock</function>, when
<function>file_put_contents</function> (when <parameter>flags</parameter>
contains <constant>LOCK_EX</constant>),
<function>stream_set_blocking</function> and when closing the stream
(<constant>LOCK_UN</constant>).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>operation</parameter></term>
<listitem>
<para>
<parameter>operation</parameter> is one of the following:
<itemizedlist>
<listitem>
<simpara>
<constant>LOCK_SH</constant> to acquire a shared lock (reader).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>LOCK_EX</constant> to acquire an exclusive lock (writer).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>LOCK_UN</constant> to release a lock (shared or exclusive).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>LOCK_NB</constant> if you don't want
<function>flock</function> to block while locking.
(not supported on Windows)
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<para>
Emits <constant>E_WARNING</constant> if call to this method fails (i.e. not implemented).
</para>
</refsect1><!-- }}} -->
<!--
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>streamWrapper::stream_lock</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
]]>
</screen>
</example>
</para>
</refsect1>
-->
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>stream_set_blocking</function></member>
<member><function>flock</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->