<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Returns the latency of this server</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-server.getinfo.html">MongoDB\Driver\Server::getInfo</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-server.getport.html">MongoDB\Driver\Server::getPort</a></div> <div class="up"><a href="class.mongodb-driver-server.html">MongoDB\Driver\Server</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mongodb-driver-server.getlatency" class="refentry"> <div class="refnamediv"> <h1 class="refname">MongoDB\Driver\Server::getLatency</h1> <p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\Server::getLatency</span> — <span class="dc-title">Returns the latency of this server</span></p> </div> <div class="refsect1 description" id="refsect1-mongodb-driver-server.getlatency-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><strong>MongoDB\Driver\Server::getLatency</strong></span> ( <span class="methodparam">void</span> )</div> <p class="para rdfs-comment"> Returns the latency of this server (i.e. the client's measured <a href="https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst#round-trip-time" class="link external">» round trip time</a> of an <em>ismaster</em> command). </p> </div> <div class="refsect1 parameters" id="refsect1-mongodb-driver-server.getlatency-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-mongodb-driver-server.getlatency-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the latency of this server. </p> </div> <div class="refsect1 errors" id="refsect1-mongodb-driver-server.getlatency-errors"> <h3 class="title">Errors/Exceptions</h3> <ul class="simplelist"> <li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> on argument parsing errors.</li> </ul> </div> <div class="refsect1 examples" id="refsect1-mongodb-driver-server.getlatency-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-1732"> <p><strong>Example #1 <span class="function"><strong>MongoDB\Driver\Server::getLatency()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br />$manager </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">Manager</span><span style="color: #007700">(</span><span style="color: #DD0000">"mongodb://localhost:27017/"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$rp </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">ReadPreference</span><span style="color: #007700">(</span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">ReadPreference</span><span style="color: #007700">::</span><span style="color: #0000BB">RP_PRIMARY</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$server </span><span style="color: #007700">= </span><span style="color: #0000BB">$manager</span><span style="color: #007700">-></span><span style="color: #0000BB">selectServer</span><span style="color: #007700">(</span><span style="color: #0000BB">$rp</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">getLatency</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> int(592) </pre></div> </div> </div> </div> <div class="refsect1 seealso" id="refsect1-mongodb-driver-server.getlatency-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member"><span class="function"><a href="mongodb-driver-server.getinfo.html" class="function" rel="rdfs-seeAlso">MongoDB\Driver\Server::getInfo()</a> - Returns an array of information about this server</span></li> <li class="member"><a href="https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst" class="link external">» Server Discovery and Monitoring Specification</a></li> </ul> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-server.getinfo.html">MongoDB\Driver\Server::getInfo</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-server.getport.html">MongoDB\Driver\Server::getPort</a></div> <div class="up"><a href="class.mongodb-driver-server.html">MongoDB\Driver\Server</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>