mirror of
https://github.com/php/doc-en.git
synced 2026-03-23 23:32:18 +01:00
4754397753
Document false and null return types Cf. <https://news-web.php.net/php.doc.cvs/17645>. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351729 c90b9560-bf6c-de11-be94-00142212c4b1
103 lines
2.6 KiB
XML
103 lines
2.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="eventbuffer.pullup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>EventBuffer::pullup</refname>
|
|
<refpurpose>Linearizes data within buffer
|
|
and returns it's contents as a string</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier>
|
|
<type>string</type>
|
|
<methodname>EventBuffer::pullup</methodname>
|
|
<methodparam>
|
|
<type>int</type>
|
|
<parameter>size</parameter>
|
|
</methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
"Linearizes" the first
|
|
<parameter>size</parameter>
|
|
bytes of the buffer, copying or moving them as needed to ensure that they
|
|
are all contiguous and occupying the same chunk of memory. If size is
|
|
negative, the function linearizes the entire buffer.
|
|
</para>
|
|
<warning>
|
|
<para>
|
|
Calling
|
|
<methodname>EventBuffer::pullup</methodname>
|
|
with a large size can be quite slow, since it potentially needs to copy
|
|
the entire buffer's contents.
|
|
</para>
|
|
</warning>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>size</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
The number of bytes required to be contiguous within the buffer.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
If
|
|
<parameter>size</parameter>
|
|
is greater than the number of bytes in the buffer, the function returns
|
|
&null;. Otherwise,
|
|
<methodname>EventBuffer::pullup</methodname>
|
|
returns string.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member>
|
|
<methodname>EventBuffer::copyout</methodname>
|
|
</member>
|
|
<member>
|
|
<methodname>EventBuffer::drain</methodname>
|
|
</member>
|
|
<member>
|
|
<methodname>EventBuffer::read</methodname>
|
|
</member>
|
|
<member>
|
|
<methodname>EventBuffer::readLine</methodname>
|
|
</member>
|
|
<member>
|
|
<methodname>EventBuffer::appendFrom</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
|
|
-->
|