File: Worker.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,142 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="Worker" namespace="" name="Worker">
  <implements name="Traversable" full="Traversable"/>
  <method name="collect" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Collect references to completed tasks"/>
      <return type="int"/>
    </docblock>
    <parameter name="collector" optional="true" byreference="false" type="object" class="Callable"/>
  </method>
  <method name="getStacked" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the remaining stack size"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="isShutdown" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="State Detection"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isWorking" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="State Detection"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="shutdown" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Shutdown the worker"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="stack" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Stacking work"/>
      <return type="int"/>
    </docblock>
    <parameter name="work" optional="false" byreference="false" type="object" class="Threaded"/>
  </method>
  <method name="unstack" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Unstacking work"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="detach" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getCreatorId" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getCurrentThread" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="Thread"/>
    </docblock>
  </method>
  <method name="getCurrentThreadId" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getThreadId" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="globally" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="isJoined" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isStarted" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="join" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="kill" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="start" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
    <parameter name="options" optional="true" byreference="false" type="int"/>
  </method>
</class>