File: Event.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (155 lines) | stat: -rw-r--r-- 7,074 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Event" namespace="" name="Event">
  <constant name="ET" value="32">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="PERSIST" value="16">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="READ" value="2">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="WRITE" value="4">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="SIGNAL" value="8">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TIMEOUT" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <member name="pending" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Whether event is pending. See About event persistence ."/>
      <var type="bool"/>
    </docblock>
  </member>
  <method name="add" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Makes event pending">Marks event pending. Non-pending event will never occur, and the event callback will never be called. In conjuction with Event::del an event could be re-scheduled by user at any time.</description>
      <return type="bool"/>
    </docblock>
    <parameter name="timeout" optional="true" byreference="false" type="object" class="float"/>
  </method>
  <method name="addSignal" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Makes signal event pending"/>
      <return type="bool"/>
    </docblock>
    <parameter name="timeout" optional="true" byreference="false" type="object" class="float"/>
  </method>
  <method name="addTimer" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Makes timer event pending"/>
      <return type="bool"/>
    </docblock>
    <parameter name="timeout" optional="true" byreference="false" type="object" class="float"/>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructs Event object"/>
      <return type="void"/>
    </docblock>
    <parameter name="base" optional="false" byreference="false" type="object" class="EventBase"/>
    <parameter name="fd" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="what" optional="false" byreference="false" type="int"/>
    <parameter name="cb" optional="false" byreference="false" type="object" class="callable"/>
    <parameter name="arg" optional="true" byreference="false" type="object" class="mixed"/>
  </constructor>
  <method name="del" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Makes event non-pending"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="delSignal" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Makes signal event non-pending"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="delTimer" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Makes timer event non-pending"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="free" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Make event non-pending and free resources allocated for this&#10;  event">Removes event from the list of events monitored by libevent, and free resources allocated for the event.</description>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getSupportedMethods" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns array with of the names of the methods supported in this version of Libevent"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="pending" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Detects whether event is pending or scheduled"/>
      <return type="bool"/>
    </docblock>
    <parameter name="flags" optional="false" byreference="false" type="int"/>
  </method>
  <method name="set" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Re-configures event"/>
      <return type="bool"/>
    </docblock>
    <parameter name="base" optional="false" byreference="false" type="object" class="EventBase"/>
    <parameter name="fd" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="what" optional="true" byreference="false" type="int"/>
    <parameter name="cb" optional="true" byreference="false" type="object" class="callable"/>
    <parameter name="arg" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="setPriority" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set event priority"/>
      <return type="bool"/>
    </docblock>
    <parameter name="priority" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setTimer" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Re-configures timer event"/>
      <return type="bool"/>
    </docblock>
    <parameter name="base" optional="false" byreference="false" type="object" class="EventBase"/>
    <parameter name="cb" optional="false" byreference="false" type="object" class="callable"/>
    <parameter name="arg" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="signal" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructs signal event object"/>
      <return type="Event"/>
    </docblock>
    <parameter name="base" optional="false" byreference="false" type="object" class="EventBase"/>
    <parameter name="signum" optional="false" byreference="false" type="int"/>
    <parameter name="cb" optional="false" byreference="false" type="object" class="callable"/>
    <parameter name="arg" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="timer" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructs timer event object"/>
      <return type="Event"/>
    </docblock>
    <parameter name="base" optional="false" byreference="false" type="object" class="EventBase"/>
    <parameter name="cb" optional="false" byreference="false" type="object" class="callable"/>
    <parameter name="arg" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
</class>