File: EventBase.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 (115 lines) | stat: -rw-r--r-- 4,465 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="EventBase" namespace="" name="EventBase">
  <constant name="LOOP_ONCE" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="LOOP_NONBLOCK" value="2">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="NOLOCK" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="STARTUP_IOCP" value="4">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="NO_CACHE_TIME" value="8">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="EPOLL_USE_CHANGELIST" value="16">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructs EventBase object"/>
      <return type="void"/>
    </docblock>
    <parameter name="cfg" optional="true" byreference="false" type="object" class="EventConfig"/>
  </constructor>
  <method name="dispatch" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Dispatch pending events">Wait for events to become active, and run their callbacks. The same as EventBase::loop with no flags set.</description>
      <return type="void"/>
    </docblock>
  </method>
  <method name="exit" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Stop dispatching events"/>
      <return type="bool"/>
    </docblock>
    <parameter name="timeout" optional="true" byreference="false" type="object" class="float"/>
  </method>
  <method name="free" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Free resources allocated for this event base">Deallocates resources allocated by libevent for the EventBase object.</description>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getFeatures" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns bitmask of features supported"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getMethod" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns event method in use"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getTimeOfDayCached" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the current event base time"/>
      <return type="float"/>
    </docblock>
  </method>
  <method name="gotExit" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if the event loop was told to exit"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="gotStop" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if the event loop was told to exit"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="loop" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Dispatch pending events">Wait for events to become active, and run their callbacks.</description>
      <return type="bool"/>
    </docblock>
    <parameter name="flags" optional="true" byreference="false" type="int"/>
  </method>
  <method name="priorityInit" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets number of priorities per event base"/>
      <return type="bool"/>
    </docblock>
    <parameter name="n_priorities" optional="false" byreference="false" type="int"/>
  </method>
  <method name="reInit" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Re-initialize event base(after a fork)"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="stop" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Tells event_base to stop dispatching events"/>
      <return type="bool"/>
    </docblock>
  </method>
</class>