Memcache::getServerStatus

(PECL memcache >= 2.1.0)

Memcache::getServerStatus — Returns server status

Description

int Memcache::getServerStatus ( string $host [, int $port = 11211 ] )

Memcache::getServerStatus() returns a the servers online/offline status. You can also use memcache_get_server_status() function.

Note:
This function has been added to Memcache version 2.1.0.

Parameters

host: Point to the host where memcached is listening for connections.
port: Point to the port where memcached is listening for connections.

Return Values

Returns a the servers status. 0 if server is failed, non-zero otherwise

Examples

Example #1 Memcache::getServerStatus() example


<?php

/* OO API */
$memcache = new Memcache;
$memcache->addServer('memcache_host', 11211);
echo $memcache->getServerStatus('memcache_host', 11211);

/* procedural API */
$memcache = memcache_connect('memcache_host', 11211);
echo memcache_get_server_status($memcache, 'memcache_host', 11211);

?>

User Contributed Notes

tom at all dash community dot de

4 years ago


Note: the result of the function is cached. The cached is not automatically refreshed.

Call MemCache::getExtendedStats() to force a cache-update.

geoffrey dot hoffman at gmail dot com

5 years ago


Beware... this method does not actually attempt to connect to the server and port you specify! It is not a health check to tell whether memcached is actually running or not!

It merely returns the server status from the pool, which defaults to TRUE when using addServer( ) with only required arguments. 

Try it - stop your memcached and run the sample code above - it will output 1.