File: ZMQSocket.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 (112 lines) | stat: -rw-r--r-- 5,026 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="ZMQSocket" namespace="" name="ZMQSocket">
  <method name="bind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Bind the socket"/>
      <return type="ZMQSocket"/>
    </docblock>
    <parameter name="dsn" optional="false" byreference="false" type="string"/>
    <parameter name="force" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="connect" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Connect the socket"/>
      <return type="ZMQSocket"/>
    </docblock>
    <parameter name="dsn" optional="false" byreference="false" type="string"/>
    <parameter name="force" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <constructor name="__construct" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Construct a new ZMQSocket"/>
      <return type="void"/>
    </docblock>
    <parameter name="context" optional="false" byreference="false" type="object" class="ZMQContext"/>
    <parameter name="type" optional="false" byreference="false" type="int"/>
    <parameter name="persistent_id" optional="true" byreference="false" type="string"/>
    <parameter name="on_new_socket" optional="true" byreference="false" type="object" class="callback"/>
  </constructor>
  <method name="disconnect" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Disconnect a socket"/>
      <return type="ZMQSocket"/>
    </docblock>
    <parameter name="dsn" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getEndpoints" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get list of endpoints"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getPersistentId" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the persistent id"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getSocketType" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the socket type"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getSockOpt" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get socket option"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="key" optional="false" byreference="false" type="string"/>
  </method>
  <method name="isPersistent" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Whether the socket is persistent"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="recv" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Receives a message"/>
      <return type="string"/>
    </docblock>
    <parameter name="mode" optional="true" byreference="false" type="int"/>
  </method>
  <method name="recvMulti" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Receives a multipart message"/>
      <return type="array"/>
    </docblock>
    <parameter name="mode" optional="true" byreference="false" type="int"/>
  </method>
  <method name="send" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sends a message"/>
      <return type="ZMQSocket"/>
    </docblock>
    <parameter name="message" optional="false" byreference="false" type="string"/>
    <parameter name="mode" optional="true" byreference="false" type="int"/>
  </method>
  <method name="send" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sends a message"/>
      <return type="ZMQSocket"/>
    </docblock>
    <parameter name="message" optional="false" byreference="false" type="object" class="array"/>
    <parameter name="mode" optional="true" byreference="false" type="int"/>
  </method>
  <method name="setSockOpt" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set a socket option"/>
      <return type="ZMQSocket"/>
    </docblock>
    <parameter name="key" optional="false" byreference="false" type="int"/>
    <parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="unbind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Unbind the socket"/>
      <return type="ZMQSocket"/>
    </docblock>
    <parameter name="dsn" optional="false" byreference="false" type="string"/>
  </method>
</class>