Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions reference/eio/book.xml
Original file line number Diff line number Diff line change
@@ -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;

Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
14 changes: 6 additions & 8 deletions reference/eio/configure.xml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
16 changes: 7 additions & 9 deletions reference/eio/constants.xml
Original file line number Diff line number Diff line change
@@ -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;

Expand Down Expand Up @@ -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
Expand Down
33 changes: 14 additions & 19 deletions reference/eio/functions/eio-busy.xml
Original file line number Diff line number Diff line change
@@ -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,
Expand All @@ -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">
Expand All @@ -33,9 +29,9 @@
<varlistentry>
<term><parameter>delay</parameter></term>
<listitem>
<para>
<simpara>
Delay in seconds
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
Expand All @@ -47,27 +43,27 @@
<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>
</refsect1>

<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;
Expand All @@ -77,7 +73,6 @@
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
20 changes: 9 additions & 11 deletions reference/eio/functions/eio-cancel.xml
Original file line number Diff line number Diff line change
@@ -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>
Expand All @@ -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">
Expand All @@ -25,9 +24,9 @@
<varlistentry>
<term><parameter>req</parameter></term>
<listitem>
<para>
<simpara>
The request resource
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
Expand All @@ -45,19 +44,19 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>

<refsect1 role="examples">
Expand Down Expand Up @@ -104,7 +103,6 @@ my_nop 2
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
29 changes: 12 additions & 17 deletions reference/eio/functions/eio-chmod.xml
Original file line number Diff line number Diff line change
@@ -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>
Expand All @@ -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>

Expand All @@ -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>
Expand All @@ -62,19 +58,19 @@
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Arbitrary variable passed to <parameter>callback</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<function>eio_chmod</function> returns request resource on success,&return.falseforfailure;.
</para>
</simpara>
</refsect1>

<refsect1 role="seealso">
Expand All @@ -85,7 +81,6 @@
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
Loading