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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="EventBuffer" namespace="" name="EventBuffer">
<constant name="EOL_ANY" value="0">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="EOL_CRLF" value="1">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="EOL_CRLF_STRICT" value="2">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="EOL_LF" value="3">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="PTR_SET" value="0">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="PTR_ADD" value="1">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<member name="length" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="The number of bytes stored in an event buffer."/>
<var type="int"/>
</docblock>
</member>
<member name="contiguous_space" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="The number of bytes stored contiguously at the front of the buffer. The bytes in a buffer may be stored in multiple separate chunks of memory; the property returns the number of bytes currently stored in the first chunk."/>
<var type="int"/>
</docblock>
</member>
<method name="add" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Append data to the end of an event buffer"/>
<return type="bool"/>
</docblock>
<parameter name="data" optional="false" byreference="false" type="string"/>
</method>
<method name="addBuffer" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Move all data from a buffer provided to the current instance of EventBuffer"/>
<return type="bool"/>
</docblock>
<parameter name="buf" optional="false" byreference="false" type="object" class="EventBuffer"/>
</method>
<method name="appendFrom" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Moves the specified number of bytes from a source buffer to the end of the current buffer"/>
<return type="int"/>
</docblock>
<parameter name="buf" optional="false" byreference="false" type="object" class="EventBuffer"/>
<parameter name="len" optional="false" byreference="false" type="int"/>
</method>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Constructs EventBuffer object"/>
<return type="void"/>
</docblock>
</constructor>
<method name="copyout" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Copies out specified number of bytes from the front of the buffer"/>
<return type="int"/>
</docblock>
<parameter name="data" optional="false" byreference="false" type="string"/>
<parameter name="max_bytes" optional="false" byreference="false" type="int"/>
</method>
<method name="drain" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Removes specified number of bytes from the front of the buffer without copying it anywhere"/>
<return type="bool"/>
</docblock>
<parameter name="len" optional="false" byreference="false" type="int"/>
</method>
<method name="enableLocking" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=""/>
<return type="void"/>
</docblock>
</method>
<method name="expand" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Reserves space in buffer"/>
<return type="bool"/>
</docblock>
<parameter name="len" optional="false" byreference="false" type="int"/>
</method>
<method name="freeze" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Prevent calls that modify an event buffer from succeeding"/>
<return type="bool"/>
</docblock>
<parameter name="at_front" optional="false" byreference="false" type="object" class="bool"/>
</method>
<method name="lock" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Acquires a lock on buffer"/>
<return type="void"/>
</docblock>
</method>
<method name="prepend" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Prepend data to the front of the buffer"/>
<return type="bool"/>
</docblock>
<parameter name="data" optional="false" byreference="false" type="string"/>
</method>
<method name="prependBuffer" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Moves all data from source buffer to the front of current buffer"/>
<return type="bool"/>
</docblock>
<parameter name="buf" optional="false" byreference="false" type="object" class="EventBuffer"/>
</method>
<method name="pullup" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Linearizes data within buffer and returns it's contents as a string">"Linearizes" the first size 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.</description>
<return type="string"/>
</docblock>
<parameter name="size" optional="false" byreference="false" type="int"/>
</method>
<method name="read" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Read data from an evbuffer and drain the bytes read"/>
<return type="string"/>
</docblock>
<parameter name="max_bytes" optional="false" byreference="false" type="int"/>
</method>
<method name="read" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Read data from an evbuffer and drain the bytes read"/>
<return type="int"/>
</docblock>
<parameter name="fd" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="howmuch" optional="false" byreference="false" type="int"/>
</method>
<method name="readLine" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Extracts a line from the front of the buffer"/>
<return type="string"/>
</docblock>
<parameter name="eol_style" optional="false" byreference="false" type="int"/>
</method>
<method name="search" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Scans the buffer for an occurrence of a string">Scans the buffer for an occurrence of the string what . It returns numeric position of the string, or FALSE if the string was not found.</description>
<return type="mixed"/>
</docblock>
<parameter name="what" optional="false" byreference="false" type="string"/>
<parameter name="start" optional="true" byreference="false" type="int"/>
<parameter name="end" optional="true" byreference="false" type="int"/>
</method>
<method name="searchEol" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Scans the buffer for an occurrence of an end of line">Scans the buffer for an occurrence of an end of line specified by eol_style parameter . It returns numeric position of the string, or FALSE if the string was not found.</description>
<return type="mixed"/>
</docblock>
<parameter name="start" optional="true" byreference="false" type="int"/>
<parameter name="eol_style" optional="true" byreference="false" type="int"/>
</method>
<method name="substr" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Substracts a portion of the buffer data"/>
<return type="string"/>
</docblock>
<parameter name="start" optional="false" byreference="false" type="int"/>
<parameter name="length" optional="true" byreference="false" type="int"/>
</method>
<method name="unfreeze" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Re-enable calls that modify an event buffer"/>
<return type="bool"/>
</docblock>
<parameter name="at_front" optional="false" byreference="false" type="object" class="bool"/>
</method>
<method name="unlock" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Releases lock acquired by EventBuffer::lock"/>
<return type="bool"/>
</docblock>
</method>
<method name="write" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Write contents of the buffer to a file or socket"/>
<return type="int"/>
</docblock>
<parameter name="fd" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="howmuch" optional="true" byreference="false" type="int"/>
</method>
</class>
|
