<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<phpdoc:classref xml:id="class.mongodb-driver-topologydescription" 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\TopologyDescription class</title>
 <titleabbrev>MongoDB\Driver\TopologyDescription</titleabbrev>

 <partintro>

<!-- {{{ MongoDB\Driver\TopologyDescription intro -->
  <section xml:id="mongodb-driver-topologydescription.intro">
   &reftitle.intro;
   <para>
    The <classname>MongoDB\Driver\TopologyDescription</classname> class is a
    value object that represents a topology to which the driver is connected.
    Instances of this class are returned by
    <classname>MongoDB\Driver\Monitoring\TopologyChangedEvent</classname>
    methods.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="mongodb-driver-topologydescription.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>MongoDB\Driver\TopologyDescription</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <modifier>final</modifier>
     <ooclass>
      <classname>MongoDB\Driver\TopologyDescription</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="mongodb-driver-topologydescription.constants.type-unknown">MongoDB\Driver\TopologyDescription::TYPE_UNKNOWN</varname>
     <initializer>"Unknown"</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="mongodb-driver-topologydescription.constants.type-single">MongoDB\Driver\TopologyDescription::TYPE_SINGLE</varname>
     <initializer>"Single"</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="mongodb-driver-topologydescription.constants.type-sharded">MongoDB\Driver\TopologyDescription::TYPE_SHARDED</varname>
     <initializer>"Sharded"</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="mongodb-driver-topologydescription.constants.type-replica-set-no-primary">MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_NO_PRIMARY</varname>
     <initializer>"ReplicaSetNoPrimary"</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="mongodb-driver-topologydescription.constants.type-replica-set-with-primary">MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_WITH_PRIMARY</varname>
     <initializer>"ReplicaSetWithPrimary"</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="mongodb-driver-topologydescription.constants.type-load-balanced">MongoDB\Driver\TopologyDescription::TYPE_LOAD_BALANCED</varname>
     <initializer>"LoadBalanced"</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongodb-driver-topologydescription')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
   </classsynopsis>
<!-- }}} -->

  </section>

<!-- {{{ MongoDB\Driver\TopologyDescription constants -->
  <section xml:id="mongodb-driver-topologydescription.constants">
   &reftitle.constants;
   <variablelist>

    <varlistentry xml:id="mongodb-driver-topologydescription.constants.type-unknown">
     <term><constant>MongoDB\Driver\TopologyDescription::TYPE_UNKNOWN</constant></term>
     <listitem>
      <para>Unknown topology type, returned by <methodname>MongoDB\Driver\TopologyDescription::getType</methodname>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-driver-topologydescription.constants.type-single">
     <term><constant>MongoDB\Driver\TopologyDescription::TYPE_SINGLE</constant></term>
     <listitem>
      <para>Single server (i.e. direct connection), returned by <methodname>MongoDB\Driver\TopologyDescription::getType</methodname>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-driver-topologydescription.constants.type-sharded">
     <term><constant>MongoDB\Driver\TopologyDescription::TYPE_SHARDED</constant></term>
     <listitem>
      <para>Sharded cluster, returned by <methodname>MongoDB\Driver\TopologyDescription::getType</methodname>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-driver-topologydescription.constants.type-replica-set-no-primary">
     <term><constant>MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_NO_PRIMARY</constant></term>
     <listitem>
      <para>Replica set with no primary server, returned by <methodname>MongoDB\Driver\TopologyDescription::getType</methodname>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-driver-topologydescription.constants.type-replica-set-with-primary">
     <term><constant>MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_WITH_PRIMARY</constant></term>
     <listitem>
      <para>Replica set with a primary server, returned by <methodname>MongoDB\Driver\TopologyDescription::getType</methodname>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-driver-topologydescription.constants.type-load-balanced">
     <term><constant>MongoDB\Driver\TopologyDescription::TYPE_LOAD_BALANCED</constant></term>
     <listitem>
      <para>Load balanced topology, returned by <methodname>MongoDB\Driver\TopologyDescription::getType</methodname>.</para>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
<!-- }}} -->

 </partintro>

 &reference.mongodb.mongodb.driver.entities.topologydescription;

</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
-->
