php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

eio: fix XML by converting para to simpara tags via script (#5147)

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-25 15:47:41 +00:00
committed by GitHub
parent bc54f5d44b
commit 4e53894013
63 changed files with 683 additions and 899 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
reference/eio/book.xml
View File

@@ -1,18 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<book xml:id="book.eio" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.eio">
<?phpdoc extension-membership="pecl" ?>
<title>Eio</title>
<titleabbrev>Eio</titleabbrev>
<!--{{{ preface -->
<preface xml:id="intro.eio">
&reftitle.intro;
<para>
This extension provides asyncronous POSIX I/O by means of <link
xlink:href="&url.eio.libeio;">libeio</link> C
<simpara>
This extension provides asyncronous POSIX I/O by means of <link xlink:href="&url.eio.libeio;">libeio</link> C
library written by Marc Lehmann.
</para>
</simpara>
&note.no-windows.extension;
@@ -141,7 +139,7 @@ eio_mkdir("/tmp/abc-eio-temp", 0750, EIO_PRI_DEFAULT, "my_res_cb", "mkdir data")
// set event flags
event_set($event, $fd, EV_READ /*| EV_PERSIST*/, "my_eio_poll", array($event, $base));
// set event base
// set event base
event_base_set($event, $base);
// enable event
@@ -164,7 +162,6 @@ event_base_loop($base);
&reference.eio.reference;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/eio/configure.xml
View File

@@ -1,20 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="eio.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eio.installation">
&reftitle.install;
<para>
<simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;eio">&url.pecl.package;eio</link>.
</para>
<para>
</simpara>
<simpara>
For information about manual installation, please
read the file <filename>INSTALL</filename> included in the package.
</para>
</simpara>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/eio/constants.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="eio.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<appendix xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eio.constants">
&reftitle.constants;
&extension.constants;
@@ -638,27 +637,26 @@
</para>
<note xmlns="http://docbook.org/ns/docbook">
<para>
<simpara>
<emphasis>EIO_S_I*</emphasis> constants have the same meaning as their
<emphasis>S_I*</emphasis> POSIX counterparts.
</para>
</simpara>
</note>
<note xmlns="http://docbook.org/ns/docbook">
<para>
<simpara>
<emphasis>EIO_SYNC_FILE_*</emphasis> constants have the same meaning as their
<emphasis>SYNC_FILE_**</emphasis> counterparts.
</para>
</simpara>
</note>
<note xmlns="http://docbook.org/ns/docbook">
<para>
<simpara>
<emphasis>EIO_O_*</emphasis> constants have the same meaning as their
<emphasis>O_*</emphasis> POSIX counterparts.
</para>
</simpara>
</note>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

33
reference/eio/functions/eio-busy.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-busy" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-busy">
<refnamediv>
<refname>eio_busy</refname>
<refpurpose>Artificially increase load. Could be useful in tests,
@@ -13,18 +12,15 @@
<methodsynopsis>
<type>resource</type><methodname>eio_busy</methodname>
<methodparam><type>int</type><parameter>delay</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_busy</function> artificially increases load taking
<parameter>delay</parameter> seconds to execute. May be used for debugging,
or benchmarking.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -33,9 +29,9 @@
<varlistentry>
<term><parameter>delay</parameter></term>
<listitem>
<para>
<simpara>
Delay in seconds
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -47,17 +43,17 @@
<varlistentry>
<term><parameter>callback</parameter></term>
<listitem>
<para>
<simpara>
This callback is called when all the group requests are done.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -65,9 +61,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_busy</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso"> &reftitle.seealso;
@@ -77,7 +73,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/eio/functions/eio-cancel.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-cancel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-cancel">
<refnamediv>
<refname>eio_cancel</refname>
<refpurpose>Cancels a request</refpurpose>
@@ -13,10 +12,10 @@
<type>void</type><methodname>eio_cancel</methodname>
<methodparam><type>resource</type><parameter>req</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_cancel</function> cancels a request specified by
<parameter>req</parameter>
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +24,9 @@
<varlistentry>
<term><parameter>req</parameter></term>
<listitem>
<para>
<simpara>
The request resource
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -45,9 +44,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -55,9 +54,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -104,7 +103,6 @@ my_nop 2
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

29
reference/eio/functions/eio-chmod.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-chmod" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-chmod">
<refnamediv>
<refname>eio_chmod</refname>
<refpurpose>Change file/directory permissions</refpurpose>
@@ -13,17 +12,14 @@
<type>resource</type><methodname>eio_chmod</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_chmod</function> changes file, or directory permissions. The
new permissions are specified by <parameter>mode</parameter>.
</para>
</simpara>
</refsect1>
@@ -42,9 +38,9 @@
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
<simpara>
The new permissions. E.g. <literal>0644</literal>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -62,9 +58,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -72,9 +68,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_chmod</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -85,7 +81,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

36
reference/eio/functions/eio-chown.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-chown" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-chown">
<refnamediv>
<refname>eio_chown</refname>
<refpurpose>Change file/directory permissions</refpurpose>
@@ -13,18 +12,14 @@
<type>resource</type><methodname>eio_chown</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>int</type><parameter>uid</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>gid</parameter><initializer>-1</initializer></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>gid</parameter><initializer>-1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Changes file, or directory permissions.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -42,17 +37,17 @@
<varlistentry>
<term><parameter>uid</parameter></term>
<listitem>
<para>
<simpara>
User ID. Is ignored when equal to -1.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>gid</parameter></term>
<listitem>
<para>
<simpara>
Group ID. Is ignored when equal to -1.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -70,9 +65,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -80,9 +75,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_chown</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
@@ -94,7 +89,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

29
reference/eio/functions/eio-close.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-close" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-close">
<refnamediv>
<refname>eio_close</refname>
<refpurpose>Close file</refpurpose>
@@ -12,17 +11,14 @@
<methodsynopsis>
<type>resource</type><methodname>eio_close</methodname>
<methodparam><type>mixed</type><parameter>fd</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_close</function> closes file specified by
<parameter>fd</parameter>.
</para>
</simpara>
</refsect1>
@@ -32,9 +28,9 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
Stream, Socket resource, or numeric file descriptor
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -52,9 +48,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -62,9 +58,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_close</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -75,7 +71,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

19
reference/eio/functions/eio-custom.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-custom" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-custom">
<refnamediv>
<refname>eio_custom</refname>
<refpurpose>Execute custom request like any other <emphasis>eio_*</emphasis> call</refpurpose>
@@ -14,13 +13,12 @@
<methodparam><type>callable</type><parameter>execute</parameter></methodparam>
<methodparam><type>int</type><parameter>pri</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_custom</function> executes custom function specified by
<parameter>execute</parameter> processing it just like any other <emphasis>eio_*</emphasis> call.
</para>
</simpara>
</refsect1>
@@ -65,9 +63,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -75,9 +73,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_custom</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
@@ -131,7 +129,6 @@ int(1001)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

33
reference/eio/functions/eio-dup2.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-dup2" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-dup2">
<refnamediv>
<refname>eio_dup2</refname>
<refpurpose>Duplicate a file descriptor</refpurpose>
@@ -13,17 +12,14 @@
<type>resource</type><methodname>eio_dup2</methodname>
<methodparam><type>mixed</type><parameter>fd</parameter></methodparam>
<methodparam><type>mixed</type><parameter>fd2</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_dup2</function> duplicates file descriptor.
</para>
</simpara>
</refsect1>
@@ -33,17 +29,17 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
Source stream, Socket resource, or numeric file descriptor
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fd2</parameter></term>
<listitem>
<para>
<simpara>
Target stream, Socket resource, or numeric file descriptor
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -61,9 +57,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -71,13 +67,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_dup2</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/eio/functions/eio-event-loop.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-event-loop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-event-loop">
<refnamediv>
<refname>eio_event_loop</refname>
<refpurpose>Polls libeio until all requests proceeded</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>eio_event_loop</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
<function>eio_event_loop</function> polls libeio until all requests proceeded.
</para>
</simpara>
</refsect1>
@@ -26,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_event_loop</function> returns &true; on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -76,7 +75,6 @@ eio_chmod_ok
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

45
reference/eio/functions/eio-fallocate.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-fallocate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-fallocate">
<refnamediv>
<refname>eio_fallocate</refname>
<refpurpose>Allows the caller to directly manipulate the allocated disk
@@ -16,28 +15,25 @@
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_fallocate</function> allows the caller to directly manipulate the allocated disk space for the
file specified by <parameter>fd</parameter> file descriptor for the byte
range starting at <parameter>offset</parameter> and continuing for
<parameter>length</parameter> bytes.
</para>
</simpara>
<note xmlns="http://docbook.org/ns/docbook">
<title>File should be opened for writing</title>
<para><constant>EIO_O_CREAT</constant> should be logically
<simpara><constant>EIO_O_CREAT</constant> should be logically
<emphasis>OR</emphasis>'d with <constant>EIO_O_WRONLY</constant>, or
<constant>EIO_O_RDWR</constant>
</para>
</simpara>
</note>
</refsect1>
@@ -48,34 +44,34 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
Stream, Socket resource, or numeric file descriptor, e.g. returned by <function>eio_open</function>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>Currently only one flag is supported for mode:
<simpara>Currently only one flag is supported for mode:
<constant>EIO_FALLOC_FL_KEEP_SIZE</constant> (the same as POSIX constant
<constant>FALLOC_FL_KEEP_SIZE</constant>).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
<simpara>
Specifies start of the byte range.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
<simpara>
Specifies length the byte range.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -93,9 +89,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -103,13 +99,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_fallocate</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

33
reference/eio/functions/eio-fchmod.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-fchmod" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-fchmod">
<refnamediv>
<refname>eio_fchmod</refname>
<refpurpose>Change file permissions</refpurpose>
@@ -13,17 +12,14 @@
<type>resource</type><methodname>eio_fchmod</methodname>
<methodparam><type>mixed</type><parameter>fd</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_fchmod</function> changes permissions for the file specified
by <parameter>fd</parameter> file descriptor.
</para>
</simpara>
</refsect1>
@@ -33,17 +29,17 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
Stream, Socket resource, or numeric file descriptor, e.g. returned by <function>eio_open</function>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
<simpara>
The new permissions. E.g. 0644.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -61,9 +57,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -71,9 +67,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_fchmod</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -84,7 +80,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

39
reference/eio/functions/eio-fchown.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-fchown" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-fchown">
<refnamediv>
<refname>eio_fchown</refname>
<refpurpose>Change file ownership</refpurpose>
@@ -14,17 +13,14 @@
<methodparam><type>mixed</type><parameter>fd</parameter></methodparam>
<methodparam><type>int</type><parameter>uid</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>gid</parameter><initializer>-1</initializer></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_fchown</function> changes ownership of the file specified by
<parameter>fd</parameter> file descriptor.
</para>
</simpara>
</refsect1>
@@ -34,25 +30,25 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
Stream, Socket resource, or numeric file descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>uid</parameter></term>
<listitem>
<para>
<simpara>
User ID. Is ignored when equal to -1.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>gid</parameter></term>
<listitem>
<para>
<simpara>
Group ID. Is ignored when equal to -1.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -70,9 +66,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -80,11 +76,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_chmod</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
@@ -93,7 +89,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

29
reference/eio/functions/eio-fdatasync.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-fdatasync" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-fdatasync">
<refnamediv>
<refname>eio_fdatasync</refname>
<refpurpose>Synchronize a file's in-core state with storage device</refpurpose>
@@ -12,16 +11,13 @@
<methodsynopsis>
<type>resource</type><methodname>eio_fdatasync</methodname>
<methodparam><type>mixed</type><parameter>fd</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_fdatasync</function> synchronizes a file's in-core state with storage device.
</para>
</simpara>
</refsect1>
@@ -31,9 +27,9 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
Stream, Socket resource, or numeric file descriptor, e.g. returned by <function>eio_open</function>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -51,9 +47,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -61,13 +57,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_fdatasync</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/eio/functions/eio-fstat.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-fstat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-fstat">
<refnamediv>
<refname>eio_fstat</refname>
<refpurpose>Get file status</refpurpose>
@@ -16,10 +15,10 @@
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_fstat</function> returns file status information in
<parameter>result</parameter> argument of <parameter>callback</parameter>
</para>
</simpara>
</refsect1>
@@ -29,9 +28,9 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
Stream, Socket resource, or numeric file descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -49,9 +48,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -59,9 +58,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_busy</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -153,7 +152,6 @@ array(12) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/eio/functions/eio-fstatvfs.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-fstatvfs" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-fstatvfs">
<refnamediv>
<refname>eio_fstatvfs</refname>
<refpurpose>Get file system statistics</refpurpose>
@@ -16,10 +15,10 @@
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_fstatvfs</function> returns file system statistics in
<parameter>result</parameter> of <parameter>callback</parameter>.
</para>
</simpara>
</refsect1>
@@ -29,9 +28,9 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
A file descriptor of a file within the mounted file system.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -49,9 +48,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -59,9 +58,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_fstatvfs</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -72,7 +71,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

29
reference/eio/functions/eio-fsync.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-fsync" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-fsync">
<refnamediv>
<refname>eio_fsync</refname>
<refpurpose>Synchronize a file's in-core state with storage device</refpurpose>
@@ -12,16 +11,13 @@
<methodsynopsis>
<type>resource</type><methodname>eio_fsync</methodname>
<methodparam><type>mixed</type><parameter>fd</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Synchronize a file's in-core state with storage device
</para>
</simpara>
</refsect1>
@@ -31,9 +27,9 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
Stream, Socket resource, or numeric file descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -51,9 +47,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -61,9 +57,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_fsync</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
@@ -75,7 +71,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

33
reference/eio/functions/eio-ftruncate.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-ftruncate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-ftruncate">
<refnamediv>
<refname>eio_ftruncate</refname>
<refpurpose>Truncate a file</refpurpose>
@@ -13,18 +12,15 @@
<type>resource</type><methodname>eio_ftruncate</methodname>
<methodparam><type>mixed</type><parameter>fd</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_ftruncate</function> causes a regular file referenced by
<parameter>fd</parameter> file descriptor to be truncated to precisely
<parameter>length</parameter> bytes.
</para>
</simpara>
</refsect1>
@@ -34,17 +30,17 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
Stream, Socket resource, or numeric file descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
<simpara>
Offset from beginning of the file
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -62,9 +58,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -72,9 +68,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_ftruncate</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
@@ -86,7 +82,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

37
reference/eio/functions/eio-futime.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-futime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-futime">
<refnamediv>
<refname>eio_futime</refname>
<refpurpose>Change file last access and modification times</refpurpose>
@@ -14,18 +13,15 @@
<methodparam><type>mixed</type><parameter>fd</parameter></methodparam>
<methodparam><type>float</type><parameter>atime</parameter></methodparam>
<methodparam><type>float</type><parameter>mtime</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_futime</function> changes file last access and modification
times.
</para>
</simpara>
</refsect1>
@@ -35,25 +31,25 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
Stream, Socket resource, or numeric file descriptor, e.g. returned by <function>eio_open</function>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>atime</parameter></term>
<listitem>
<para>
<simpara>
Access time
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mtime</parameter></term>
<listitem>
<para>
<simpara>
Modification time
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -71,9 +67,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -81,9 +77,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_futime</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -94,7 +90,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/eio/functions/eio-get-event-stream.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-get-event-stream" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-get-event-stream">
<refnamediv>
<refname>eio_get_event_stream</refname>
<refpurpose>Get stream representing a variable used in internal communications with libeio</refpurpose>
@@ -11,14 +10,14 @@
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>eio_get_event_stream</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
<function>eio_get_event_stream</function> acquires stream representing a
variable used in internal communications with libeio. Could be used to bind
with some event loop provided by other PECL extension, for example
libevent.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,10 +27,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_get_event_stream</function> returns stream on success;
otherwise, &null;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -67,7 +66,7 @@ eio_mkdir("/tmp/abc-eio-temp", 0750, EIO_PRI_DEFAULT, "my_res_cb", "mkdir data")
// set event flags
event_set($event, $fd, EV_READ /*| EV_PERSIST*/, "my_eio_poll", array($event, $base));
// set event base
// set event base
event_base_set($event, $base);
// enable event
@@ -95,7 +94,6 @@ string(10) "mkdir data"
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/eio/functions/eio-get-last-error.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-get-last-error" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-get-last-error">
<refnamediv>
<refname>eio_get_last_error</refname>
<refpurpose>Returns string describing the last error associated with a request resource</refpurpose>
@@ -13,9 +12,9 @@
<type>string</type><methodname>eio_get_last_error</methodname>
<methodparam><type>resource</type><parameter>req</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_get_last_error</function> returns string describing the last error associated with <parameter>req</parameter>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +23,9 @@
<varlistentry>
<term><parameter>req</parameter></term>
<listitem>
<para>
<simpara>
The request resource.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,13 +33,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_get_last_error</function> returns string describing the last error associated with the request resource specified by <parameter>req</parameter>.
</para>
</simpara>
&warn.experimental.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/eio/functions/eio-grp-add.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-grp-add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-grp-add">
<refnamediv>
<refname>eio_grp_add</refname>
<refpurpose>Adds a request to the request group</refpurpose>
@@ -14,9 +13,9 @@
<methodparam><type>resource</type><parameter>grp</parameter></methodparam>
<methodparam><type>resource</type><parameter>req</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_grp_add</function> adds a request to the request group.
</para>
</simpara>
</refsect1>
@@ -26,17 +25,17 @@
<varlistentry>
<term><parameter>grp</parameter></term>
<listitem>
<para>
<simpara>
The request group resource returned by <function>eio_grp</function>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>req</parameter></term>
<listitem>
<para>
<simpara>
The request resource
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -44,9 +43,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -131,7 +130,6 @@ bool(true)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/eio/functions/eio-grp-cancel.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-grp-cancel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-grp-cancel">
<refnamediv>
<refname>eio_grp_cancel</refname>
<refpurpose>Cancels a request group</refpurpose>
@@ -13,10 +12,10 @@
<type>void</type><methodname>eio_grp_cancel</methodname>
<methodparam><type>resource</type><parameter>grp</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_grp_cancel</function> cancels a group request specified by
<parameter>grp</parameter> request group resource.
</para>
</simpara>
</refsect1>
@@ -26,9 +25,9 @@
<varlistentry>
<term><parameter>grp</parameter></term>
<listitem>
<para>
<simpara>
The request group resource returned by <function>eio_grp</function>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,9 +35,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -50,7 +49,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/eio/functions/eio-grp-limit.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-grp-limit" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-grp-limit">
<refnamediv>
<refname>eio_grp_limit</refname>
<refpurpose>Set group limit</refpurpose>
@@ -14,9 +13,9 @@
<methodparam><type>resource</type><parameter>grp</parameter></methodparam>
<methodparam><type>int</type><parameter>limit</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Limit number of requests in the request group.
</para>
</simpara>
</refsect1>
@@ -26,17 +25,17 @@
<varlistentry>
<term><parameter>grp</parameter></term>
<listitem>
<para>
<simpara>
The request group resource.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>limit</parameter></term>
<listitem>
<para>
<simpara>
Number of requests in the group.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -44,9 +43,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -57,7 +56,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

19
reference/eio/functions/eio-grp.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-grp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-grp">
<refnamediv>
<refname>eio_grp</refname>
<refpurpose>Creates a request group</refpurpose>
@@ -12,12 +11,11 @@
<methodsynopsis>
<type>resource</type><methodname>eio_grp</methodname>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_grp</function> creates a request group.
</para>
</simpara>
</refsect1>
@@ -33,9 +31,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -43,9 +41,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_grp</function> returns request group resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -124,7 +122,6 @@ string(4) "some"
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/eio/functions/eio-init.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-init" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-init">
<refnamediv>
<refname>eio_init</refname>
<refpurpose>(Re-)initialize Eio</refpurpose>
@@ -11,15 +10,15 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>eio_init</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
<function>eio_init</function> (re-)initializes Eio. It allocates memory for internal structures of libeio and Eio itself. You may call <function>eio_init</function> before using Eio functions. Otherwise it will be called internally first time you invoke an Eio function in a process.
</para>
</simpara>
<note>
<para>
<simpara>
This function was removed in version 3.0.0RC1 of the eio extension for PHP version 8 and higher.
</para>
</simpara>
</note>
</refsect1>
@@ -30,12 +29,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

33
reference/eio/functions/eio-link.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-link" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-link">
<refnamediv>
<refname>eio_link</refname>
<refpurpose>Create a hardlink for file</refpurpose>
@@ -13,18 +12,15 @@
<type>resource</type><methodname>eio_link</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>string</type><parameter>new_path</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_link</function> creates a hardlink
<parameter>new_path</parameter> for a file specified by
<parameter>path</parameter>.
</para>
</simpara>
</refsect1>
@@ -34,17 +30,17 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
Source file path.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>new_path</parameter></term>
<listitem>
<para>
<simpara>
Target file path.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -62,9 +58,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -72,9 +68,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -140,7 +136,6 @@ string(%d) "%ssymlink.dat"
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

23
reference/eio/functions/eio-lstat.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-lstat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-lstat">
<refnamediv>
<refname>eio_lstat</refname>
<refpurpose>Get file status</refpurpose>
@@ -14,13 +13,12 @@
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>int</type><parameter>pri</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_lstat</function> returns file status information in
<parameter>result</parameter> argument of <parameter>callback</parameter>
</para>
</simpara>
</refsect1>
@@ -30,9 +28,9 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
The file path
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -50,9 +48,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -60,9 +58,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_lstat</function> returns request resource on success or &false; on error.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -139,7 +137,6 @@ array(12) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

33
reference/eio/functions/eio-mkdir.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-mkdir" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-mkdir">
<refnamediv>
<refname>eio_mkdir</refname>
<refpurpose>Create directory</refpurpose>
@@ -13,17 +12,14 @@
<type>resource</type><methodname>eio_mkdir</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_mkdir</function> creates directory with specified access
<parameter>mode</parameter>.
</para>
</simpara>
</refsect1>
@@ -33,17 +29,17 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
Path for the new directory.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
<simpara>
Access mode, e.g. 0755
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -61,9 +57,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -71,9 +67,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_mkdir</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -122,7 +118,6 @@ eio_mkdir_ok
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

37
reference/eio/functions/eio-mknod.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-mknod" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-mknod">
<refnamediv>
<refname>eio_mknod</refname>
<refpurpose>Create a special or ordinary file</refpurpose>
@@ -14,17 +13,14 @@
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
<methodparam><type>int</type><parameter>dev</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_mknod</function> creates ordinary or special(often) file.
</para>
</simpara>
&warn.undocumented.func;
@@ -36,15 +32,15 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
Path for the new node(file).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
<simpara>
Specifies both the permissions to use and the type of node to be
created. It should be a combination (using bitwise OR) of one of the
file types listed below and the permissions for the new node(e.g. 0640).
@@ -57,19 +53,19 @@
To specify permissions <emphasis>EIO_S_I*</emphasis> constants could be
used.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dev</parameter></term>
<listitem>
<para>
<simpara>
If the file type is <constant>EIO_S_IFCHR</constant> or
<constant>EIO_S_IFBLK</constant> then dev specifies the major and minor
numbers of the newly created device special file. Otherwise
<parameter>dev</parameter> ignored. See <emphasis>mknod(2) man page for
details</emphasis>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -87,9 +83,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -97,9 +93,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_mknod</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -202,7 +198,6 @@ eio_mknod_ok
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

25
reference/eio/functions/eio-nop.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-nop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-nop">
<refnamediv>
<refname>eio_nop</refname>
<refpurpose>Does nothing, except go through the whole request cycle</refpurpose>
@@ -11,17 +10,14 @@
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>eio_nop</methodname>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_nop</function> does nothing, except go through the whole
request cycle. Could be useful in debugging.
</para>
</simpara>
</refsect1>
@@ -43,9 +39,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -53,9 +49,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_nop</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
@@ -67,7 +63,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/eio/functions/eio-npending.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-npending" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-npending">
<refnamediv>
<refname>eio_npending</refname>
<refpurpose>Returns number of finished, but unhandled requests</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>eio_npending</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
<function>eio_npending</function> returns number of finished, but unhandled requests
</para>
</simpara>
</refsect1>
@@ -26,10 +25,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_npending</function> returns number of finished, but unhandled
requests.
</para>
</simpara>
</refsect1>
@@ -43,7 +42,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/eio/functions/eio-nready.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-nready" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-nready">
<refnamediv>
<refname>eio_nready</refname>
<refpurpose>Returns number of not-yet handled requests</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>eio_nready</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -26,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_nready</function> returns number of not-yet handled requests
</para>
</simpara>
</refsect1>
@@ -42,7 +41,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/eio/functions/eio-nreqs.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-nreqs" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-nreqs">
<refnamediv>
<refname>eio_nreqs</refname>
<refpurpose>Returns number of requests to be processed</refpurpose>
@@ -11,12 +10,12 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>eio_nreqs</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
<function>eio_nreqs</function> could be called in a custom loop calling
<function>eio_poll</function>.
</para>
</simpara>
</refsect1>
@@ -27,9 +26,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_nreqs</function> returns number of requests to be processed.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -78,7 +77,6 @@ int(0)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/eio/functions/eio-nthreads.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-nthreads" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-nthreads">
<refnamediv>
<refname>eio_nthreads</refname>
<refpurpose>Returns number of threads currently in use</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>eio_nthreads</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -26,10 +25,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_nthreads</function> returns number of threads currently in
use.
</para>
</simpara>
</refsect1>
@@ -46,7 +45,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/eio/functions/eio-open.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-open" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-open">
<refnamediv>
<refname>eio_open</refname>
<refpurpose>Opens a file</refpurpose>
@@ -16,13 +15,12 @@
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
<methodparam><type>int</type><parameter>pri</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_open</function> opens file specified by
<parameter>path</parameter> in access mode <parameter>mode</parameter> with
</para>
</simpara>
</refsect1>
@@ -45,23 +43,22 @@
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>One of <emphasis>EIO_O_*</emphasis> constants, or their
<simpara>One of <emphasis>EIO_O_*</emphasis> constants, or their
combinations. <emphasis>EIO_O_*</emphasis> constants have the same
meaning, as their corresponding <emphasis>O_*</emphasis> counterparts
defined in <literal>fnctl.h</literal> C header file. Default is
<constant>EIO_O_RDWR</constant>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>One of <emphasis>EIO_S_I*</emphasis> constants, or their combination
<simpara>One of <emphasis>EIO_S_I*</emphasis> constants, or their combination
(via bitwise OR operator). The constants have the same meaning as their
<emphasis>S_I*</emphasis> counterparts defined in <link
xlink:href="&url.sys.stat.header;">sys/stat.h</link>
<emphasis>S_I*</emphasis> counterparts defined in <link xlink:href="&url.sys.stat.header;">sys/stat.h</link>
C header file. Required, if a file is created. Otherwise ignored.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -79,9 +76,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -89,11 +86,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_open</function> returns file descriptor in
<parameter>result</parameter> argument of <parameter>callback</parameter>
on success; otherwise, <parameter>result</parameter> is equal to <constant>-1</constant>.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -151,7 +148,6 @@ bool(true)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/eio/functions/eio-poll.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-poll" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-poll">
<refnamediv>
<refname>eio_poll</refname>
<refpurpose>Can be to be called whenever there are pending requests that need finishing</refpurpose>
@@ -11,15 +10,15 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>eio_poll</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
<function>eio_poll</function> can be used to implement special event loop.
For this <function>eio_nreqs</function> could be used to test if there are
unprocessed requests.
</para>
</simpara>
<note><para>Applicable only when implementing userspace event loop.</para></note>
<note><simpara>Applicable only when implementing userspace event loop.</simpara></note>
</refsect1>
@@ -30,10 +29,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
If any request invocation returns a non-zero value, returns that value.
Otherwise, it returns <literal>0</literal>.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -81,7 +80,6 @@ int(0)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

31
reference/eio/functions/eio-read.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-read" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-read">
<refnamediv>
<refname>eio_read</refname>
<refpurpose>Read from a file descriptor at given offset</refpurpose>
@@ -16,15 +15,14 @@
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam><type>int</type><parameter>pri</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_read</function> reads up to <parameter>length</parameter>
bytes from <parameter>fd</parameter> file descriptor at
<parameter>offset</parameter>. The read bytes are stored in
<parameter>result</parameter> argument of <parameter>callback</parameter>.
</para>
</simpara>
</refsect1>
@@ -34,25 +32,25 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
Stream, Socket resource, or numeric file descriptor
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
<simpara>
Maximum number of bytes to read.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
<simpara>
Offset within the file.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -70,9 +68,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -80,11 +78,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_read</function> stores read bytes in
<parameter>result</parameter> argument of <parameter>callback</parameter>
function.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -156,7 +154,6 @@ string(5) "34567"
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

37
reference/eio/functions/eio-readahead.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-readahead" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-readahead">
<refnamediv>
<refname>eio_readahead</refname>
<refpurpose>Perform file readahead into page cache</refpurpose>
@@ -14,17 +13,14 @@
<methodparam><type>mixed</type><parameter>fd</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_readahead</function> populates the page cache with data from a file so that subsequent reads from
that file will not block on disk I/O. See <literal>READAHEAD(2)</literal> man page for details.
</para>
</simpara>
</refsect1>
@@ -34,25 +30,25 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
Stream, Socket resource, or numeric file descriptor
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
<simpara>
Starting point from which data is to be read.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
<simpara>
Number of bytes to be read.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -70,9 +66,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -80,13 +76,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_readahead</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/eio/functions/eio-readdir.xml
View File

@@ -16,12 +16,12 @@
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Reads through a whole directory(via the <literal>opendir</literal>, <literal>readdir</literal> and
<literal>closedir</literal> system calls) and returns either the names or an array in
<parameter>result</parameter> argument of <parameter>callback</parameter>
function, depending on the <parameter>flags</parameter> argument.
</para>
</simpara>
</refsect1>
@@ -31,17 +31,17 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
Directory path.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
<simpara>
Combination of <emphasis>EIO_READDIR_*</emphasis> constants.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -59,9 +59,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -69,12 +69,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_readdir</function> returns request resource on success,&return.falseforfailure;.
Sets <parameter>result</parameter> argument of
<parameter>callback</parameter> function according to
<parameter>flags</parameter>:
</para>
</simpara>
<variablelist>

23
reference/eio/functions/eio-readlink.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-readlink" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-readlink">
<refnamediv>
<refname>eio_readlink</refname>
<refpurpose>Read value of a symbolic link</refpurpose>
@@ -14,12 +13,11 @@
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>int</type><parameter>pri</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -29,9 +27,9 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
Source symbolic link path
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -49,9 +47,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -59,9 +57,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_readlink</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -127,7 +125,6 @@ string(16) "/tmp/symlink.dat"
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

31
reference/eio/functions/eio-realpath.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-realpath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-realpath">
<refnamediv>
<refname>eio_realpath</refname>
<refpurpose>Get the canonicalized absolute pathname</refpurpose>
@@ -14,14 +13,13 @@
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>int</type><parameter>pri</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_realpath</function> returns the canonicalized absolute
pathname in <parameter>result</parameter> argument of
<parameter>callback</parameter> function.
</para>
</simpara>
</refsect1>
@@ -31,34 +29,34 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
Short pathname
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pri</parameter></term>
<listitem>
<para>
<simpara>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callback</parameter></term>
<listitem>
<para>
<simpara>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -66,9 +64,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -100,7 +98,6 @@ string(5) "/home"
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

33
reference/eio/functions/eio-rename.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-rename" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-rename">
<refnamediv>
<refname>eio_rename</refname>
<refpurpose>Change the name or location of a file</refpurpose>
@@ -13,16 +12,13 @@
<type>resource</type><methodname>eio_rename</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>string</type><parameter>new_path</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_rename</function> renames or moves a file to new location.
</para>
</simpara>
</refsect1>
@@ -32,17 +28,17 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
Source path
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>new_path</parameter></term>
<listitem>
<para>
<simpara>
Target path
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -60,9 +56,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -70,9 +66,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_rename</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -112,7 +108,6 @@ eio_rename_ok
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

29
reference/eio/functions/eio-rmdir.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-rmdir" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-rmdir">
<refnamediv>
<refname>eio_rmdir</refname>
<refpurpose>Remove a directory</refpurpose>
@@ -12,16 +11,13 @@
<methodsynopsis>
<type>resource</type><methodname>eio_rmdir</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_rmdir</function> removes a directory.
</para>
</simpara>
</refsect1>
@@ -31,9 +27,9 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
Directory path
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -51,9 +47,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -61,9 +57,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_rmdir</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -108,7 +104,6 @@ eio_rmdir_ok
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

35
reference/eio/functions/eio-seek.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-seek" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-seek">
<refnamediv>
<refname>eio_seek</refname>
<refpurpose>Seek to a position</refpurpose>
@@ -14,19 +13,16 @@
<methodparam><type>mixed</type><parameter>fd</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam><type>int</type><parameter>whence</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<function>eio_seek</function> repositions the offset of the open file associated with
<simpara>
<function>eio_seek</function> repositions the offset of the open file associated with
stream, <classname>Socket</classname> instance, or file descriptor specified by <parameter>fd</parameter> to
the argument <parameter>offset</parameter> according to
the directive <parameter>whence</parameter>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -35,17 +31,17 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
Stream, <classname>Socket</classname> instance, or numeric file descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
<simpara>
Starting point from which data is to be read.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -76,9 +72,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -86,13 +82,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_seek</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

32
reference/eio/functions/eio-sendfile.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-sendfile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-sendfile">
<refnamediv>
<refname>eio_sendfile</refname>
<refpurpose>Transfer data between file descriptors</refpurpose>
@@ -19,10 +18,10 @@
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_sendfile</function> copies data between one file descriptor
and another. See <literal>SENDFILE(2)</literal> man page for details.
</para>
</simpara>
</refsect1>
@@ -32,33 +31,33 @@
<varlistentry>
<term><parameter>out_fd</parameter></term>
<listitem>
<para>
<simpara>
Output stream, Socket resource, or file descriptor. Should be opened for writing.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>in_fd</parameter></term>
<listitem>
<para>
<simpara>
Input stream, Socket resource, or file descriptor. Should be opened for reading.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
<simpara>
Offset within the source file.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
<simpara>
Number of bytes to copy.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -76,9 +75,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -86,13 +85,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_sendfile</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/eio/functions/eio-set-max-idle.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-set-max-idle" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-set-max-idle">
<refnamediv>
<refname>eio_set_max_idle</refname>
<refpurpose>Set maximum number of idle threads</refpurpose>
@@ -13,9 +12,9 @@
<type>void</type><methodname>eio_set_max_idle</methodname>
<methodparam><type>int</type><parameter>nthreads</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -25,9 +24,9 @@
<varlistentry>
<term><parameter>nthreads</parameter></term>
<listitem>
<para>
<simpara>
Number of idle threads.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -50,7 +49,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/eio/functions/eio-set-max-parallel.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-set-max-parallel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-set-max-parallel">
<refnamediv>
<refname>eio_set_max_parallel</refname>
<refpurpose>Set maximum parallel threads</refpurpose>
@@ -13,9 +12,9 @@
<type>void</type><methodname>eio_set_max_parallel</methodname>
<methodparam><type>int</type><parameter>nthreads</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -25,9 +24,9 @@
<varlistentry>
<term><parameter>nthreads</parameter></term>
<listitem>
<para>
<simpara>
Number of parallel threads
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -50,7 +49,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/eio/functions/eio-set-max-poll-reqs.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-set-max-poll-reqs" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-set-max-poll-reqs">
<refnamediv>
<refname>eio_set_max_poll_reqs</refname>
<refpurpose>Set maximum number of requests processed in a poll</refpurpose>
@@ -13,9 +12,9 @@
<type>void</type><methodname>eio_set_max_poll_reqs</methodname>
<methodparam><type>int</type><parameter>nreqs</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -25,9 +24,9 @@
<varlistentry>
<term><parameter>nreqs</parameter></term>
<listitem>
<para>
<simpara>
Number of requests
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,13 +34,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/eio/functions/eio-set-max-poll-time.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-set-max-poll-time" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-set-max-poll-time">
<refnamediv>
<refname>eio_set_max_poll_time</refname>
<refpurpose>Set maximum poll time</refpurpose>
@@ -13,10 +12,10 @@
<type>void</type><methodname>eio_set_max_poll_time</methodname>
<methodparam><type>float</type><parameter>nseconds</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Polling stops, if poll took longer than <parameter>nseconds</parameter>
seconds.
</para>
</simpara>
</refsect1>
@@ -26,9 +25,9 @@
<varlistentry>
<term><parameter>nseconds</parameter></term>
<listitem>
<para>
<simpara>
Number of seconds
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,13 +35,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/eio/functions/eio-set-min-parallel.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-set-min-parallel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-set-min-parallel">
<refnamediv>
<refname>eio_set_min_parallel</refname>
<refpurpose>Set minimum parallel thread number</refpurpose>
@@ -13,9 +12,9 @@
<type>void</type><methodname>eio_set_min_parallel</methodname>
<methodparam><type>string</type><parameter>nthreads</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -25,9 +24,9 @@
<varlistentry>
<term><parameter>nthreads</parameter></term>
<listitem>
<para>
<simpara>
Number of parallel threads.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
@@ -51,7 +50,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

23
reference/eio/functions/eio-stat.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-stat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-stat">
<refnamediv>
<refname>eio_stat</refname>
<refpurpose>Get file status</refpurpose>
@@ -14,13 +13,12 @@
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>int</type><parameter>pri</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_stat</function> returns file status information in
<parameter>result</parameter> argument of <parameter>callback</parameter>
</para>
</simpara>
</refsect1>
@@ -30,9 +28,9 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
The file path
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -50,9 +48,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -60,11 +58,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_stat</function> returns request resource on success or
&false; on error. On success assigns <parameter>result</parameter> argument of
<parameter>callback</parameter> to an array.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -141,7 +139,6 @@ array(12) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/eio/functions/eio-statvfs.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-statvfs" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-statvfs">
<refnamediv>
<refname>eio_statvfs</refname>
<refpurpose>Get file system statistics</refpurpose>
@@ -16,10 +15,10 @@
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_statvfs</function> returns file system statistics information in
<parameter>result</parameter> argument of <parameter>callback</parameter>
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,9 +27,9 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
Pathname of any file within the mounted file system
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -48,9 +47,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -58,11 +57,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>eio_statvfs</function> returns request resource on success,&return.falseforfailure;.
<simpara>
<function>eio_statvfs</function> returns request resource on success,&return.falseforfailure;.
On success assigns <parameter>result</parameter> argument of
<parameter>callback</parameter> to an array.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -122,7 +121,6 @@ array(11) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

33
reference/eio/functions/eio-symlink.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-symlink" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-symlink">
<refnamediv>
<refname>eio_symlink</refname>
<refpurpose>Create a symbolic link</refpurpose>
@@ -13,18 +12,15 @@
<type>resource</type><methodname>eio_symlink</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>string</type><parameter>new_path</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_symlink</function> creates a symbolic link
<parameter>new_path</parameter> to <parameter>path</parameter>.
</para>
</simpara>
</refsect1>
@@ -34,17 +30,17 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
Source path
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>new_path</parameter></term>
<listitem>
<para>
<simpara>
Target path
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -62,9 +58,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -72,9 +68,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_symlink</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -130,7 +126,6 @@ string(16) "/tmp/symlink.dat"
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

41
reference/eio/functions/eio-sync-file-range.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-sync-file-range" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-sync-file-range">
<refnamediv>
<refname>eio_sync_file_range</refname>
<refpurpose>Sync a file segment with disk</refpurpose>
@@ -15,17 +14,14 @@
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam><type>int</type><parameter>nbytes</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_sync_file_range</function> permits fine control when synchronizing the open file referred to by the file
descriptor <parameter>fd</parameter> with disk.
</para>
</simpara>
</refsect1>
@@ -35,40 +31,40 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
File descriptor
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
<simpara>
The starting byte of the file range to be synchronized
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nbytes</parameter></term>
<listitem>
<para>
<simpara>
Specifies the length of the range to be synchronized, in bytes. If
<parameter>nbytes</parameter> is zero, then all bytes from <parameter>offset</parameter> through
to the end of file are synchronized.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
<simpara>
A bit-mask. Can include any of the following values:
<constant>EIO_SYNC_FILE_RANGE_WAIT_BEFORE</constant>,
<constant>EIO_SYNC_FILE_RANGE_WRITE</constant>,
<constant>EIO_SYNC_FILE_RANGE_WAIT_AFTER</constant>. These flags have
the same meaning as their <emphasis>SYNC_FILE_RANGE_*</emphasis>
counterparts(see <literal>SYNC_FILE_RANGE(2)</literal> man page).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -86,9 +82,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -96,13 +92,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_sync_file_range</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/eio/functions/eio-sync.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-sync" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-sync">
<refnamediv>
<refname>eio_sync</refname>
<refpurpose>Commit buffer cache to disk</refpurpose>
@@ -15,9 +14,9 @@
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -28,13 +27,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_sync</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

29
reference/eio/functions/eio-syncfs.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-syncfs" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-syncfs">
<refnamediv>
<refname>eio_syncfs</refname>
<refpurpose>Calls Linux' syncfs syscall, if available</refpurpose>
@@ -12,16 +11,13 @@
<methodsynopsis>
<type>resource</type><methodname>eio_syncfs</methodname>
<methodparam><type>mixed</type><parameter>fd</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -31,10 +27,10 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
File descriptor
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -52,9 +48,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -62,14 +58,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_syncfs</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

33
reference/eio/functions/eio-truncate.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-truncate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-truncate">
<refnamediv>
<refname>eio_truncate</refname>
<refpurpose>Truncate a file</refpurpose>
@@ -13,17 +12,14 @@
<type>resource</type><methodname>eio_truncate</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_truncate</function> causes the regular file named by <parameter>path</parameter> to be truncated to
a size of precisely <parameter>length</parameter> bytes
</para>
</simpara>
</refsect1>
@@ -33,17 +29,17 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
File path
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
<simpara>
Offset from beginning of the file.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -61,9 +57,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -71,9 +67,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_busy</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -84,7 +80,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

29
reference/eio/functions/eio-unlink.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-unlink" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-unlink">
<refnamediv>
<refname>eio_unlink</refname>
<refpurpose>Delete a name and possibly the file it refers to</refpurpose>
@@ -12,16 +11,13 @@
<methodsynopsis>
<type>resource</type><methodname>eio_unlink</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_unlink</function> deletes a name from the file system.
</para>
</simpara>
</refsect1>
@@ -31,9 +27,9 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
Path to file
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -51,9 +47,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -61,13 +57,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_unlink</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

37
reference/eio/functions/eio-utime.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-utime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-utime">
<refnamediv>
<refname>eio_utime</refname>
<refpurpose>Change file last access and modification times</refpurpose>
@@ -14,16 +13,13 @@
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>float</type><parameter>atime</parameter></methodparam>
<methodparam><type>float</type><parameter>mtime</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -33,25 +29,25 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
Path to the file.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>atime</parameter></term>
<listitem>
<para>
<simpara>
Access time
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mtime</parameter></term>
<listitem>
<para>
<simpara>
Modification time
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -69,9 +65,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -79,9 +75,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_utime</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -92,7 +88,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

41
reference/eio/functions/eio-write.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.eio-write" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-write">
<refnamediv>
<refname>eio_write</refname>
<refpurpose>Write to file</refpurpose>
@@ -15,18 +14,15 @@
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>eio_write</function> writes up to <parameter>length</parameter>
bytes from <parameter>str</parameter> at <parameter>offset</parameter>
offset from the beginning of the file.
</para>
</simpara>
</refsect1>
@@ -36,33 +32,33 @@
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
<simpara>
Stream, Socket resource, or numeric file descriptor, e.g. returned by <function>eio_open</function>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>str</parameter></term>
<listitem>
<para>
<simpara>
Source string
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
<simpara>
Maximum number of bytes to write.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
<simpara>
Offset from the beginning of file.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -80,9 +76,9 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -90,9 +86,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_write</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -103,7 +99,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/eio/setup.xml
View File

@@ -1,15 +1,14 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="eio.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eio.setup">
&reftitle.setup;
<section xml:id="eio.requirements">
&reftitle.required;
<para>
<simpara>
This extension has <link xlink:href="&url.eio.libeio;">libeio</link>
library embedded. So you do NOT need to install libeio separately.
</para>
</simpara>
</section>
<!--{{{ Installation -->
@@ -19,14 +18,13 @@
<!--{{{ Resources -->
<section xml:id="eio.resources">
&reftitle.resources;
<para>
<simpara>
There are two resource types in this extension: request and request group.
</para>
</simpara>
</section>
<!--}}}-->
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml