Memcache::setServerParams
(PECL memcache >= 2.1.0)
Memcache::setServerParams — Changes server parameters and status at runtime
Description
$host
[, int $port
= 11211
[, int $timeout
[, int $retry_interval
= FALSE
[, bool $status
[, callable $failure_callback
]]]]] ) : boolMemcache::setServerParams() changes server parameters at runtime. You can also use the memcache_set_server_params() 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.
-
timeout
-
Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can lose all the advantages of caching if your connection is too slow.
-
retry_interval
-
Controls how often a failed server will be retried, the default value is 15 seconds. Setting this parameter to -1 disables automatic retry. Neither this nor the
persistent
parameter has any effect when the extension is loaded dynamically via dl(). -
status
-
Controls if the server should be flagged as online. Setting this parameter to
FALSE
andretry_interval
to -1 allows a failed server to be kept in the pool so as not to affect the key distribution algorithm. Requests for this server will then failover or fail immediately depending on thememcache.allow_failover
setting. Default toTRUE
, meaning the server should be considered online. -
failure_callback
-
Allows the user to specify a callback function to run upon encountering an error. The callback is run before failover is attempted. The function takes two parameters, the hostname and port of the failed server.
Examples
Example #1 Memcache::setServerParams() example
<?php
function _callback_memcache_failure($host, $port) {
print "memcache '$host:$port' failed";
}
/* OO API */
$memcache = new Memcache;
// Add the server in offline mode
$memcache->addServer('memcache_host', 11211, false, 1, 1, -1, false);
// Bring the server back online
$memcache->setServerParams('memcache_host', 11211, 1, 15, true, '_callback_memcache_failure');
/* procedural API */
$memcache_obj = memcache_connect('memcache_host', 11211);
memcache_set_server_params($memcache_obj, 'memcache_host', 11211, 1, 15, true, '_callback_memcache_failure');
?>
See Also
- Memcache::addServer() - Add a memcached server to connection pool
- Memcache::getServerStatus() - Returns server status
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-memcache.setserverparams.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.