mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
065dd47a92
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322131 c90b9560-bf6c-de11-be94-00142212c4b1
80 lines
2.3 KiB
XML
80 lines
2.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<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><initializer>-1</initializer></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>event_add</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
|
|
-->
|