add Libevent documentation (quite sketchy)

WARNING: needs a native speaker check (thanks in advance!)


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@287300 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Antony Dovgal 2009-08-14 13:44:58 +00:00
parent 8750a9d492
commit e83fdb1b74
30 changed files with 2138 additions and 0 deletions

View file

@ -0,0 +1,52 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 283834 $ -->
<!-- Purpose: compression -->
<!-- Membership: pecl, external -->
<book xml:id="book.libevent" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Libevent</title>
<titleabbrev>Libevent</titleabbrev>
<!-- {{{ preface -->
<preface xml:id="intro.libevent">
&reftitle.intro;
<para>
Libevent is a library that provides a mechanism to execute a callback
function when a specific event occurs on a file descriptor or after a
timeout has been reached.
</para>
<para>
More information about Libevent can be found at <link
xlink:href="&url.libevent;">&url.libevent;</link>.
</para>
</preface>
<!-- }}} -->
&reference.libevent.setup;
&reference.libevent.constants;
&reference.libevent.examples;
&reference.libevent.reference;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,108 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 283834 $ -->
<appendix xml:id="libevent.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&extension.constants;
<variablelist>
<varlistentry>
<term>
<constant>EV_TIMEOUT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>EV_READ</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>EV_WRITE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>EV_SIGNAL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>EV_PERSIST</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>EVLOOP_NONBLOCK</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>EVLOOP_ONCE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<chapter xml:id="libevent.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.examples;
<para>
<example>
<title>libevent extension overview example</title>
<programlisting role="php">
<![CDATA[
<?php
?>
]]>
</programlisting>
</example>
</para>
<para>
</para>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,80 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event_add" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_add</refname>
<refpurpose>Add an event to the set of monitored events</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>event_add</methodname>
<methodparam><type>resource</type><parameter>event</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
</methodsynopsis>
<para>
<function>event_add</function> schedules the execution of the <parameter>event</parameter>
when the event specified in <function>event_set</function> occurs or in at least the time
specified by the <parameter>timeout</parameter> argument. If
<parameter>timeout</parameter> was not specified, not timeout is set. The
<parameter>event</parameter> must be already initalized by <function>event_set</function>
and <function>event_base_set</function> functions. If the
<parameter>event</parameter> already has a timeout set, it is replaced by
the new one.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>event</parameter></term>
<listitem>
<para>
Valid event resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
Optional timeout (in microseconds).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function></function> returns or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,59 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-base-free" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_base_free</refname>
<refpurpose>Destroy event base</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>event_base_free</methodname>
<methodparam><type>resource</type><parameter>event_base</parameter></methodparam>
</methodsynopsis>
<para>
Destroys the specified <parameter>event_base</parameter> and frees all the
resources associated. Note that it's not possible to destroy an event base
with events attached to it.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>event_base</parameter></term>
<listitem>
<para>
Valid event base resource.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,76 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-base-loop" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_base_loop</refname>
<refpurpose>Handle events</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>event_base_loop</methodname>
<methodparam><type>resource</type><parameter>event_base</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Starts event loop for the specified event base.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>event_base</parameter></term>
<listitem>
<para>
Valid event base resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Optional parameter, which can take any combination of
<constant>EVLOOP_ONCE</constant> and <constant>EVLOOP_NONBLOCK</constant>.
Default value is 0.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_base_loop</function> returns 0 on success, -1 on error and
1 if no events were registered.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,65 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-base-loopbreak" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_base_loopbreak</refname>
<refpurpose>Abort event loop</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>event_base_loopbreak</methodname>
<methodparam><type>resource</type><parameter>event_base</parameter></methodparam>
</methodsynopsis>
<para>
Abort the active event loop immediately. The behaviour is similar to
<literal>break</literal> statement.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>event_base</parameter></term>
<listitem>
<para>
Valid event base resource.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_base_loopbreak</function> returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,74 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-base-loopexit" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_base_loopexit</refname>
<refpurpose>Exit loop after a time</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>event_base_loopexit</methodname>
<methodparam><type>resource</type><parameter>event_base</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
</methodsynopsis>
<para>
The next event loop iteration after the given timer expires will complete
normally, then exit without blocking for events again.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>event_base</parameter></term>
<listitem>
<para>
Valid event base resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
Optional timeout parameter (in microseconds).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_base_loopexit</function> returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,57 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-base-new" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_base_new</refname>
<refpurpose>Create and initialize new event base</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>event_base_new</methodname>
<void/>
</methodsynopsis>
<para>
Returns new event base, which can be used later in <function>event_base_set</function>,
<function>event_base_loop</function> and other functions.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
<para>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_base_new</function> returns valid event base resource on
success or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,79 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-base-priority-init" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_base_priority_init</refname>
<refpurpose>Set the number of event priority levels</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>event_base_priority_init</methodname>
<methodparam><type>resource</type><parameter>event_base</parameter></methodparam>
<methodparam><type>int</type><parameter>npriorities</parameter></methodparam>
</methodsynopsis>
<para>
Sets the number of different event priority levels.
</para>
<para>
By default all events are scheduled with the same priority
(<parameter>npriorities</parameter>/2).
Using <function>event_base_priority_init</function> you can change the number
of event priority levels and then set a desired priority for each event.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>event_base</parameter></term>
<listitem>
<para>
Valid event base resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>npriorities</parameter></term>
<listitem>
<para>
The number of event priority levels.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_base_priority_init</function> returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,74 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-base-set" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_base_set</refname>
<refpurpose>Associate event base with an event</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>event_base_set</methodname>
<methodparam><type>resource</type><parameter>event</parameter></methodparam>
<methodparam><type>resource</type><parameter>event_base</parameter></methodparam>
</methodsynopsis>
<para>
Associates the <parameter>event_base</parameter> with the
<parameter>event</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>event</parameter></term>
<listitem>
<para>
Valid event resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>event_base</parameter></term>
<listitem>
<para>
Valid event base resource.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_base_set</function> returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,74 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-buffer-base-set" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_buffer_base_set</refname>
<refpurpose>Associate buffered event with an event base</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>event_buffer_base_set</methodname>
<methodparam><type>resource</type><parameter>bevent</parameter></methodparam>
<methodparam><type>resource</type><parameter>event_base</parameter></methodparam>
</methodsynopsis>
<para>
Assign the specified <parameter>bevent</parameter> to the
<parameter>event_base</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bevent</parameter></term>
<listitem>
<para>
Valid buffered event resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>event_base</parameter></term>
<listitem>
<para>
Valid event base resource.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_buffer_base_set</function> returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,74 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-buffer-disable" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_buffer_disable</refname>
<refpurpose>Disable a buffered event</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>event_buffer_disable</methodname>
<methodparam><type>resource</type><parameter>bevent</parameter></methodparam>
<methodparam><type>int</type><parameter>events</parameter></methodparam>
</methodsynopsis>
<para>
Disables the specified buffered event.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bevent</parameter></term>
<listitem>
<para>
Valid buffered event resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>events</parameter></term>
<listitem>
<para>
Any combination of <constant>EV_READ</constant> and
<constant>EV_WRITE</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_buffer_disable</function> returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,74 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-buffer-enable" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_buffer_enable</refname>
<refpurpose>Enable a buffered event</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>event_buffer_enable</methodname>
<methodparam><type>resource</type><parameter>bevent</parameter></methodparam>
<methodparam><type>int</type><parameter>events</parameter></methodparam>
</methodsynopsis>
<para>
Enables the specified buffered event.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bevent</parameter></term>
<listitem>
<para>
Valid buffered event resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>events</parameter></term>
<listitem>
<para>
Any combination of <constant>EV_READ</constant> and
<constant>EV_WRITE</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_buffer_enable</function> returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,66 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-buffer-fd-set" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_buffer_fd_set</refname>
<refpurpose>Change a buffered event file descriptor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>event_buffer_fd_set</methodname>
<methodparam><type>resource</type><parameter>bevent</parameter></methodparam>
<methodparam><type>resource</type><parameter>fd</parameter></methodparam>
</methodsynopsis>
<para>
Changes the file descriptor on which the buffered event operates.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bevent</parameter></term>
<listitem>
<para>
Valid buffered event resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
Valid PHP stream, must be castable to file descriptor.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,58 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-buffer-free" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_buffer_free</refname>
<refpurpose>Destroy buffered event</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>event_buffer_free</methodname>
<methodparam><type>resource</type><parameter>bevent</parameter></methodparam>
</methodsynopsis>
<para>
Destroys the specified buffered event and frees all the resources
associated.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bevent</parameter></term>
<listitem>
<para>
Valid buffered event resource.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,107 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-buffer-new" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_buffer_new</refname>
<refpurpose>Create new buffered event</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>event_buffer_new</methodname>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
<methodparam><type>mixed</type><parameter>readcb</parameter></methodparam>
<methodparam><type>mixed</type><parameter>writecb</parameter></methodparam>
<methodparam><type>mixed</type><parameter>errorcb</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<para>
Libevent provides an abstraction layer on top of the regular event API.
Using buffered event you don't need to deal with the I/O manually, instead
it provides input and output buffers that get filled and drained
automatically.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
Valid PHP stream resource. Must be castable to file descriptor.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>readcb</parameter></term>
<listitem>
<para>
Callback to invoke where there is data to read, or <type>NULL</type> if
no callback is desired.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>writecb</parameter></term>
<listitem>
<para>
Callback to invoke where the descriptor is ready for writing,
or <type>NULL</type> if no callback is desired.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>errorcb</parameter></term>
<listitem>
<para>
Callback to invoke where there is an error on the descriptor, cannot be
<type>NULL</type>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>arg</parameter></term>
<listitem>
<para>
An argument that will be passed to each of the callbacks (optional).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_buffer_new</function> returns new buffered event resource
on success or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,74 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-buffer-priority-set" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_buffer_priority_set</refname>
<refpurpose>Assign a priority to a buffered event</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>event_buffer_priority_set</methodname>
<methodparam><type>resource</type><parameter>bevent</parameter></methodparam>
<methodparam><type>int</type><parameter>priority</parameter></methodparam>
</methodsynopsis>
<para>
Assign a priority to the <parameter>bevent</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bevent</parameter></term>
<listitem>
<para>
Valid buffered event resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>priority</parameter></term>
<listitem>
<para>
Priority level. Cannot be less than zero and cannot exceed maximum
priority level of the event base (see <function>event_base_priority_init</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_buffer_priority_set</function> returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,66 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-buffer-read" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_buffer_read</refname>
<refpurpose>Read data from a buffered event</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>event_buffer_read</methodname>
<methodparam><type>resource</type><parameter>bevent</parameter></methodparam>
<methodparam><type></type><parameter>data_size</parameter></methodparam>
</methodsynopsis>
<para>
Reads data from the input buffer of the buffered event.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bevent</parameter></term>
<listitem>
<para>
Valid buffered event resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data_size</parameter></term>
<listitem>
<para>
Data size in bytes.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,82 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-buffer-timeout-set" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_buffer_timeout_set</refname>
<refpurpose>Set read and write timeouts for a buffered event</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>event_buffer_timeout_set</methodname>
<methodparam><type>resource</type><parameter>bevent</parameter></methodparam>
<methodparam><type>int</type><parameter>read_timeout</parameter></methodparam>
<methodparam><type>int</type><parameter>write_timeout</parameter></methodparam>
</methodsynopsis>
<para>
Sets the read and write timeout for the specified buffered event.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bevent</parameter></term>
<listitem>
<para>
Valid buffered event resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>read_timeout</parameter></term>
<listitem>
<para>
Read timeout (in seconds).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>write_timeout</parameter></term>
<listitem>
<para>
Write timeout (in seconds).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_buffer_timeout_set</function> returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,96 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-buffer-watermark-set" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_buffer_watermark_set</refname>
<refpurpose>Set the watermarks for read and write events</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>event_buffer_watermark_set</methodname>
<methodparam><type>resource</type><parameter>bevent</parameter></methodparam>
<methodparam><type>int</type><parameter>events</parameter></methodparam>
<methodparam><type>int</type><parameter>lowmark</parameter></methodparam>
<methodparam><type>int</type><parameter>highmark</parameter></methodparam>
</methodsynopsis>
<para>
Sets the watermarks for read and write events. Libevent does not invoke
read callback unless there is at least <parameter>lowmark</parameter> bytes
in the input buffer; if the read buffer is beyond the <parameter>highmark</parameter>,
reading is stopped. On output, the write callback is invoked whenever the
buffered data falls below the <parameter>lowmark</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bevent</parameter></term>
<listitem>
<para>
Valid buffered event resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>events</parameter></term>
<listitem>
<para>
Any combination of <constant>EV_READ</constant> and
<constant>EV_WRITE</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lowmark</parameter></term>
<listitem>
<para>
Low watermark.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>highmark</parameter></term>
<listitem>
<para>
High watermark.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_buffer_watermark_set</function> returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,85 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-buffer-write" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_buffer_write</refname>
<refpurpose>Write data to a buffered event</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>event_buffer_write</methodname>
<methodparam><type>resource</type><parameter>bevent</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>data_size</parameter></methodparam>
</methodsynopsis>
<para>
Writes data to the specified buffered event. The data is appended to the
output buffer and written to the descriptor when it becomes available for
writing.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bevent</parameter></term>
<listitem>
<para>
Valid buffered event resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
The data to be written.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data_size</parameter></term>
<listitem>
<para>
Optional size parameter. <function>event_buffer_write</function> writes
all the <parameter>data</parameter> by default.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_buffer_write</function> returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,64 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-del" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_del</refname>
<refpurpose>Remove an event from the set of monitored events</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>event_del</methodname>
<methodparam><type>resource</type><parameter>event</parameter></methodparam>
</methodsynopsis>
<para>
Cancels the <parameter>event</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>event</parameter></term>
<listitem>
<para>
Valid event resource.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_del</function> returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,72 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-free" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_free</refname>
<refpurpose>Free event resource</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>event_free</methodname>
<methodparam><type>resource</type><parameter>event</parameter></methodparam>
</methodsynopsis>
<para>
Frees previously created event resource.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
Path to the Rar archive.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
A plain password, if needed.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>rar_open</function> returns Rar file resource or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,41 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-new" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_new</refname>
<refpurpose>Create new event</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>event_new</methodname>
<void/>
</methodsynopsis>
<para>
Creates and returns new event resource.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,148 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<refentry xml:id="function.event-set" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_set</refname>
<refpurpose>Prepare an event</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>event_set</methodname>
<methodparam><type>resource</type><parameter>event</parameter></methodparam>
<methodparam><type>resource</type><parameter>fd</parameter></methodparam>
<methodparam><type>int</type><parameter>events</parameter></methodparam>
<methodparam><type>mixed</type><parameter>callback</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<para>
Prepares the event to be used in <function>event_add</function>. The event
is prepared to call the function specified by the <parameter>callback</parameter>
on the events specified in parameter <parameter>events</parameter>, which
is a set of the following flags: <constant>EV_TIMEOUT</constant>,
<constant>EV_SIGNAL</constant>, <constant>EV_READ</constant> and
<constant>EV_WRITE</constant>.
</para>
<para>
After initializing the event, use <function>event_base_set</function> to
associate the event with its event base.
</para>
<para>
In case of matching event, these three arguments are passed to the
<parameter>callback</parameter> function:
<variablelist>
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
Resource indicating the stream.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>events</parameter></term>
<listitem>
<para>
A flag indicating the event. Can be one of the following:
<constant>EV_TIMEOUT</constant>, <constant>EV_SIGNAL</constant>,
<constant>EV_READ</constant> or <constant>EV_WRITE</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>arg</parameter></term>
<listitem>
<para>
Optional parameter, previously passed to <function>event_set</function>
as <parameter>arg</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>event</parameter></term>
<listitem>
<para>
Valid event resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
Valid PHP stream resource. The stream must be castable to file
descriptor, so you most likely won't be able to use any of filtered
streams.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>events</parameter></term>
<listitem>
<para>
A set of flags indicating the desired event, can be
<constant>EV_READ</constant> and/or <constant>EV_WRITE</constant>.
The additional flag <constant>EV_PERSIST</constant> makes the event
to persist until <function>event_del</function> is called, otherwise
the callback is invoked only once.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callback</parameter></term>
<listitem>
<para>
Callback function to be called when the matching event occurs.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>arg</parameter></term>
<listitem>
<para>
Optional callback parameter.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_set</function> returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<section xml:id="libevent.configuration" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&no.config;
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 283834 $ -->
<reference xml:id="ref.libevent" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Libevent &Functions;</title>
&reference.libevent.entities.functions;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,82 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 283834 $ -->
<chapter xml:id="libevent.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="libevent.requirements">
&reftitle.required;
<para>
This extension requires <link xlink:href="&url.libevent;">libevent</link>
library. Minimal required version is 1.4.0.
</para>
</section>
<!-- }}} -->
<!-- {{{ Installation -->
<section xml:id="libevent.installation">
&reftitle.install;
<para>
Libevent extension is available through PECL
<link xlink:href="&url.pecl.package;libevent">&url.pecl.package;libevent</link>.
</para>
<para>
Also you can use the PECL installer to install the Libevent extension,
using the following command: <command>pecl -v install libevent</command>.
</para>
<para>
You can always download the <filename>tar.gz</filename> package and install Libevent by hand:
<example>
<title>Libevent installation</title>
<programlisting role="shell">
<![CDATA[
gunzip libevent-xxx.tgz
tar -xvf libevent-xxx.tar
cd libevent-xxx
phpize
./configure && make && make install
]]>
</programlisting>
</example>
</para>
</section>
<!-- }}} -->
<!-- {{{ Configuration -->
&reference.libevent.ini;
<!-- }}} -->
<!-- {{{ Resources -->
<section xml:id="libevent.resources">
&reftitle.resources;
<para>
There are several resource types used in the extension. These resources
are event, event base and buffered event.
</para>
</section>
<!-- }}} -->
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,51 @@
<?xml version='1.0' encoding='utf-8'?>
<!-- $Revision: 283834 $ -->
<!--
Do NOT translate this file
-->
<versions>
<function name='event_add' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_base_free' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_base_loopbreak' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_base_loopexit' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_base_loop' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_base_new' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_base_priority_init' from='PECL libevent &gt;= 0.0.2'/>
<function name='event_base_set' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_buffer_base_set' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_buffer_disable' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_buffer_enable' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_buffer_fd_set' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_buffer_free' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_buffer_new' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_buffer_priority_set' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_buffer_read' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_buffer_timeout_set' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_buffer_watermark_set' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_buffer_write' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_del' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_free' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_new' from='PECL libevent &gt;= 0.0.1'/>
<function name='event_set' from='PECL libevent &gt;= 0.0.1'/>
</versions>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->