php-doc-en/reference/libevent/functions/event-buffer-set-callback.xml
Jakub Vrana 7e8e878bc0 Fix protos
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@308237 c90b9560-bf6c-de11-be94-00142212c4b1
2011-02-10 22:56:00 +00:00

103 lines
2.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.event-buffer-set-callback" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_buffer_set_callback</refname>
<refpurpose>Set or reset callbacks for a buffered event</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>event_buffer_set_callback</methodname>
<methodparam><type>resource</type><parameter>event</parameter></methodparam>
<methodparam><type>mixed</type><parameter>readcb</parameter></methodparam>
<methodparam><type>mixed</type><parameter>writecb</parameter></methodparam>
<methodparam><type>mixed</type><parameter>errorcb</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<para>
Sets or changes existing callbacks for the buffered <parameter>event</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>event</parameter></term>
<listitem>
<para>
Valid buffered event resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>readcb</parameter></term>
<listitem>
<para>
Callback to invoke where there is data to read, or <type>NULL</type> if
no callback is desired.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>writecb</parameter></term>
<listitem>
<para>
Callback to invoke where the descriptor is ready for writing,
or <type>NULL</type> if no callback is desired.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>errorcb</parameter></term>
<listitem>
<para>
Callback to invoke where there is an error on the descriptor, cannot be
<type>NULL</type>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>arg</parameter></term>
<listitem>
<para>
An argument that will be passed to each of the callbacks (optional).
</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
-->