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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="GearmanClient" namespace="" name="GearmanClient">
<method name="addOptions" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add client options"/>
<return type="bool"/>
</docblock>
<parameter name="options" 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 to the client"/>
<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 a list of job servers to the client"/>
<return type="bool"/>
</docblock>
<parameter name="servers" optional="true" byreference="false" type="string"/>
</method>
<method name="addTask" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add a task to be run in parallel"/>
<return type="GearmanTask"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
<parameter name="workload" optional="false" byreference="false" type="string"/>
<parameter name="context" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="unique" optional="true" byreference="false" type="string"/>
</method>
<method name="addTaskBackground" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add a background task to be run in parallel"/>
<return type="GearmanTask"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
<parameter name="workload" optional="false" byreference="false" type="string"/>
<parameter name="context" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="unique" optional="true" byreference="false" type="string"/>
</method>
<method name="addTaskHigh" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add a high priority task to run in parallel"/>
<return type="GearmanTask"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
<parameter name="workload" optional="false" byreference="false" type="string"/>
<parameter name="context" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="unique" optional="true" byreference="false" type="string"/>
</method>
<method name="addTaskHighBackground" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add a high priority background task to be run in parallel"/>
<return type="GearmanTask"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
<parameter name="workload" optional="false" byreference="false" type="string"/>
<parameter name="context" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="unique" optional="true" byreference="false" type="string"/>
</method>
<method name="addTaskLow" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add a low priority task to run in parallel"/>
<return type="GearmanTask"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
<parameter name="workload" optional="false" byreference="false" type="string"/>
<parameter name="context" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="unique" optional="true" byreference="false" type="string"/>
</method>
<method name="addTaskLowBackground" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add a low priority background task to be run in parallel"/>
<return type="GearmanTask"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
<parameter name="workload" optional="false" byreference="false" type="string"/>
<parameter name="context" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="unique" optional="true" byreference="false" type="string"/>
</method>
<method name="addTaskStatus" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add a task to get status"/>
<return type="GearmanTask"/>
</docblock>
<parameter name="job_handle" optional="false" byreference="false" type="string"/>
<parameter name="context" optional="true" byreference="false" type="string"/>
</method>
<method name="clearCallbacks" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Clear all task callback functions"/>
<return type="bool"/>
</docblock>
</method>
<method name="clone" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Create a copy of a GearmanClient object"/>
<return type="GearmanClient"/>
</docblock>
</method>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Create a GearmanClient instance"/>
<return type="void"/>
</docblock>
</constructor>
<method name="context" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the application context"/>
<return type="string"/>
</docblock>
</method>
<method name="data" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the application data (deprecated)">Get the application data previously set with GearmanClient::setData.</description>
<return type="string"/>
</docblock>
</method>
<method name="do" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Run a single task and return a result [deprecated]"/>
<return type="string"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
<parameter name="workload" optional="false" byreference="false" type="string"/>
<parameter name="unique" optional="true" byreference="false" type="string"/>
</method>
<method name="doBackground" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Run a task in the background"/>
<return type="string"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
<parameter name="workload" optional="false" byreference="false" type="string"/>
<parameter name="unique" optional="true" byreference="false" type="string"/>
</method>
<method name="doHigh" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Run a single high priority task"/>
<return type="string"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
<parameter name="workload" optional="false" byreference="false" type="string"/>
<parameter name="unique" optional="true" byreference="false" type="string"/>
</method>
<method name="doHighBackground" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Run a high priority task in the background"/>
<return type="string"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
<parameter name="workload" optional="false" byreference="false" type="string"/>
<parameter name="unique" optional="true" byreference="false" type="string"/>
</method>
<method name="doJobHandle" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the job handle for the running task"/>
<return type="string"/>
</docblock>
</method>
<method name="doLow" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Run a single low priority task"/>
<return type="string"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
<parameter name="workload" optional="false" byreference="false" type="string"/>
<parameter name="unique" optional="true" byreference="false" type="string"/>
</method>
<method name="doLowBackground" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Run a low priority task in the background"/>
<return type="string"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
<parameter name="workload" optional="false" byreference="false" type="string"/>
<parameter name="unique" optional="true" byreference="false" type="string"/>
</method>
<method name="doNormal" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Run a single task and return a result"/>
<return type="string"/>
</docblock>
<parameter name="function_name" optional="false" byreference="false" type="string"/>
<parameter name="workload" optional="false" byreference="false" type="string"/>
<parameter name="unique" optional="true" byreference="false" type="string"/>
</method>
<method name="doStatus" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the status for the running task"/>
<return type="array"/>
</docblock>
</method>
<method name="echo" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Send data to all job servers to see if they echo it back [deprecated]"/>
<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="Returns an error string for the last error encountered"/>
<return type="string"/>
</docblock>
</method>
<method name="getErrno" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get an errno value"/>
<return type="int"/>
</docblock>
</method>
<method name="jobStatus" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the status of a background job">Object oriented style (method):</description>
<return type="array"/>
</docblock>
<parameter name="job_handle" optional="false" byreference="false" type="string"/>
</method>
<method name="ping" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Send data to all job servers to see if they echo it back"/>
<return type="bool"/>
</docblock>
<parameter name="workload" optional="false" byreference="false" type="string"/>
</method>
<method name="removeOptions" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Remove client options"/>
<return type="bool"/>
</docblock>
<parameter name="options" optional="false" byreference="false" type="int"/>
</method>
<method name="returnCode" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the last Gearman return code"/>
<return type="int"/>
</docblock>
</method>
<method name="runTasks" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Run a list of tasks in parallel"/>
<return type="bool"/>
</docblock>
</method>
<method name="setClientCallback" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Callback function when there is a data packet for a task (deprecated)">Sets the callback function for accepting data packets for a task. The callback function should take a single argument, a GearmanTask object.</description>
<return type="void"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
</method>
<method name="setCompleteCallback" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set a function to be called on task completion">Use to set a function to be called when a GearmanTask is completed, or when GearmanJob::sendComplete is invoked by a worker (whichever happens first).</description>
<return type="bool"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
</method>
<method name="setContext" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set application context"/>
<return type="bool"/>
</docblock>
<parameter name="context" optional="false" byreference="false" type="string"/>
</method>
<method name="setCreatedCallback" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set a callback for when a task is queued"/>
<return type="bool"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="string"/>
</method>
<method name="setData" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set application data (deprecated)">Sets some arbitrary application data that can later be retrieved by GearmanClient::data.</description>
<return type="bool"/>
</docblock>
<parameter name="data" optional="false" byreference="false" type="string"/>
</method>
<method name="setDataCallback" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Callback function when there is a data packet for a task"/>
<return type="bool"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
</method>
<method name="setExceptionCallback" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set a callback for worker exceptions"/>
<return type="bool"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
</method>
<method name="setFailCallback" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set callback for job failure"/>
<return type="bool"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
</method>
<method name="setOptions" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set client options"/>
<return type="bool"/>
</docblock>
<parameter name="options" optional="false" byreference="false" type="int"/>
</method>
<method name="setStatusCallback" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set a callback for collecting task status"/>
<return type="bool"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
</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="setWarningCallback" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set a callback for worker warnings"/>
<return type="bool"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
</method>
<method name="setWorkloadCallback" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set a callback for accepting incremental data updates"/>
<return type="bool"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
</method>
<method name="timeout" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get current socket I/O activity timeout value"/>
<return type="int"/>
</docblock>
</method>
</class>
|
