mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 08:58:56 +00:00
Del: deprecated event methods
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@329988 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Ruslan Osmanov
parent
83ae6fd821
commit
8bb5f551df
2 changed files with 0 additions and 204 deletions
|
|
@ -1,105 +0,0 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id="eventbuffer.remove" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>EventBuffer::remove</refname>
|
||||
<refpurpose>Read data from an evbuffer and drain the bytes read</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier>
|
||||
<type>int</type>
|
||||
<methodname>EventBuffer::remove</methodname>
|
||||
<methodparam>
|
||||
<type>string</type>
|
||||
<parameter role="reference">data</parameter>
|
||||
</methodparam>
|
||||
<methodparam>
|
||||
<type>int</type>
|
||||
<parameter>max_bytes</parameter>
|
||||
</methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Read the first
|
||||
<parameter>max_bytes</parameter>
|
||||
from the buffer and drain the bytes read. If more
|
||||
<parameter>max_bytes</parameter>
|
||||
are requested than are available in the buffer, it only extracts as many
|
||||
bytes as available.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>data</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Storage for the string read.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>max_bytes</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Maxmimum number of bytes to read from the buffer.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the number of bytes read, or
|
||||
<constant>-1</constant>
|
||||
if it can't drain the buffer.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member>
|
||||
<methodname>EventBuffer::copyout</methodname>
|
||||
</member>
|
||||
<member>
|
||||
<methodname>EventBuffer::drain</methodname>
|
||||
</member>
|
||||
<member>
|
||||
<methodname>EventBuffer::pullup</methodname>
|
||||
</member>
|
||||
<member>
|
||||
<methodname>EventBuffer::readLine</methodname>
|
||||
</member>
|
||||
<member>
|
||||
<methodname>EventBuffer::removeBuffer</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
|
||||
-->
|
||||
|
|
@ -1,99 +0,0 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id="eventbuffer.removebuffer" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>EventBuffer::removeBuffer</refname>
|
||||
<refpurpose>Moves the specified number of bytes from a source buffer to the
|
||||
end of the current buffer</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier>
|
||||
<type>int</type>
|
||||
<methodname>EventBuffer::removeBuffer</methodname>
|
||||
<methodparam>
|
||||
<type>EventBuffer</type>
|
||||
<parameter>buf</parameter>
|
||||
</methodparam>
|
||||
<methodparam>
|
||||
<type>int</type>
|
||||
<parameter>len</parameter>
|
||||
</methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Moves the specified number of bytes from a source buffer to the end of the
|
||||
current buffer. If there are fewer number of bytes, it moves all the bytes
|
||||
available from the source buffer.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>buf</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Source buffer.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>len</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the number of bytes read.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member>
|
||||
<methodname>EventBuffer::copyout</methodname>
|
||||
</member>
|
||||
<member>
|
||||
<methodname>EventBuffer::drain</methodname>
|
||||
</member>
|
||||
<member>
|
||||
<methodname>EventBuffer::pullup</methodname>
|
||||
</member>
|
||||
<member>
|
||||
<methodname>EventBuffer::readLine</methodname>
|
||||
</member>
|
||||
<member>
|
||||
<methodname>EventBuffer::remove</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
|
||||
-->
|
||||
Loading…
Reference in a new issue