construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="eventbufferevent.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>EventBufferEvent::__construct</refname>
  <refpurpose>Constructs EventBufferEvent object</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier>
   <methodname>EventBufferEvent::__construct</methodname>
   <methodparam>
    <type>EventBase</type>
    <parameter>base</parameter>
   </methodparam>
   <methodparam
   choice="opt">
    <type>mixed</type>
    <parameter>socket</parameter>
    <initializer>&null;</initializer>
   </methodparam>
   <methodparam
   choice="opt">
    <type>int</type>
    <parameter>options</parameter>
    <initializer>0</initializer>
   </methodparam>
   <methodparam
   choice="opt">
    <type>callable</type>
    <parameter>readcb</parameter>
    <initializer>&null;</initializer>
   </methodparam>
   <methodparam
   choice="opt">
    <type>callable</type>
    <parameter>writecb</parameter>
    <initializer>&null;</initializer>
   </methodparam>
   <methodparam
   choice="opt">
    <type>callable</type>
    <parameter>eventcb</parameter>
    <initializer>&null;</initializer>
   </methodparam>
   <methodparam
   choice="opt">
    <type>mixed</type>
    <parameter>arg</parameter>
    <initializer>&null;</initializer>
   </methodparam>
  </methodsynopsis>
  <para>
   Create a buffer event on a socket, stream or a file descriptor. Passing
   &null; to
   <parameter>socket</parameter>
   means that the socket should be created later, e.g. by means of
   <methodname>EventBufferEvent::connect</methodname>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term>
     <parameter>base</parameter>
    </term>
    <listitem>
     <para>
      Event base that should be associated with the new buffer event.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>socket</parameter>
    </term>
    <listitem>
     <para>
      May be created as a stream(not necessarily by means of
      <literal>sockets</literal>
      extension)
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>options</parameter>
    </term>
    <listitem>
     <para>
      One of
      <link linkend="eventbufferevent.constants">EventBufferEvent::OPT_*
     constants</link>,
      or
      <literal>0</literal>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>readcb</parameter>
    </term>
    <listitem>
     <para>
      Read event callback. See
      <link linkend="eventbufferevent.about.callbacks">About buffer event
     callbacks</link>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>writecb</parameter>
    </term>
    <listitem>
     <para>
      Write event callback. See
      <link linkend="eventbufferevent.about.callbacks">About buffer event
     callbacks</link>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>eventcb</parameter>
    </term>
    <listitem>
     <para>
      Status-change event callback. See
      <link linkend="eventbufferevent.about.callbacks">About buffer event
     callbacks</link>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>arg</parameter>
    </term>
    <listitem>
     <para>
      A variable that will be passed to all the callbacks.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member>
    <methodname>EventBufferEvent::sslFilter</methodname>
   </member>
   <member>
    <methodname>EventBufferEvent::sslSocket</methodname>
   </member>
  </simplelist>
 </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
-->