<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.event-timer-set" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>event_timer_set</refname>
  <refpurpose>Prepare a timer event</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>event_timer_set</methodname>
   <methodparam><type>resource</type><parameter>event</parameter></methodparam>
   <methodparam><type>callable</type><parameter>callback</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>arg</parameter></methodparam>
  </methodsynopsis>
  <para>
   Prepares the timer event to be used in <function>event_add</function>. The
   event is prepared to call the function specified by the
   <parameter>callback</parameter> when the event timeout elapses.
  </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>
       Signal number or resource indicating the stream.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>events</parameter></term>
     <listitem>
      <para>
       A flag indicating the event. This will always be
       <constant>EV_TIMEOUT</constant> for timer events.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>arg</parameter></term>
     <listitem>
      <para>
       Optional parameter, previously passed to
       <function>event_timer_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>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>
   &return.success;
  </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
 -->