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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.dio-fcntl" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>dio_fcntl</refname>
<refpurpose>Performs a c library fcntl on fd</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>dio_fcntl</methodname>
<methodparam><type>resource</type><parameter>fd</parameter></methodparam>
<methodparam><type>int</type><parameter>cmd</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>args</parameter></methodparam>
</methodsynopsis>
<para>
The <function>dio_fcntl</function> function performs the
operation specified by <parameter>cmd</parameter> on the file
descriptor <parameter>fd</parameter>. Some commands require
additional arguments <parameter>args</parameter> to be supplied.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
The file descriptor returned by <function>dio_open</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cmd</parameter></term>
<listitem>
<para>
Can be one of the following operations:
<itemizedlist>
<listitem>
<para>
<constant>F_SETLK</constant> - Lock is set or cleared. If the lock
is held by someone else <function>dio_fcntl</function> returns
-1.
</para>
</listitem>
<listitem>
<para>
<constant>F_SETLKW</constant> - like <constant>F_SETLK</constant>,
but in case the lock is held by someone else,
<function>dio_fcntl</function> waits until the lock is released.
</para>
</listitem>
<listitem>
<para>
<constant>F_GETLK</constant> - <function>dio_fcntl</function>
returns an associative array (as described above) if someone else
prevents lock. If there is no obstruction key "type" will set
to <constant>F_UNLCK</constant>.
</para>
</listitem>
<listitem>
<para>
<constant>F_DUPFD</constant> - finds the lowest numbered available
file descriptor greater than or equal to <parameter>args</parameter>
and returns them.
</para>
</listitem>
<listitem>
<para>
<constant>F_SETFL</constant> - Sets the file descriptors flags to
the value specified by <parameter>args</parameter>, which can be
<constant>O_APPEND</constant>, <constant>O_NONBLOCK</constant> or
<constant>O_ASYNC</constant>. To use <constant>O_ASYNC</constant>
you will need to use the <link linkend="ref.pcntl">PCNTL</link>
extension.
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem>
<para>
<parameter>args</parameter> is an associative array, when
<parameter>cmd</parameter> is <constant>F_SETLK</constant> or
<constant>F_SETLLW</constant>, with the following keys:
<itemizedlist>
<listitem>
<para>
"start" - offset where lock begins
</para>
</listitem>
<listitem>
<para>
"length" - size of locked area. zero means to end of file
</para>
</listitem>
<listitem>
<para>
"wenth" - Where l_start is relative to: can be
<constant>SEEK_SET</constant>,
<constant>SEEK_END</constant> and <constant>SEEK_CUR</constant>
</para>
</listitem>
<listitem>
<para>
"type" - type of lock: can be <constant>F_RDLCK</constant> (read
lock), <constant>F_WRLCK</constant> (write lock) or
<constant>F_UNLCK</constant> (unlock)
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the result of the C call.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Setting and clearing a lock</title>
<programlisting role="php">
<![CDATA[
<?php
$fd = dio_open('/dev/ttyS0', O_RDWR);
if (dio_fcntl($fd, F_SETLK, Array("type"=>F_WRLCK)) == -1) {
// the file descriptor appears locked
echo "The lock can not be cleared. It is held by someone else.";
} else {
echo "Lock succesfully set/cleared";
}
dio_close($fd);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
¬e.no-windows;
</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
-->
|
