File: MongoDB_Driver_Server.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 (174 lines) | stat: -rw-r--r-- 7,802 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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="MongoDB\Driver\Server" namespace="MongoDB\Driver" name="Server">
  <constant name="TYPE_UNKNOWN" value="0">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_STANDALONE" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_MONGOS" value="2">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_POSSIBLE_PRIMARY" value="3">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_RS_PRIMARY" value="4">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_RS_SECONDARY" value="5">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_RS_ARBITER" value="6">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_RS_OTHER" value="7">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_RS_GHOST" value="8">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constructor name="__construct" abstract="false" static="false" final="true">
    <docblock>
      <description compact="Create a new Server (not used)"/>
      <return type="void"/>
    </docblock>
  </constructor>
  <method name="executeBulkWrite" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Execute one or more write operations on this server">Executes one or more write operations on this server.</description>
      <return type="MongoDB\Driver\WriteResult"/>
    </docblock>
    <parameter name="namespace" optional="false" byreference="false" type="string"/>
    <parameter name="bulk" optional="false" byreference="false" type="object" class="MongoDB\Driver\BulkWrite"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="executeCommand" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Execute a database command on this server">Executes the command on this server.</description>
      <return type="MongoDB\Driver\Cursor"/>
    </docblock>
    <parameter name="db" optional="false" byreference="false" type="string"/>
    <parameter name="command" optional="false" byreference="false" type="object" class="MongoDB\Driver\Command"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="executeQuery" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Execute a database query on this server"/>
      <return type="MongoDB\Driver\Cursor"/>
    </docblock>
    <parameter name="namespace" optional="false" byreference="false" type="string"/>
    <parameter name="query" optional="false" byreference="false" type="object" class="MongoDB\Driver\Query"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="executeReadCommand" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Execute a database command that reads on this server">Executes the command on this server.</description>
      <return type="MongoDB\Driver\Cursor"/>
    </docblock>
    <parameter name="db" optional="false" byreference="false" type="string"/>
    <parameter name="command" optional="false" byreference="false" type="object" class="MongoDB\Driver\Command"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="executeReadWriteCommand" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Execute a database command that reads and writes on this server">Executes the command on this server.</description>
      <return type="MongoDB\Driver\Cursor"/>
    </docblock>
    <parameter name="db" optional="false" byreference="false" type="string"/>
    <parameter name="command" optional="false" byreference="false" type="object" class="MongoDB\Driver\Command"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="executeWriteCommand" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Execute a database command that writes on this server">Executes the command on this server.</description>
      <return type="MongoDB\Driver\Cursor"/>
    </docblock>
    <parameter name="db" optional="false" byreference="false" type="string"/>
    <parameter name="command" optional="false" byreference="false" type="object" class="MongoDB\Driver\Command"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="getHost" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the hostname of this server"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getInfo" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns an array of information about this server"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getLatency" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the latency of this server"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getPort" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the port on which this server is listening"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getTags" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns an array of tags describing this server in a replica set"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getType" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns an integer denoting the type of this server"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="isArbiter" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Checks if this server is an arbiter member of a replica set"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isHidden" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Checks if this server is a hidden member of a replica set"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isPassive" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Checks if this server is a passive member of a replica set"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isPrimary" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Checks if this server is a primary member of a replica set"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isSecondary" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Checks if this server is a secondary member of a replica set"/>
      <return type="bool"/>
    </docblock>
  </method>
</class>