File: Swoole_Connection_Iterator.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 (69 lines) | stat: -rw-r--r-- 2,875 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Swoole\Connection\Iterator" namespace="Swoole\Connection" name="Iterator">
  <implements name="Iterator" full="Iterator"/>
  <method name="count" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Count connections."/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="current" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return current connection entry."/>
      <return type="Connection"/>
    </docblock>
  </method>
  <method name="key" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return key of the current connection."/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="next" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Move to the next connection."/>
      <return type="Connection"/>
    </docblock>
  </method>
  <method name="offsetExists" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check if offet exists."/>
      <return type="boolean"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="int"/>
  </method>
  <method name="offsetGet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Offset to retrieve."/>
      <return type="Connection"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="string"/>
  </method>
  <method name="offsetSet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Assign a Connection to the specified offset."/>
      <return type="void"/>
    </docblock>
    <parameter name="offset" optional="false" byreference="false" type="int"/>
    <parameter name="connection" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="offsetUnset" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Unset an offset."/>
      <return type="void"/>
    </docblock>
    <parameter name="offset" optional="false" byreference="false" type="int"/>
  </method>
  <method name="rewind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Rewinds iterator"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="valid" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check if current position is valid."/>
      <return type="boolean"/>
    </docblock>
  </method>
</class>