mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
148 lines
4.4 KiB
XML
148 lines
4.4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision$ -->
|
|
<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:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|