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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 329774 $ -->
<chapter xml:id="eventbufferevent.about.callbacks" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>About buffer event callbacks</title>
<para>
An object of
<classname>EventBufferEvent</classname>
class represents a
<emphasis>buffer event</emphasis>
. The asynchronous nature of I/O performed by Libevent implies that a
socket(or other kind of file descriptor) is not always available. Event
invokes corresponding callbacks when the resource becomes available for
reading or writing, or when some event occurs(e.g. error, "end of line"
etc.).
</para>
<para>
Read and write callbacks should match the following prototype:
</para>
<methodsynopsis>
<type>void</type>
<methodname>callback</methodname>
<methodparam
choice="opt">
<type>EventBufferEvent</type>
<parameter>bev</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<type>mixed</type>
<parameter>arg</parameter>
<initializer>&null;</initializer>
</methodparam>
</methodsynopsis>
<para>
<variablelist>
<varlistentry>
<term>
<parameter>bev</parameter>
</term>
<listitem>
<para>
Associated
<classname>EventBufferEvent</classname>
object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>arg</parameter>
</term>
<listitem>
<para>
Custom variable attached to all callbacks via
<methodname>EventBufferEvent::__construct</methodname>
, or
<methodname>EventBufferEvent::setCallbacks</methodname>
.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Event callback should match the following prototype:
</para>
<methodsynopsis>
<type>void</type>
<methodname>callback</methodname>
<methodparam
choice="opt">
<type>EventBufferEvent</type>
<parameter>bev</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<type>int</type>
<parameter>events</parameter>
<initializer>0</initializer>
</methodparam>
<methodparam
choice="opt">
<type>mixed</type>
<parameter>arg</parameter>
<initializer>&null;</initializer>
</methodparam>
</methodsynopsis>
<para>
<variablelist>
<varlistentry>
<term>
<parameter>bev</parameter>
</term>
<listitem>
<para>
Associated
<classname>EventBufferEvent</classname>
object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>events</parameter>
</term>
<listitem>
<para>
Bit mask of events:
<constant>EventBufferEvent::READING</constant>
,
<constant>EventBufferEvent::WRITING</constant>
,
<constant>EventBufferEvent::EOL</constant>
,
<constant>EventBufferEvent::ERROR</constant>
and
<constant>EventBufferEvent::TIMEOUT</constant>
. See
<link linkend="eventbufferevent.constants">EventBufferEvent constants</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>arg</parameter>
</term>
<listitem>
<para>
Custom variable attached to all callbacks via
<methodname>EventBufferEvent::__construct</methodname>
, or
<methodname>EventBufferEvent::setCallbacks</methodname>
.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</chapter>
<!-- 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
-->
|
