<!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 server status</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcache.getextendedstats.html">Memcache::getExtendedStats</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcache.getstats.html">Memcache::getStats</a></div>
<div class="up"><a href="class.memcache.html">Memcache</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="memcache.getserverstatus" class="refentry">
<div class="refnamediv">
<h1 class="refname">Memcache::getServerStatus</h1>
<p class="verinfo">(PECL memcache >= 2.1.0)</p><p class="refpurpose"><span class="refname">Memcache::getServerStatus</span> — <span class="dc-title">Returns server status</span></p>
</div>
<div class="refsect1 description" id="refsect1-memcache.getserverstatus-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>Memcache::getServerStatus</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code><span class="initializer"> = 11211</span></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>Memcache::getServerStatus()</strong></span> returns a the servers
online/offline status. You can also use <span class="function"><strong>memcache_get_server_status()</strong></span>
function.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function has been added to Memcache version 2.1.0.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-memcache.getserverstatus-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">host</code></em></span>
<dd>
<p class="para">
Point to the host where memcached is listening for connections.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">port</code></em></span>
<dd>
<p class="para">
Point to the port where memcached is listening for connections.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-memcache.getserverstatus-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a the servers status. 0 if server is failed, non-zero otherwise
</p>
</div>
<div class="refsect1 examples" id="refsect1-memcache.getserverstatus-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4417">
<p><strong>Example #1 <span class="function"><strong>Memcache::getServerStatus()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/* OO API */<br /></span><span style="color: #0000BB">$memcache </span><span style="color: #007700">= new </span><span style="color: #0000BB">Memcache</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$memcache</span><span style="color: #007700">-></span><span style="color: #0000BB">addServer</span><span style="color: #007700">(</span><span style="color: #DD0000">'memcache_host'</span><span style="color: #007700">, </span><span style="color: #0000BB">11211</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$memcache</span><span style="color: #007700">-></span><span style="color: #0000BB">getServerStatus</span><span style="color: #007700">(</span><span style="color: #DD0000">'memcache_host'</span><span style="color: #007700">, </span><span style="color: #0000BB">11211</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* procedural API */<br /></span><span style="color: #0000BB">$memcache </span><span style="color: #007700">= </span><span style="color: #0000BB">memcache_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'memcache_host'</span><span style="color: #007700">, </span><span style="color: #0000BB">11211</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">memcache_get_server_status</span><span style="color: #007700">(</span><span style="color: #0000BB">$memcache</span><span style="color: #007700">, </span><span style="color: #DD0000">'memcache_host'</span><span style="color: #007700">, </span><span style="color: #0000BB">11211</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-memcache.getserverstatus-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="memcache.addserver.html" class="function" rel="rdfs-seeAlso">Memcache::addServer()</a> - Add a memcached server to connection pool</span></li>
<li class="member"> <span class="function"><a href="memcache.setserverparams.html" class="function" rel="rdfs-seeAlso">Memcache::setServerParams()</a> - Changes server parameters and status at runtime</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcache.getextendedstats.html">Memcache::getExtendedStats</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcache.getstats.html">Memcache::getStats</a></div>
<div class="up"><a href="class.memcache.html">Memcache</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
