File: MongoDB_Driver_ReadPreference.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 (72 lines) | stat: -rw-r--r-- 2,654 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
 
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="MongoDB\Driver\ReadPreference" namespace="MongoDB\Driver" name="ReadPreference">
  <implements name="MongoDB\BSON\Serializable" full="MongoDB\BSON\Serializable"/>
  <constant name="RP_PRIMARY" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="RP_PRIMARY_PREFERRED" value="5">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="RP_SECONDARY" value="2">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="RP_SECONDARY_PREFERRED" value="6">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="RP_NEAREST" value="10">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="NO_MAX_STALENESS" value="-1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="SMALLEST_MAX_STALENESS_SECONDS" value="90">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <method name="bsonSerialize" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns an object for BSON serialization"/>
      <return type="object"/>
    </docblock>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Create a new ReadPreference"/>
      <return type="void"/>
    </docblock>
    <parameter name="mode" optional="false" byreference="false" type="object" class="string|integer"/>
    <parameter name="tagSets" optional="true" byreference="false" type="object" class="array"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </constructor>
  <method name="getMaxStalenessSeconds" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the ReadPreference's &quot;maxStalenessSeconds&quot; option"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getMode" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the ReadPreference's &quot;mode&quot; option"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getTagSets" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns the ReadPreference's &quot;tagSets&quot; option"/>
      <return type="array"/>
    </docblock>
  </method>
</class>