MemCacheServer.php 1.73 KB
Newer Older
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
Qiang Xue committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
 * @license http://www.yiiframework.com/license/
 */

namespace yii\caching;

/**
 * MemCacheServer represents the configuration data for a single memcache or memcached server.
 *
 * See [PHP manual](http://www.php.net/manual/en/function.Memcache-addServer.php) for detailed explanation
 * of each configuration property.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class MemCacheServer extends \yii\base\Object
{
	/**
	 * @var string memcache server hostname or IP address
	 */
	public $host;
	/**
	 * @var integer memcache server port
	 */
	public $port = 11211;
	/**
	 * @var integer probability of using this server among all servers.
	 */
	public $weight = 1;
	/**
	 * @var boolean whether to use a persistent connection. This is used by memcache only.
	 */
	public $persistent = true;
	/**
38 39 40
	 * @var integer timeout in milliseconds which will be used for connecting to the server.
	 * This is used by memcache only. For old versions of memcache that only support specifying
	 * timeout in seconds this will be rounded up to full seconds.
Qiang Xue committed
41
	 */
42
	public $timeout = 1000;
Qiang Xue committed
43 44 45 46 47 48 49 50
	/**
	 * @var integer how often a failed server will be retried (in seconds). This is used by memcache only.
	 */
	public $retryInterval = 15;
	/**
	 * @var boolean if the server should be flagged as online upon a failure. This is used by memcache only.
	 */
	public $status = true;
51
	/**
52 53
	 * @var \Closure this callback function will run upon encountering an error.
	 * The callback is run before fail over is attempted. The function takes two parameters,
54
	 * the [[host]] and the [[port]] of the failed server.
55
	 * This is used by memcache only.
56
	 */
57
	public $failureCallback;
Zander Baldwin committed
58
}