Files
doc-fr/reference/event/eventbufferevent/construct.xml
Sergey Panteleev 61e2f37548 Sync various docs with EN (#163)
Co-authored-by: George Peter Banyard <girgias@php.net>
2022-02-15 10:33:48 +00:00

183 lines
4.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 235a4b9e5a263de6b122c80e6e8142508a36951d Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<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>Construit un objet EventBufferEvent</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>
Crée un tampon d'événement sur un socket, un flux, ou un descripteur
de fichier. Le fait de passer la valeur &null; au paramètre
<parameter>socket</parameter> signifie que le socket doit être créé
ultérieurement, i.e. via la méthode
<methodname>EventBufferEvent::connect</methodname>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>base</parameter>
</term>
<listitem>
<para>
Evenement de base qui doit être associé avec le nouveau tampon d'événement.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>socket</parameter>
</term>
<listitem>
<para>
Doit être créé comme flux (non nécessairement via l'extension
<literal>sockets</literal>)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>options</parameter>
</term>
<listitem>
<para>
Une constante parmi les constantes
<link linkend="eventbufferevent.constants">EventBufferEvent::OPT_*</link>,
ou <constant>0</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>readcb</parameter>
</term>
<listitem>
<para>
Fonction de rappel pour les événements de lecture. Voir aussi
les <link linkend="eventbufferevent.about.callbacks">fonctions
de rappel des tampon d'événement</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>writecb</parameter>
</term>
<listitem>
<para>
Fonction de rappel pour les événements d'écriture. Voir aussi les
<link linkend="eventbufferevent.about.callbacks">fonctions
de rappel des tampon d'événement</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>eventcb</parameter>
</term>
<listitem>
<para>
Fonction de rappel pour les événements de changement de statut.
Voir aussi les
<link linkend="eventbufferevent.about.callbacks">fonctions
de rappel des tampon d'événement</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>arg</parameter>
</term>
<listitem>
<para>
Une variable qui sera passée à toutes les fonctions de rappel.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne une ressource de tampon d'événement, associée à la ressource
de socket.
</para>
</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
-->