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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.event-set" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>event_set</refname>
<refpurpose>Prepare an event</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>event_set</methodname>
<methodparam><type>resource</type><parameter>event</parameter></methodparam>
<methodparam><type>resource</type><parameter>fd</parameter></methodparam>
<methodparam><type>int</type><parameter>events</parameter></methodparam>
<methodparam><type>mixed</type><parameter>callback</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<para>
Prepares the event to be used in <function>event_add</function>. The event
is prepared to call the function specified by the <parameter>callback</parameter>
on the events specified in parameter <parameter>events</parameter>, which
is a set of the following flags: <constant>EV_TIMEOUT</constant>,
<constant>EV_SIGNAL</constant>, <constant>EV_READ</constant> and
<constant>EV_WRITE</constant>.
</para>
<para>
After initializing the event, use <function>event_base_set</function> to
associate the event with its event base.
</para>
<para>
In case of matching event, these three arguments are passed to the
<parameter>callback</parameter> function:
<variablelist>
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
Resource indicating the stream.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>events</parameter></term>
<listitem>
<para>
A flag indicating the event. Can be one of the following:
<constant>EV_TIMEOUT</constant>, <constant>EV_SIGNAL</constant>,
<constant>EV_READ</constant> or <constant>EV_WRITE</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>arg</parameter></term>
<listitem>
<para>
Optional parameter, previously passed to <function>event_set</function>
as <parameter>arg</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>event</parameter></term>
<listitem>
<para>
Valid event resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
Valid PHP stream resource. The stream must be castable to file
descriptor, so you most likely won't be able to use any of filtered
streams.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>events</parameter></term>
<listitem>
<para>
A set of flags indicating the desired event, can be
<constant>EV_READ</constant> and/or <constant>EV_WRITE</constant>.
The additional flag <constant>EV_PERSIST</constant> makes the event
to persist until <function>event_del</function> is called, otherwise
the callback is invoked only once.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callback</parameter></term>
<listitem>
<para>
Callback function to be called when the matching event occurs.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>arg</parameter></term>
<listitem>
<para>
Optional callback parameter.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>event_set</function> returns &true; on success or &false; on error.
</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
-->
|
