archived-doc-es/reference/libevent/functions/event-set.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 65d285c0356f09d8d925cad40965e03017bc4293 Maintainer: regiemix Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.event-set" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>event_set</refname>
  <refpurpose>Prepara un evento</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>mixed</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>
   Prepara el evento que se va a utilizar en la función  <function>event_add</function>. El evento 
   es preparado para llamar a la función especificada por el parámetro <parameter>callback</parameter> 
   en los eventos especificados en el parámetro <parameter>events</parameter>, que son
   un conjunto de los siguientes indicadores: <constant>EV_TIMEOUT</constant>, 
   <constant>EV_SIGNAL</constant>, <constant>EV_READ</constant>, 
   <constant>EV_WRITE</constant> y <constant>EV_PERSIST</constant>.
  </para> 
  <para>
   Si el bit <constant>EV_SIGNAL</constant> se especifica en el parámetro <parameter>events</parameter>,
   el parámetro <parameter>fd</parameter> se interpreta como un número de señal.
  </para>
  <para>
   Después de inicializar el evento, utilizar la función <function>event_base_set</function> para
   asociar el evento a su base de eventos.
  </para>
  <para>
   En el caso de que se de un evento, se pasan los siguientes tres argumentos 
   a la función <parameter>callback</parameter> : 
   <variablelist>
    <varlistentry>
     <term><parameter>fd</parameter></term>
     <listitem>
      <para>
       Número de señal o recurso que indica el flujo.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>events</parameter></term>
     <listitem>
      <para>
       Un indicador que informa el evento. Está formado por los siguientes indicadores:
       <constant>EV_TIMEOUT</constant>, <constant>EV_SIGNAL</constant>, 
       <constant>EV_READ</constant>, <constant>EV_WRITE</constant>
       y <constant>EV_PERSIST</constant>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>arg</parameter></term>
     <listitem>
      <para>
       Parámetro opcional, pasado previamente a <function>event_set</function>
       como <parameter>arg</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>event</parameter></term>
     <listitem>
      <para>
       Recurso válido de evento.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>fd</parameter></term>
     <listitem>
      <para>
       Recurso válido de flujo PHP . El flujo debe ser tipificable como descriptor de fichero,
       por lo que no se podrá utilizar ningún flujo
       filtrado la mayoría de las veces.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>events</parameter></term>
     <listitem>
      <para>
       Un conjunto de indicadores para el evento deseado, pueden ser
       <constant>EV_READ</constant> y/o <constant>EV_WRITE</constant>.
       El indicador adicional <constant>EV_PERSIST</constant> hace que el evento sea
       persistente hasta que se llame la función <function>event_del</function>, de otro modo
       la llamada se invoca una sola vez.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>callback</parameter></term>
     <listitem>
      <para>
       Función de llamada que se ejecutará cuando se produzca el evento.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>arg</parameter></term>
     <listitem>
      <para>
       Parámetro opcional de llamada.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>event_set</function> devuelve &true; en caso de éxito o &false; en caso de error.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>0.0.4</entry>
      <entry>
       Se añadió la ayuda de <constant>EV_SIGNAL</constant>.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </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
-->