doc-fr/reference/event/event.callbacks.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 41060e691dc09b9b190e2181123dbc8286e05843 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->

<chapter  xml:id="event.callbacks" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <title>Fonctions de rappel des événements</title>
 <para>
  Si une fonction de rappel est enregistrée pour un événement, elle
  sera appelée lorsque l'événement devient actif. Pour associer une fonction
  de rappel avec un événement, il convient de la passer avec un type
  <type>callable</type> à la méthode <methodname>Event::__construct</methodname>,
  <methodname>Event::set</methodname>, ou toute autre méthode factorielle comme
  <methodname>Event::timer</methodname>.
 </para>
 <para>
  Une fonction de rappel d'événement doit correspondre au prototype suivant :
 </para>
 <methodsynopsis>
  <type>void</type>
  <methodname>callback</methodname>
  <methodparam
   choice="opt">
   <type>mixed</type>
   <parameter>fd</parameter>
   <initializer>&null;</initializer>
  </methodparam>
  <methodparam
   choice="opt">
   <type>int</type>
   <parameter>what</parameter>
  </methodparam>
  <methodparam
   choice="opt">
   <type>mixed</type>
   <parameter>arg</parameter>
   <initializer>&null;</initializer>
  </methodparam>
 </methodsynopsis>
 <para>
  <variablelist>
   <varlistentry>
    <term>
     <parameter>fd</parameter>
    </term>
    <listitem>
     <para>
      Un descripteur de fichier, une ressource de flux, ou un socket
      associé avec l'événement. Pour les événements de type signal,
      <parameter>fd</parameter> correspond au numéro du signal.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>what</parameter>
    </term>
    <listitem>
     <para>
      Masque d'octets de <emphasis>tous</emphasis> les événements lancés.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>arg</parameter>
    </term>
    <listitem>
     <para>
      Données utilisateurs personnalisées.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </para>
 <para>
  La méthode <methodname>Event::timer</methodname> attend une fonction
  de rappel qui correspond au prototype suivant :
 </para>
 <methodsynopsis>
  <type>void</type>
  <methodname>callback</methodname>
  <methodparam
   choice="opt">
   <type>mixed</type>
   <parameter>arg</parameter>
   <initializer>&null;</initializer>
  </methodparam>
 </methodsynopsis>
 <para>
  <variablelist>
   <varlistentry>
    <term>
     <parameter>arg</parameter>
    </term>
    <listitem>
     <para>
      Données utilisateurs personnalitées.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </para>
 <para>
  La méthode <methodname>Event::signal</methodname> attend une fonction
  de rappel correspondant au prototype suivant :
 </para>
 <methodsynopsis>
  <type>void</type>
  <methodname>callback</methodname>
  <methodparam
   choice="opt">
   <type>int</type>
   <parameter>signum</parameter>
  </methodparam>
  <methodparam
   choice="opt">
   <type>mixed</type>
   <parameter>arg</parameter>
   <initializer>&null;</initializer>
  </methodparam>
 </methodsynopsis>
 <para>
  <variablelist>
   <varlistentry>
    <term>
     <parameter>signum</parameter>
    </term>
    <listitem>
     <para>
      Le numéro du signal lancé (i.e. <constant>SIGTERM</constant>).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>arg</parameter>
    </term>
    <listitem>
     <para>
      Données utilisateurs personnalisées.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </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:"~/.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
-->