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
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="GearmanWorker" namespace="" name="GearmanWorker">
<method name="addFunction" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Register and add callback function"/>
<return type="bool"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
<parameter name="function" optional="false" byreference="false" type="object" class="callable"/>
<parameter name="context" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="timeout" optional="true" byreference="false" type="int"/>
</method>
<method name="addOptions" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add worker options"/>
<return type="bool"/>
</docblock>
<parameter name="option" optional="false" byreference="false" type="int"/>
</method>
<method name="addServer" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add a job server"/>
<return type="bool"/>
</docblock>
<parameter name="host" optional="true" byreference="false" type="string"/>
<parameter name="port" optional="true" byreference="false" type="int"/>
</method>
<method name="addServers" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add job servers"/>
<return type="bool"/>
</docblock>
<parameter name="servers" optional="false" byreference="false" type="string"/>
</method>
<method name="clone" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Create a copy of the worker"/>
<return type="void"/>
</docblock>
</method>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Create a GearmanWorker instance"/>
<return type="void"/>
</docblock>
</constructor>
<method name="echo" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Test job server response"/>
<return type="bool"/>
</docblock>
<parameter name="workload" optional="false" byreference="false" type="string"/>
</method>
<method name="error" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the last error encountered"/>
<return type="string"/>
</docblock>
</method>
<method name="getErrno" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get errno"/>
<return type="int"/>
</docblock>
</method>
<method name="options" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get worker options"/>
<return type="int"/>
</docblock>
</method>
<method name="register" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Register a function with the job server"/>
<return type="bool"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
<parameter name="timeout" optional="true" byreference="false" type="int"/>
</method>
<method name="removeOptions" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Remove worker options"/>
<return type="bool"/>
</docblock>
<parameter name="option" optional="false" byreference="false" type="int"/>
</method>
<method name="returnCode" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get last Gearman return code"/>
<return type="int"/>
</docblock>
</method>
<method name="setId" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Give the worker an identifier so it can be tracked when asking gearmand for the list of available workers"/>
<return type="bool"/>
</docblock>
<parameter name="id" optional="false" byreference="false" type="string"/>
</method>
<method name="setOptions" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set worker options"/>
<return type="bool"/>
</docblock>
<parameter name="option" optional="false" byreference="false" type="int"/>
</method>
<method name="setTimeout" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set socket I/O activity timeout"/>
<return type="bool"/>
</docblock>
<parameter name="timeout" optional="false" byreference="false" type="int"/>
</method>
<method name="timeout" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get socket I/O activity timeout"/>
<return type="int"/>
</docblock>
</method>
<method name="unregister" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Unregister a function name with the job servers"/>
<return type="bool"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
</method>
<method name="unregisterAll" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Unregister all function names with the job servers"/>
<return type="bool"/>
</docblock>
</method>
<method name="wait" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Wait for activity from one of the job servers"/>
<return type="bool"/>
</docblock>
</method>
<method name="work" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Wait for and perform jobs"/>
<return type="bool"/>
</docblock>
</method>
</class>
|
