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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 332633 $ -->
<refentry xml:id="eventbufferevent.createpair" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EventBufferEvent::createPair</refname>
<refpurpose>Creates two buffer events connected to each other</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<modifier>static</modifier>
<type>array</type>
<methodname>EventBufferEvent::createPair</methodname>
<methodparam>
<type>EventBase</type>
<parameter>base</parameter>
</methodparam>
<methodparam
choice="opt">
<type>int</type>
<parameter>options</parameter>
<initializer>0</initializer>
</methodparam>
</methodsynopsis>
<para>
Returns array of two
<classname>EventBufferEvent</classname>
objects connected to each other. All the usual options are supported,
except for
<constant>EventBufferEvent::OPT_CLOSE_ON_FREE</constant>
, which has no effect, and
<constant>EventBufferEvent::OPT_DEFER_CALLBACKS</constant>
, which is always on.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>base</parameter>
</term>
<listitem>
<para>
Associated event base
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>options</parameter>
</term>
<listitem>
<para>
<link>EventBufferEvent::OPT_* constants</link>
combined with bitwise
<literal>OR</literal>
operator.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns array of two
<classname>EventBufferEvent</classname>
objects connected to each other.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>1.9.0</entry>
<entry>
Method made static.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</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
-->
|
