File: pht_AtomicInteger.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (48 lines) | stat: -rw-r--r-- 2,163 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="pht\AtomicInteger" namespace="pht" name="AtomicInteger">
  <implements name="pht\Threaded" full="pht\Threaded"/>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="AtomicInteger creation"/>
      <return type="AtomicInteger"/>
    </docblock>
    <parameter name="value" optional="true" byreference="false" type="int"/>
  </constructor>
  <method name="dec" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Decrements the atomic integer's value by one"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="get" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the atomic integer's value"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="inc" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Increments the atomic integer's value by one"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="lock" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Acquires the atomic integer's mutex lock">This method will acquire the mutex lock associated with the atomic integer. The mutex lock only needs to be acquired when needing to group together multiple operations.</description>
      <return type="void"/>
    </docblock>
  </method>
  <method name="set" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the atomic integer's value"/>
      <return type="void"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="int"/>
  </method>
  <method name="unlock" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Releases the atomic integer's mutex lock"/>
      <return type="void"/>
    </docblock>
  </method>
</class>