File: dio.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (374 lines) | stat: -rw-r--r-- 12,722 bytes parent folder | download
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $EN-Revision: 1.60 maintainer: georg  status: ready$ -->
 <reference id="ref.dio">
  <title>Direkte Ein-/Ausgabe Funktionen</title>
  <titleabbrev>Direkte Ein-/Ausgabe Funktionen</titleabbrev>

  <partintro>
   <section id="dio.intro">
    <title>Direkte Ein-/Ausgabe Funktionen</title>
    <para>
     PHP untersttzt die direkte Ein-/Ausgabe-Funktionen, beschrieben
     im Posix Standard (Kapitel 6) fr die Ein- und Ausgabe auf einer
     niederen Ebene als die standardmssig verwendeten C-Funktionen
     (fopen, fread, ...).
    </para>
   </section>
   <section id="dio.installation">
    <title>Installation</title>
    <para>
     Um die DIO Funktionen benutzen zu knnen, muss PHP mit der Option
     <option role="configure">--enable-dio</option> konfiguriert
     werden.
    </para>
   </section>
  </partintro>
 
  <refentry id="function.dio-open">
   <refnamediv>
    <refname>dio_open</refname>
    <refpurpose>
     ffnet eine Datei mit den angegebenen Rechten
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>resource</type><methodname>dio_open</methodname>
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
      <methodparam><type>int</type><parameter>flags</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>dio_open</function> ffnet eine Datei und liefert einen
     Dateizeiger zurck. Im Fehlerfall liefert
     <function>dio_open</function> -1 zurck.  Ist der Parameter
     <parameter>flags</parameter> O_CREAT, so gibt der optionale
     Parameter <parameter>mode</parameter> die Dateirechte an.  Der
     Parameter <parameter>flags</parameter> kann eine der folgenden
     Zugriffsmethoden sein:
     <itemizedlist>
      <listitem>
       <para>
        O_RDONLY - ffnet die Datei fr Lesezugriff
       </para>
      </listitem>
      <listitem>
       <para>
        O_WRONLY - ffnet die Datei fr
        Schreibzugriff
       </para>
      </listitem>
      <listitem>
       <para>
        O_RDWR - ffnet die Datei fr Schreib- und Lesezugriff
       </para>
      </listitem>
     </itemizedlist>
     Diese Zugriffsmethoden knnen mit folgenden Attributen kombiniert
     werden:
     <itemizedlist>
      <listitem>
       <para>
        O_CREAT - erzeugt die Datei, falls diese nicht existiert
       </para>
      </listitem>
      <listitem>
       <para>
        O_EXCL - in Kombination mit O_CREAT wird ein Fehler (-1)
        zurckgegeben, wenn die Datei bereits existiert
       </para>
      </listitem>
      <listitem>
       <para>
        O_TRUNC - falls die Datei bereits existiert, und sie fr
        Schreibzugriff geffnet wird, wird diese auf die Grsse 0
        zurckgesetzt
       </para>
      </listitem>
      <listitem>
       <para>
        O_APPEND - setzt den Zeiger fr Schreiboperationen an das Ende
        der Datei
       </para>
      </listitem>
      <listitem>
       <para>
        O_NONBLOCK - Setzt den Modus auf "nonblocking"
       </para>
      </listitem> 
     </itemizedlist>
    </para>
   </refsect1>
  </refentry>
	
  <refentry id="function.dio-read">
   <refnamediv>
    <refname>dio_read</refname>
    <refpurpose>
     Liest n Bytes und gibt sie zurck, ist n nicht angegeben wird ein
     1K Block gelesen
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>dio_read</methodname>
      <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>n</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>dio_read</function> liest
     <parameter>n</parameter> Bytes aus der Datei
     <parameter>fd</parameter> und gibt diese zurck. Wird der
     optionale Parameter <parameter>n</parameter> nicht angegeben,
     wird standardmssig ein 1K Block gelesen und zurckgegeben.
    </para>
   </refsect1>
  </refentry>
	
  <refentry id="function.dio-write">
   <refnamediv>
    <refname>dio_write</refname>
    <refpurpose>Schreibt Daten in eine Datei</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>dio_write</methodname>
      <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
      <methodparam><type>string</type><parameter>data</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>len</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>dio_write</function> schreibt bis zu
     <parameter>len</parameter> Bytes an Daten
     <parameter>data</parameter> in die Datei
     <parameter>fd</parameter>.  Wird der optionale Parameter
     <parameter>len</parameter> nicht angegeben, so werden alle Daten
     <parameter>data</parameter> in die Datei geschrieben.
     <function>dio_write</function> liefert die Anzahl der Bytes
     zurck, die in die Datei geschrieben wurden.
    </para>
   </refsect1>
  </refentry>
	
  <refentry id="function.dio-truncate">
   <refnamediv>
    <refname>dio_truncate</refname>
    <refpurpose>Schneidet eine Datei ab</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>dio_truncate</methodname>
      <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
      <methodparam><type>int</type><parameter>offset</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>dio_truncate</function> schneidet die
     Datei <parameter>fd</parameter> nach
     <parameter>offset</parameter> ab.  War die Datei ursprnglich
     grsser, so gehen die Daten verloren. War sie kleiner so wird sie
     mit Nullen aufgefllt.
    </para>
   </refsect1>
  </refentry>
	
  <refentry id="function.dio-stat">
   <refnamediv>
    <refname>dio_stat</refname>
    <refpurpose>Liefert Statusinformationen ber eine Datei</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>dio_stat</methodname>
      <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>fstat</function> gibts ein assoziatives
     Array zurck, welches Informationen ber die Datei
     <parameter>fd</parameter> enthlt.  Das Array enthlt folgende
     Eintrge:
     <itemizedlist>
      <listitem><para>"device" - Device</para></listitem>
      <listitem><para>"inode" - Inode</para></listitem>
      <listitem><para>"mode" - Modus</para></listitem>
      <listitem><para>"nlink" - Anzahl Links</para></listitem>
      <listitem><para>"uid" - Benutzer Id</para></listitem>
      <listitem><para>"gid" - Gruppentyp</para></listitem>
      <listitem><para>"device_type" - Device Typ</para></listitem>
      <listitem><para>"size" - Grsse in Bytes</para></listitem>
      <listitem><para>"blocksize" - Blockgrsse</para></listitem>
      <listitem><para>"blocks" - Anzahl allocierter Blcke</para></listitem>
      <listitem><para>"atime" - Letzter Zugriff</para></listitem>
      <listitem><para>"mtime" - Letze Modifikation</para></listitem>
      <listitem><para>"ctime" - Letzte nderung</para></listitem>
     </itemizedlist>
     Im Fehlerfall liefert <function>dio_stat</function> NULL zurck.
    </para>
   </refsect1>
  </refentry>
	
  <refentry id="function.dio-seek">
   <refnamediv>
    <refname>dio_seek</refname>
    <refpurpose>Setzt den Dateizeiger</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>dio_seek</methodname>
      <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
      <methodparam><type>int</type><parameter>pos</parameter></methodparam>
      <methodparam><type>int</type><parameter>whence</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>dio_seek</function> setzt den Dateizeiger
     der Datei <parameter>fd</parameter>.  Der
     <parameter>whence</parameter> gibt dabei an, wie die Position
     <parameter>pos</parameter> interpretiert werden soll:
     <itemizedlist>
      <listitem>
       <para>
        SEEK_SET - gibt an, dass <parameter>pos</parameter> die
        Position vom Anfang der Datei ist
       </para>
      </listitem>
      <listitem>
       <para>
        SEEK_CUR - gibt an, dass <parameter>pos</parameter> die
        Position relativ von der momentanen Dateizeigerposition ist.
       </para>
      </listitem>
      <listitem>
       <para>
        SEEK_END - gibt an, dass <parameter>pos</parameter> die
        Position relativ zum Dateiende ist. Eine negative Zahl setzt
        den Dateizeiger innerhalb der Datei, ein positvier Wert
        bewirkt, dass die Datei vom Ende bis zur neuen Position mit
        Nullen aufgefllt wird.
       </para>
      </listitem> 
     </itemizedlist>
    </para>
   </refsect1>
  </refentry>
	
  <refentry id="function.dio-fcntl">
   <refnamediv>
    <refname>dio_fcntl</refname>
    <refpurpose>ndert den Dateideskriptor</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <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>arg</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>dio_fcntl</function> fhrt eine Aktion
     <parameter>cmd</parameter> an der Datei <parameter>fd</parameter>
     aus.  Einige Aktionen <parameter>cmd</parameter> bentigen das
     zustzliche Argument <parameter>args</parameter>.
    </para>
    <para>
     <parameter>arg</parameter> ist ein assoziatives Array, wenn
     <parameter>cmd</parameter> F_SETLK oder F_SETLLW ist. Es hat
     folgende Eintrge:
     <itemizedlist>
      <listitem>
       <para>
        "start" - offset an dem der Lock beginnt
       </para>
      </listitem> 
      <listitem>
       <para>
        "length" - Lnge des gelockten Bereichs
       </para>
      </listitem>
      <listitem>
       <para>
        "wenth" - Relative Position von start. Kann folgende Werte
        annehmen: SEEK_SET, SEEK_END and SEEK_CUR
       </para>
      </listitem> 
      <listitem>
       <para>
        "type" - Locktyp: F_RDLCK (read lock), F_WRLCK (write lock)
        oder F_UNLCK (unlock)
       </para>
      </listitem>
     </itemizedlist>
    </para>
    <para>
     <parameter>cmd</parameter> ist einer der folgenden Konstanten:
     <itemizedlist>
      <listitem>
       <para>
        F_SETLK - Setzt oder lscht einen Lock. Ist der Bereich
        bereits von einem anderen Prozess gelockt, so liefert die
        Funktion <function>dio_fcntl</function> -1 zurck.
       </para>
      </listitem>
      <listitem>
       <para>
        F_SETLKW - wie F_SETLK, jedoch im Falle, dass der Bereich von
        einem anderen Prozess gelockt wird, wartet
        <function>dio_fcntl</function> auf die Freigabe des Locks.
       </para>
      </listitem> 
      <listitem>
       <para>
        F_GETLK - <function>dio_fcntl</function> liefert ein
        assioziatives Array zurck (Beschreibung siehe oben), falls
        ein anderer Prozess den Bereich gelockt hat.
       </para>
      </listitem>
     </itemizedlist>
    </para>
   </refsect1>
  </refentry>
	
  <refentry id="function.dio-close">
   <refnamediv>
    <refname>dio_close</refname>
    <refpurpose>Schliesst die Datei</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>void</type><methodname>dio_close</methodname>
      <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>dio_close</function> schliesst die Datei
     <parameter>fd</parameter>.
    </para>
   </refsect1>
  </refentry>
	
 </reference>
 
<!-- 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:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->