/
server.xml
239 lines (212 loc) · 8.96 KB
/
server.xml
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.mongodb-driver-server" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The MongoDB\Driver\Server class</title>
<titleabbrev>MongoDB\Driver\Server</titleabbrev>
<partintro>
<!-- {{{ MongoDB\Driver\Server intro -->
<section xml:id="mongodb-driver-server.intro">
&reftitle.intro;
<para>
</para>
</section>
<!-- }}} -->
<section xml:id="mongodb-driver-server.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>MongoDB\Driver\Server</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<modifier>final</modifier>
<ooclass>
<classname>MongoDB\Driver\Server</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="mongodb-driver-server.constants.type-unknown">MongoDB\Driver\Server::TYPE_UNKNOWN</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="mongodb-driver-server.constants.type-standalone">MongoDB\Driver\Server::TYPE_STANDALONE</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="mongodb-driver-server.constants.type-mongos">MongoDB\Driver\Server::TYPE_MONGOS</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="mongodb-driver-server.constants.type-possible-primary">MongoDB\Driver\Server::TYPE_POSSIBLE_PRIMARY</varname>
<initializer>3</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="mongodb-driver-server.constants.type-rs-primary">MongoDB\Driver\Server::TYPE_RS_PRIMARY</varname>
<initializer>4</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="mongodb-driver-server.constants.type-rs-secondary">MongoDB\Driver\Server::TYPE_RS_SECONDARY</varname>
<initializer>5</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="mongodb-driver-server.constants.type-rs-arbiter">MongoDB\Driver\Server::TYPE_RS_ARBITER</varname>
<initializer>6</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="mongodb-driver-server.constants.type-rs-other">MongoDB\Driver\Server::TYPE_RS_OTHER</varname>
<initializer>7</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="mongodb-driver-server.constants.type-rs-ghost">MongoDB\Driver\Server::TYPE_RS_GHOST</varname>
<initializer>8</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="mongodb-driver-server.constants.type-load-balancer">MongoDB\Driver\Server::TYPE_LOAD_BALANCER</varname>
<initializer>9</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongodb-driver-server')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ MongoDB\Driver\Server constants -->
<section xml:id="mongodb-driver-server.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="mongodb-driver-server.constants.type-unknown">
<term><constant>MongoDB\Driver\Server::TYPE_UNKNOWN</constant></term>
<listitem>
<para>Unknown server type, returned by <methodname>MongoDB\Driver\Server::getType</methodname>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-server.constants.type-standalone">
<term><constant>MongoDB\Driver\Server::TYPE_STANDALONE</constant></term>
<listitem>
<para>Standalone server type, returned by <methodname>MongoDB\Driver\Server::getType</methodname>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-server.constants.type-mongos">
<term><constant>MongoDB\Driver\Server::TYPE_MONGOS</constant></term>
<listitem>
<para>Mongos server type, returned by <methodname>MongoDB\Driver\Server::getType</methodname>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-server.constants.type-possible-primary">
<term><constant>MongoDB\Driver\Server::TYPE_POSSIBLE_PRIMARY</constant></term>
<listitem>
<para>Replica set possible primary server type, returned by <methodname>MongoDB\Driver\Server::getType</methodname>.</para>
<para>A server may be identified as a possible primary if it has not yet been checked but another memory of the replica set thinks it is the primary.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-server.constants.type-rs-primary">
<term><constant>MongoDB\Driver\Server::TYPE_RS_PRIMARY</constant></term>
<listitem>
<para>Replica set primary server type, returned by <methodname>MongoDB\Driver\Server::getType</methodname>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-server.constants.type-rs-secondary">
<term><constant>MongoDB\Driver\Server::TYPE_RS_SECONDARY</constant></term>
<listitem>
<para>Replica set secondary server type, returned by <methodname>MongoDB\Driver\Server::getType</methodname>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-server.constants.type-rs-arbiter">
<term><constant>MongoDB\Driver\Server::TYPE_RS_ARBITER</constant></term>
<listitem>
<para>Replica set arbiter server type, returned by <methodname>MongoDB\Driver\Server::getType</methodname>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-server.constants.type-rs-other">
<term><constant>MongoDB\Driver\Server::TYPE_RS_OTHER</constant></term>
<listitem>
<para>Replica set other server type, returned by <methodname>MongoDB\Driver\Server::getType</methodname>.</para>
<para>Such servers may be hidden, starting up, or recovering. They cannot be queried, but their hosts lists are useful for discovering the current replica set configuration.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-server.constants.type-rs-ghost">
<term><constant>MongoDB\Driver\Server::TYPE_RS_GHOST</constant></term>
<listitem>
<para>Replica set ghost server type, returned by <methodname>MongoDB\Driver\Server::getType</methodname>.</para>
<para>Servers may be identified as such in at least three situations: briefly during server startup; in an uninitialized replica set; or when the server is shunned (i.e. removed from the replica set config). They cannot be queried, nor can their host list be used to discover the current replica set configuration; however, the client may monitor this server in hope that it transitions to a more useful state.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-server.constants.type-load-balancer">
<term><constant>MongoDB\Driver\Server::TYPE_LOAD_BALANCER</constant></term>
<listitem>
<para>Load balancer server type, returned by <methodname>MongoDB\Driver\Server::getType</methodname>.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<section role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 1.11.0</entry>
<entry>
<para>
Added the
<constant>MongoDB\Driver\Server::TYPE_LOAD_BALANCER</constant>
constant.
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section>
</partintro>
&reference.mongodb.mongodb.driver.entities.server;
</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->