File: GearmanTask.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 (108 lines) | stat: -rw-r--r-- 4,633 bytes parent folder | download | duplicates (3)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="GearmanTask" namespace="" name="GearmanTask">
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Create a GearmanTask instance"/>
      <return type="void"/>
    </docblock>
  </constructor>
  <method name="create" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Create a task (deprecated)">Returns a new GearmanTask object.</description>
      <return type="GearmanTask"/>
    </docblock>
  </method>
  <method name="data" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get data returned for a task"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="dataSize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the size of returned data"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="function" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get associated function name (deprecated)">Returns the name of the function this task is associated with, i.e., the function the Gearman worker calls.</description>
      <return type="string"/>
    </docblock>
  </method>
  <method name="functionName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get associated function name"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="isKnown" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine if task is known"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isRunning" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Test whether the task is currently running"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="jobHandle" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the job handle"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="recvData" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Read work or result data into a buffer for a task"/>
      <return type="array"/>
    </docblock>
    <parameter name="data_len" optional="false" byreference="false" type="int"/>
  </method>
  <method name="returnCode" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the last return code"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="sendData" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Send data for a task (deprecated)"/>
      <return type="int"/>
    </docblock>
    <parameter name="data" optional="false" byreference="false" type="string"/>
  </method>
  <method name="sendWorkload" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Send data for a task"/>
      <return type="int"/>
    </docblock>
    <parameter name="data" optional="false" byreference="false" type="string"/>
  </method>
  <method name="taskDenominator" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get completion percentage denominator"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="taskNumerator" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get completion percentage numerator"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="unique" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the unique identifier for a task"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="uuid" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the unique identifier for a task (deprecated)">Returns the unique identifier for this task. This is assigned by the GearmanClient, as opposed to the job handle which is set by the Gearman job server.</description>
      <return type="string"/>
    </docblock>
  </method>
</class>