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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="EventBufferEvent" namespace="" name="EventBufferEvent">
<constant name="READING" value="1">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="WRITING" value="2">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="EOF" value="16">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="ERROR" value="32">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="TIMEOUT" value="64">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="CONNECTED" value="128">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="OPT_CLOSE_ON_FREE" value="1">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="OPT_THREADSAFE" value="2">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="OPT_DEFER_CALLBACKS" value="4">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="OPT_UNLOCK_CALLBACKS" value="8">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="SSL_OPEN" value="0">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="SSL_CONNECTING" value="1">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="SSL_ACCEPTING" value="2">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<member name="fd" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="Numeric file descriptor associated with the buffer event. Normally represents a bound socket. Equals to NULL, if there is no file descriptor(socket) associated with the buffer event."/>
<var type="integer"/>
</docblock>
</member>
<member name="priority" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="The priority of the events used to implement the buffer event."/>
<var type="integer"/>
</docblock>
</member>
<member name="input" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="Underlying input buffer object( EventBuffer )"/>
<var type="EventBuffer"/>
</docblock>
</member>
<member name="output" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="Underlying output buffer object( EventBuffer )"/>
<var type="EventBuffer"/>
</docblock>
</member>
<method name="close" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Closes file descriptor associated with the current buffer event">Closes file descriptor associated with the current buffer event.</description>
<return type="void"/>
</docblock>
</method>
<method name="connect" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Connect buffer event's file descriptor to given address or UNIX socket">Connect buffer event's file descriptor to given address(optionally with port), or a UNIX domain socket.</description>
<return type="bool"/>
</docblock>
<parameter name="addr" optional="false" byreference="false" type="string"/>
</method>
<method name="connectHost" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Connects to a hostname with optionally asyncronous DNS resolving">Resolves the DNS name hostname, looking for addresses of type family ( EventUtil::AF_* constants). If the name resolution fails, it invokes the event callback with an error event. If it succeeds, it launches a connection attempt just as EventBufferEvent::connect would.</description>
<return type="bool"/>
</docblock>
<parameter name="dns_base" optional="false" byreference="false" type="object" class="EventDnsBase"/>
<parameter name="hostname" optional="false" byreference="false" type="string"/>
<parameter name="port" optional="false" byreference="false" type="int"/>
<parameter name="family" optional="true" byreference="false" type="int"/>
</method>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Constructs EventBufferEvent object"/>
<return type="void"/>
</docblock>
<parameter name="base" optional="false" byreference="false" type="object" class="EventBase"/>
<parameter name="socket" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="options" optional="true" byreference="false" type="int"/>
<parameter name="readcb" optional="true" byreference="false" type="object" class="callable"/>
<parameter name="writecb" optional="true" byreference="false" type="object" class="callable"/>
<parameter name="eventcb" optional="true" byreference="false" type="object" class="callable"/>
</constructor>
<method name="createPair" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Creates two buffer events connected to each other"/>
<return type="array"/>
</docblock>
<parameter name="base" optional="false" byreference="false" type="object" class="EventBase"/>
<parameter name="options" optional="true" byreference="false" type="int"/>
</method>
<method name="disable" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Disable events read, write, or both on a buffer event"/>
<return type="bool"/>
</docblock>
<parameter name="events" optional="false" byreference="false" type="int"/>
</method>
<method name="enable" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Enable events read, write, or both on a buffer event"/>
<return type="bool"/>
</docblock>
<parameter name="events" optional="false" byreference="false" type="int"/>
</method>
<method name="free" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Free a buffer event">Free resources allocated by buffer event.</description>
<return type="void"/>
</docblock>
</method>
<method name="getDnsErrorString" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns string describing the last failed DNS lookup attempt"/>
<return type="string"/>
</docblock>
</method>
<method name="getEnabled" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns bitmask of events currently enabled on the buffer event"/>
<return type="int"/>
</docblock>
</method>
<method name="getInput" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns underlying input buffer associated with current buffer event">Returns underlying input buffer associated with current buffer event. An input buffer is a storage for data to read.</description>
<return type="EventBuffer"/>
</docblock>
</method>
<method name="getOutput" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns underlying output buffer associated with current buffer event">Returns underlying output buffer associated with current buffer event. An output buffer is a storage for data to be written.</description>
<return type="EventBuffer"/>
</docblock>
</method>
<method name="read" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Read buffer's data"/>
<return type="string"/>
</docblock>
<parameter name="size" optional="false" byreference="false" type="int"/>
</method>
<method name="readBuffer" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Drains the entire contents of the input buffer and places them into buf"/>
<return type="bool"/>
</docblock>
<parameter name="buf" optional="false" byreference="false" type="object" class="EventBuffer"/>
</method>
<method name="setCallbacks" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Assigns read, write and event(status) callbacks"/>
<return type="void"/>
</docblock>
<parameter name="readcb" optional="false" byreference="false" type="object" class="callable"/>
<parameter name="writecb" optional="false" byreference="false" type="object" class="callable"/>
<parameter name="eventcb" optional="false" byreference="false" type="object" class="callable"/>
<parameter name="arg" optional="true" byreference="false" type="string"/>
</method>
<method name="setPriority" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Assign a priority to a bufferevent">Assign a priority to a bufferevent</description>
<return type="bool"/>
</docblock>
<parameter name="priority" optional="false" byreference="false" type="int"/>
</method>
<method name="setTimeouts" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set the read and write timeout for a buffer event"/>
<return type="bool"/>
</docblock>
<parameter name="timeout_read" optional="false" byreference="false" type="object" class="float"/>
<parameter name="timeout_write" optional="false" byreference="false" type="object" class="float"/>
</method>
<method name="setWatermark" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Adjusts read and/or write watermarks">Adjusts the read watermarks, the write watermarks , or both, of a single buffer event.</description>
<return type="void"/>
</docblock>
<parameter name="events" optional="false" byreference="false" type="int"/>
<parameter name="lowmark" optional="false" byreference="false" type="int"/>
<parameter name="highmark" optional="false" byreference="false" type="int"/>
</method>
<method name="sslError" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns most recent OpenSSL error reported on the buffer event">Returns most recent OpenSSL error reported on the buffer event.</description>
<return type="string"/>
</docblock>
</method>
<method name="sslFilter" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Create a new SSL buffer event to send its data over another buffer event">Create a new SSL buffer event to send its data over another buffer event</description>
<return type="EventBufferEvent"/>
</docblock>
<parameter name="base" optional="false" byreference="false" type="object" class="EventBase"/>
<parameter name="underlying" optional="false" byreference="false" type="object" class="EventBufferEvent"/>
<parameter name="ctx" optional="false" byreference="false" type="object" class="EventSslContext"/>
<parameter name="state" optional="false" byreference="false" type="int"/>
<parameter name="options" optional="true" byreference="false" type="int"/>
</method>
<method name="sslGetCipherInfo" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns a textual description of the cipher">Retrieves description of the current cipher by means of the SSL_CIPHER_description SSL API function (see SSL_CIPHER_get_name(3) man page).</description>
<return type="string"/>
</docblock>
</method>
<method name="sslGetCipherName" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the current cipher name of the SSL connection">Retrieves name of cipher used by current SSL connection.</description>
<return type="string"/>
</docblock>
</method>
<method name="sslGetCipherVersion" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns version of cipher used by current SSL connection">Retrieves version of cipher used by current SSL connection.</description>
<return type="string"/>
</docblock>
</method>
<method name="sslGetProtocol" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the name of the protocol used for current SSL connection">Returns the name of the protocol used for current SSL connection.</description>
<return type="string"/>
</docblock>
</method>
<method name="sslRenegotiate" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Tells a bufferevent to begin SSL renegotiation">Tells a bufferevent to begin SSL renegotiation.</description>
<return type="void"/>
</docblock>
</method>
<method name="sslSocket" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Creates a new SSL buffer event to send its data over an SSL on a socket"/>
<return type="EventBufferEvent"/>
</docblock>
<parameter name="base" optional="false" byreference="false" type="object" class="EventBase"/>
<parameter name="socket" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="ctx" optional="false" byreference="false" type="object" class="EventSslContext"/>
<parameter name="state" optional="false" byreference="false" type="int"/>
<parameter name="options" optional="true" byreference="false" type="int"/>
</method>
<method name="write" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Adds data to a buffer event's output buffer"/>
<return type="bool"/>
</docblock>
<parameter name="data" optional="false" byreference="false" type="string"/>
</method>
<method name="writeBuffer" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Adds contents of the entire buffer to a buffer event's output buffer"/>
<return type="bool"/>
</docblock>
<parameter name="buf" optional="false" byreference="false" type="object" class="EventBuffer"/>
</method>
</class>
|
