<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.mongodb-driver-manager.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'mongodb-driver-manager.selectserver.php',
    1 => 'MongoDB\\Driver\\Manager::selectServer',
    2 => 'Select a server matching a read preference',
  ),
  'up' => 
  array (
    0 => 'class.mongodb-driver-manager.php',
    1 => 'MongoDB\\Driver\\Manager',
  ),
  'prev' => 
  array (
    0 => 'mongodb-driver-manager.removesubscriber.php',
    1 => 'MongoDB\\Driver\\Manager::removeSubscriber',
  ),
  'next' => 
  array (
    0 => 'mongodb-driver-manager.startsession.php',
    1 => 'MongoDB\\Driver\\Manager::startSession',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/mongodb/mongodb/driver/manager/selectserver.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="mongodb-driver-manager.selectserver" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">MongoDB\Driver\Manager::selectServer</h1>
  <p class="verinfo">(mongodb &gt;=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\Manager::selectServer</span> &mdash; <span class="dc-title">Select a server matching a read preference</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mongodb-driver-manager.selectserver-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><strong>MongoDB\Driver\Manager::selectServer</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="class.mongodb-driver-readpreference.php" class="type MongoDB\Driver\ReadPreference">MongoDB\Driver\ReadPreference</a></span></span> <code class="parameter">$readPreference</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="class.mongodb-driver-server.php" class="type MongoDB\Driver\Server">MongoDB\Driver\Server</a></span></div>

  <p class="para rdfs-comment">
   Selects a <span class="classname"><a href="class.mongodb-driver-server.php" class="classname">MongoDB\Driver\Server</a></span> matching
   <code class="parameter">readPreference</code>. If
   <code class="parameter">readPreference</code> is <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> or omitted, the primary
   server will be selected by default. This may be used to preselect a server in
   order to perform version checking before executing an operation.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    Unlike <span class="function"><a href="mongodb-driver-manager.getservers.php" class="function">MongoDB\Driver\Manager::getServers()</a></span>, this method
    will initialize database connections and perform server discovery if
    necessary. See the
    <a href="https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.md#single-threaded-server-selection" class="link external">&raquo;&nbsp;Server Selection Specification</a>
    for additional information.
   </span>
  </p></blockquote>
 </div>


 <div class="refsect1 parameters" id="refsect1-mongodb-driver-manager.selectserver-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">readPreference</code> (<span class="classname"><a href="class.mongodb-driver-readpreference.php" class="classname">MongoDB\Driver\ReadPreference</a></span>)</dt>
    <dd>
     <p class="para">
      The read preference to use for selecting a server. If <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> or omitted,
      the primary server will be selected by default.
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-mongodb-driver-manager.selectserver-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns a <span class="classname"><a href="class.mongodb-driver-server.php" class="classname">MongoDB\Driver\Server</a></span> matching the read
   preference.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-mongodb-driver-manager.selectserver-errors">
  <h3 class="title">Errors/Exceptions</h3>
  <ul class="simplelist">
   <li>Throws <span class="classname"><a href="class.mongodb-driver-exception-invalidargumentexception.php" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a></span> on argument parsing errors.</li><li>Throws <span class="classname"><a href="class.mongodb-driver-exception-connectionexception.php" class="classname">MongoDB\Driver\Exception\ConnectionException</a></span> if connection to the server fails (for reasons other than authentication).</li><li>Throws <span class="classname"><a href="class.mongodb-driver-exception-authenticationexception.php" class="classname">MongoDB\Driver\Exception\AuthenticationException</a></span> if authentication is needed and fails.</li>
   <li>Throws <span class="classname"><a href="class.mongodb-driver-exception-runtimeexception.php" class="classname">MongoDB\Driver\Exception\RuntimeException</a></span> if a server matching the read preference could not be found.</li>
  </ul>
 </div>


 <div class="refsect1 changelog" id="refsect1-mongodb-driver-manager.selectserver-changelog">
  <h3 class="title">Changelog</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Version</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>PECL mongodb 1.11.0</td>
       <td>
        The <code class="parameter">readPreference</code> is now optional. If <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> or
        omitted, the primary server will be selected by default.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-mongodb-driver-manager.selectserver-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="classname"><a href="class.mongodb-driver-server.php" class="classname">MongoDB\Driver\Server</a></span></li>
   <li><span class="function"><a href="mongodb-driver-manager.getservers.php" class="function" rel="rdfs-seeAlso">MongoDB\Driver\Manager::getServers()</a> - Return the servers to which this manager is connected</span></li>
   <li><a href="https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.md" class="link external">&raquo;&nbsp;Server Selection Specification</a></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>