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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 329774 $ -->
<refentry xml:id="eventbufferevent.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EventBufferEvent::__construct</refname>
<refpurpose>Constructs EventBufferEvent object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<methodname>EventBufferEvent::__construct</methodname>
<methodparam>
<type>EventBase</type>
<parameter>base</parameter>
</methodparam>
<methodparam
choice="opt">
<type>mixed</type>
<parameter>socket</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<type>int</type>
<parameter>options</parameter>
<initializer>0</initializer>
</methodparam>
<methodparam
choice="opt">
<type>callable</type>
<parameter>readcb</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<type>callable</type>
<parameter>writecb</parameter>
<initializer>&null;</initializer>
</methodparam>
<methodparam
choice="opt">
<type>callable</type>
<parameter>eventcb</parameter>
<initializer>&null;</initializer>
</methodparam>
</methodsynopsis>
<para>
Create a buffer event on a socket, stream or a file descriptor. Passing
&null; to
<parameter>socket</parameter>
means that the socket should be created later, e.g. by means of
<methodname>EventBufferEvent::connect</methodname>
.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>base</parameter>
</term>
<listitem>
<para>
Event base that should be associated with the new buffer event.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>socket</parameter>
</term>
<listitem>
<para>
May be created as a stream(not necessarily by means of
<literal>sockets</literal>
extension)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>options</parameter>
</term>
<listitem>
<para>
One of
<link linkend="eventbufferevent.constants">EventBufferEvent::OPT_*
constants</link>
, or
<constant>0</constant>
.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>readcb</parameter>
</term>
<listitem>
<para>
Read event callback. See
<link linkend="eventbufferevent.about.callbacks">About buffer event
callbacks</link>
.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>writecb</parameter>
</term>
<listitem>
<para>
Write event callback. See
<link linkend="eventbufferevent.about.callbacks">About buffer event
callbacks</link>
.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>eventcb</parameter>
</term>
<listitem>
<para>
Status-change event callback. See
<link linkend="eventbufferevent.about.callbacks">About buffer event
callbacks</link>
.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>arg</parameter>
</term>
<listitem>
<para>
A variable that will be passed to all the callbacks.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns buffer event resource optionally associated with socket resource.
*/
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member>
<methodname>EventBufferEvent::sslFilter</methodname>
</member>
<member>
<methodname>EventBufferEvent::sslSocket</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
-->
|
