1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
<?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
-->
|
