File: Pool.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 (77 lines) | stat: -rw-r--r-- 3,186 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Pool" namespace="" name="Pool">
  <member name="size" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="maximum number of Workers this Pool can use"/>
    </docblock>
  </member>
  <member name="class" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="the class of the Worker"/>
    </docblock>
  </member>
  <member name="workers" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="references to Workers"/>
    </docblock>
  </member>
  <member name="ctor" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="the arguments for constructor of new Workers"/>
    </docblock>
  </member>
  <member name="last" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="offset in workers of the last Worker used"/>
    </docblock>
  </member>
  <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>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Creates a new Pool of Workers"/>
      <return type="Pool"/>
    </docblock>
    <parameter name="size" optional="false" byreference="false" type="int"/>
    <parameter name="class" optional="true" byreference="false" type="string"/>
    <parameter name="ctor" optional="true" byreference="false" type="object" class="array"/>
  </constructor>
  <method name="resize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Resize the Pool"/>
      <return type="void"/>
    </docblock>
    <parameter name="size" optional="false" byreference="false" type="int"/>
  </method>
  <method name="shutdown" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Shutdown all workers"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="submit" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Submits an object for execution"/>
      <return type="int"/>
    </docblock>
    <parameter name="task" optional="false" byreference="false" type="object" class="Threaded"/>
  </method>
  <method name="submitTo" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Submits a task to a specific worker for execution"/>
      <return type="int"/>
    </docblock>
    <parameter name="worker" optional="false" byreference="false" type="int"/>
    <parameter name="task" optional="false" byreference="false" type="object" class="Threaded"/>
  </method>
</class>