Memcache功能具体解释

memcache函数全部的方法列表例如以下：

Memcache::add – 加入一个值。假设已经存在，则返回false

Memcache::addServer – 加入一个可供使用的server地址

Memcache::close – 关闭一个Memcache对象

Memcache::connect – 创建一个Memcache对象

memcache_debug – 控制调试功能

Memcache::decrement – 对保存的某个key中的值进行减法操作

Memcache::delete – 删除一个key值

Memcache::flush – 清除全部缓存的数据

Memcache::get – 获取一个key值

Memcache::getExtendedStats – 获取进程池中全部进程的执行系统统计

Memcache::getServerStatus – 获取执行server的參数

Memcache::getStats – 返回server的一些执行统计信息

Memcache::getVersion – 返回执行的Memcache的版本号信息

Memcache::increment – 对保存的某个key中的值进行加法操作

Memcache::pconnect – 创建一个Memcache的持久连接对象

Memcache::replace -对一个已有的key进行覆写操作

Memcache::set – 加入一个值，假设已经存在。则覆写

Memcache::setCompressThreshold – 对大于某一大小的数据进行压缩

Memcache::setServerParams – 在执行时改动server的參数

Memcache::add使用方法

 

bool Memcache::add ( string $key , mixed $var [, int $flag [, int $expire ]] )

 

说明：

假设$key不存在的时候。使用这个函数来存储$var的值。功能同样的函数是memcache_add()。

 

參数：

$key ：将要存储的键值。

$var ：存储的值。字符型和整型会按原值保存。其它类型自己主动序列化以后保存。

$flag：是否用MEMCACHE_COMPRESSED来压缩存储的值，true表示压缩。false表示不压缩。

$expire：存储值的过期时间，假设为0表示不会过期。你能够用unix时间戳或者描写叙述来表示从如今開始的时间，可是你在使用秒数表示的时候，不要超过2592000秒 (表示30天)。

 

返回值：

假设成功则返回 TRUE，失败则返回 FALSE。假设$key值已经存在，则会返回FALSE。 其它情况下Memcache::add()的使用方法类似于Memcache::set()。

样例：

 

复制代码
复制代码
<?

php

$memcache_obj = memcache_connect(”localhost”, 11211);

memcache_add($memcache_obj, ’var_key’, ’test variable’, false, 30);

$memcache_obj->add(’var_key’, ’test variable’, false, 30);

?

>

复制代码
复制代码

 

Memcache::addServer使用方法

 

bool Memcache::addServer ( string $host [, int $port [, bool $persistent [, int $weight [, int$timeout [, int $retry_interval [, bool $status [, callback $failure_callback ]]]]]]] )

 

说明：

加入一个可供使用的服务器地址到连接池中，连接用Memcache::addServer打开，脚本运行完后自己主动关闭，或者能够用Memcache::close()手动关闭。同样函数是memcache_add_server()。

当用这种方法的时候（相对于Memcache::connect()和 Memcache::pconnect()方法），网络连接仅仅有等须要的时候才会建立，因此不会由于添加非常多的server到连接池而添加系统负担。由于非常多server可能没有使用。

故障恢复会发生在这种方法运行的不论什么阶段，仅仅要其它的server是正常的，这些连接请求的失败用户不会注意到。

不论什么一种socket或者memcachedserver级的错误能够触发故障恢复。正常的client错误比方添加一个存在的键值不会引发故障恢复。

 

參数：

$hostserver的地址

$portserver端口

$persistent是否是一个持久连接

$weight这台server在全部server中所占的权重

$timeout连接的持续时间

$retry_interval连接重试的间隔时间，默觉得15,设置为-1表示不进行重试

$status控制server的在线状态

$failure_callback同意设置一个回掉函数来处理错误信息。

 

返回值：

假设成功则返回 TRUE，失败则返回 FALSE。

 

样例：

 

复制代码
复制代码
<?php
 
$memcache = new Memcache;
$memcache->addServer(’memcache_host’, 11211);
$memcache->addServer(’memcache_host2′, 11211);
 
$memcache_obj = memcache_connect(’memcache_host’, 11211);
memcache_add_server($memcache_obj, ’memcache_host2′, 11211);

?

>

复制代码
复制代码

 

Memcache::close使用方法

 

bool Memcache::close ( void )

 

说明：

关闭memcacheserver连接。这个函数不会关闭长连接，长连接仅仅有在webserver关闭或者重新启动的时候才会关闭。

同样的函数memcache_close()

返回值：

假设成功则返回 TRUE，失败则返回 FALSE。

样例：

 

复制代码
复制代码
<?php

$memcache_obj = memcache_connect(’memcache_host’, 11211);

memcache_close($memcache_obj);

$memcache_obj = new Memcache;
$memcache_obj->connect(’memcache_host’, 11211);

$memcache_obj->close();

?>
复制代码
复制代码

 

Memcache::connect使用方法

 

bool Memcache::connect ( string $host [, int $port [, int $timeout ]] )

 

说明：

打开memcachedserver连接。建立一个到memcachedserver的连接，用Memcache::connect打开的连接会在脚本运行完成后自己主动关闭。你也能够用Memcache::close()去关闭连接。

同样的函数是memcache_connect()。

參数：

$host：指向memcached正在收听的链接的主机。这个參数会有还有一种特殊的连接方式unix:///path/to/memcached.sock，即用unix的域名sockets，这样的情况下，port必须设置为0

$port：指向memcached正在收听的链接的port。用unix的域名sockets的情况下，port必须设置为0

$timeout：用于连接守护进程的秒数，当你改变默认的1秒的值的时候，你须要考虑一下，假设你的连接太慢的话，你可能会失去缓存的优势。

 

返回值：

假设成功则返回 TRUE。失败则返回 FALSE。

样例：

 

复制代码
复制代码
<?php

$memcache_obj = memcache_connect(’memcache_host’, 11211);
$memcache = new Memcache;
$memcache->connect(’memcache_host’, 11211);

?>
复制代码
复制代码

 

memcache::debug

 

bool memcache_debug ( bool $on_off )

 

说明：

控制调试功能。前提是php在编译的时候使用了-enable-debug选项，否则这个函数不会有作用。

參数：

$on_off：true表示开启调试，false表示关闭调试

返回值：

假设php在编译的时候使用了-enable-debug选项，返回true，否则返回false

Memcache::decrement使用方法

 

int Memcache::decrement ( string $key [, int $value ] )

 

说明：

Memcache::decremen方法的作用是对保存的某个key中的值进行减法操作，使用方法跟Memcache::increment类似。

你也能够用memcache_decrement()函数。

參数：

Key:想要降低的键的名字

Value:想要降低的值。

 

返回值：

假设成功，返回被降低后的值，假设失败返回false。

样例：

 

复制代码
复制代码
<?

php

$memcache = new Memcache;

$memcache->connect(’localhost’, 11211);

$memcache->set(’test_item’, 8);

$memcache->increment(’test_item’, 4);

echo $memcache->decrement(’test_item’, 7);

// 显示 5

?>

复制代码
复制代码

 

这个样例连Memcache::increment函数都一块演示了。

Memcache::delete使用方法

 

bool Memcache::delete ( string $key [, int $timeout ] )

 

说明：

删除一个key值，假设參数$timeout被设置，那么存储的值会在设置的秒数以后过期，你也能够用函数memcache_delete()

 

返回值：

假设成功则返回 TRUE，失败则返回 FALSE。

 

样例：

 

复制代码
复制代码
<?php

$memcache_obj = memcache_connect(’memcache_host’, 11211);

memcache_delete($memcache_obj, ’key_to_delete’, 10);

$memcache_obj = new Memcache;
$memcache_obj->connect(’memcache_host’, 11211);
$memcache_obj->delete(’key_to_delete’, 10);

?

>

复制代码
复制代码

 

Memcache::flush

 

bool Memcache::flush ( void )

 

说明：

清除全部缓存的数据。Memcache::flush实际上没有释放资源。它只将全部的缓存标记为过期。这样能够使新的缓存来覆盖被占的内存空间。一样的函数是memcache_flush()

 

返回值：

假设成功则返回 TRUE。失败则返回 FALSE。

 

样例：

 

复制代码
复制代码
<?

php

$memcache_obj = memcache_connect(’memcache_host’, 11211);

memcache_flush($memcache_obj);

$memcache_obj = new Memcache;
$memcache_obj->connect(’memcache_host’, 11211);

$memcache_obj->flush();

?>

复制代码
复制代码

 

Memcache::get

 

string Memcache::get ( string $key [, int &$flags ] )

array Memcache::get ( array $keys [, array &$flags ] )

 

说明：

方法的作用是获取一个key值，key值能够是一个数组，结果会包括键值对。

 

參数：

$key是键值或者一个键的数组值。

$flags假设这个參数存在，那么$flags跟写入这个參数的值相关。这些$flags 类似于Memcache::set()函数里的$flags。

 

返回值：

假设成功。则返回key相应的值，假设失败则返回false.

样例：

 

复制代码
复制代码
<?

php

$memcache_obj = memcache_connect(’memcache_host’, 11211);
$var = memcache_get($memcache_obj, ’some_key’);

$memcache_obj = new Memcache;
$memcache_obj->connect(’memcache_host’, 11211);
$var = $memcache_obj->get(’some_key’);

$memcache_obj = memcache_connect(’memcache_host’, 11211);
$var = memcache_get($memcache_obj, Array(’some_key’, ’another_key’));

$memcache_obj = new Memcache;
$memcache_obj->connect(’memcache_host’, 11211);
$var = $memcache_obj->get(Array(’some_key’, ’second_key’));

?

>

复制代码
复制代码

 

Memcache::getExtendedStats

 

array Memcache::getExtendedStats ([ string $type [, int $slabid [, int $limit ]]] )

 

说明：

获取进程池中全部进程的执行系统统计。同样函数是memcache_get_extended_stats()

 

參数：

$type表示要求返回的类型：reset, malloc, maps, cachedump, slabs, items, sizes;

$slabid第一个參数设置为”cachedump”时使用的。

$limit第一个參数设置为”cachedump”时使用的。

返回值：

假设成功，返回统计信息。失败会返回false

 

样例：

 

复制代码
复制代码
<?

php
$memcache_obj = new Memcache;
$memcache_obj->addServer(’memcache_host’, 11211);
$memcache_obj->addServer(’failed_host’, 11211);

$stats = $memcache_obj->getExtendedStats();

//slabs机制分配管理内存的情况

$statsslab = $memcache_obj->getExtendedStats(slabs);

?>

复制代码
复制代码

 

 

Memcache::getServerStatus

 

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

 

说明：

获取执行server的參数。返回一个server在线或者离线的状态。

同样的函数是memcache_get_server_status()

 

參数：

$host：正在收听的连接的主机

$port正在收听的连接的主机的端口，默认是11211

 

返回值：

成功返回server状态，server没有启动会返回0，其它数字的时候表示server是启动状态的。

 

样例：

 

复制代码
复制代码
<?

php

$memcache = new Memcache;
$memcache->addServer(’memcache_host’, 11211);
echo $memcache->getServerStatus(’memcache_host’, 11211);

$memcache = memcache_connect(’memcache_host’, 11211);
echo memcache_get_server_status($memcache, ’memcache_host’, 11211);

?

>
 

复制代码
复制代码

 

Memcache::getStats

 

array Memcache::getStats ([ string $type [, int $slabid [, int $limit ]]] )

 

说明：

返回server的一些执行统计信息。

同样的函数是memcache_get_stats()

 

參数：

$type表示要求返回的类型：reset, malloc, maps, cachedump, slabs, items, sizes;

$slabid第一个參数设置为”cachedump”时使用的。

$limit第一个參数设置为”cachedump”时使用的。

Memcache::getVersion

 

string Memcache::getVersion ( void )

 

说明：

返回执行的Memcache的版本号信息。同样函数memcache_get_version()

 

返回值：

成功返回server的版本号信息。失败的时候返回false。

 

样例：

 

复制代码
复制代码
<?php

$memcache = new Memcache;
$memcache->connect('memcache_host', 11211);
echo $memcache->getVersion();

$memcache = memcache_connect('memcache_host', 11211);
echo memcache_get_version($memcache);

?

>

复制代码
复制代码

 

 

Memcache::increment

 

int Memcache::increment ( string $key [, int $value ] )

 

对保存的某个key中的值进行加法操作

使用方法參考Memcache::decrement

 

 

Memcache::pconnect

 

bool Memcache::pconnect ( string $host [, int $port [, int $timeout ]] )

 

说明：

创建一个Memcache的持久连接对象

使用方法与Memcache::connect()相似，不同点地方是Memcache::pconnect是建立的持久连接。这个连接在脚本执行完或者Memcache::close()函数执行也不会被关闭。

与它同样的函数是memcache_pconnect()

 

參数：

$host：指向memcached正在收听的链接的主机，这个參数会有还有一种特殊的连接方式unix:///path/to/memcached.sock，即用unix的域名sockets。这样的情况下，port必须设置为0

$port：指向memcached正在收听的链接的port。用unix的域名sockets的情况下，port必须设置为0

$timeout：用于连接守护进程的秒数，当你改变默认的1秒的值的时候，你须要考虑一下，假设你的连接太慢的话。你可能会失去缓存的优势。

 

返回值：

假设成功则返回 TRUE，失败则返回 FALSE

 

复制代码
复制代码
<?php

$memcache_obj = memcache_pconnect('memcache_host', 11211);

$memcache_obj = new Memcache;
$memcache_obj->pconnect('memcache_host', 11211);

?

>

复制代码
复制代码

 

Memcache::replace

 

bool Memcache::replace ( string $key , mixed $var [, int $flag [, int $expire ]] )

 

说明：

对一个已有的key进行覆写操作。

同样函数是memcache_replace()

 

參数：

$key ：将要存储的键值。

$var ：存储的值，字符型和整型会按原值保存，其它类型自己主动序列化以后保存。

$flag：是否用MEMCACHE_COMPRESSED来压缩存储的值，true表示压缩。false表示不压缩。

$expire：存储值的过期时间，假设为0表示不会过期。你能够用unix时间戳或者描写叙述来表示从如今開始的时间，可是你在使用秒数表示的时候，不要超过2592000秒 (表示30天)。

 

返回值：

假设成功则返回 TRUE，失败则返回 FALSE。

假设$key值已经存在，则会返回FALSE。

 

 

复制代码
复制代码
<?php

$memcache_obj = memcache_connect('memcache_host', 11211);

memcache_replace($memcache_obj, "test_key", "some variable", false, 30);

$memcache_obj->replace("test_key", "some variable", false, 30);

?

>

复制代码
复制代码

 

 

Memcache::set

 

bool Memcache::set ( string $key , mixed $var [, int $flag [, int $expire ]] )

 

说明：

加入一个值，假设已经存在，则覆写。同样函数是memcache_set()

 

參数：

$key ：将要存储的键值。

$var ：存储的值，字符型和整型会按原值保存，其它类型自己主动序列化以后保存。

$flag：是否用MEMCACHE_COMPRESSED来压缩存储的值，true表示压缩，false表示不压缩。

$expire：存储值的过期时间，假设为0表示不会过期。你能够用unix时间戳或者描写叙述来表示从如今開始的时间，可是你在使用秒数表示的时候。不要超过2592000秒 (表示30天)。

 

返回值：

假设成功则返回 TRUE，失败则返回 FALSE。

 

样例：

 

 

复制代码
复制代码
$memcache_obj = new Memcache;

$memcache_obj->connect('memcache_host', 11211);

$memcache_obj->set('var_key', 'some really big variable', MEMCACHE_COMPRESSED, 50);

echo $memcache_obj->get('var_key');
复制代码
复制代码

 

Memcache::setCompressThreshold

 

bool Memcache::setCompressThreshold ( int $threshold [, float $min_savings ] )

 

说明：

对大于某一大小的数据进行压缩。

同样的函数是memcache_set_compress_threshold()

 

參数：

setCompressThreshold方法有两个參数，第一个參数表示处理数据大小的临界点。第二个參数表示压缩的比例，默觉得0.2。

 

返回值：

假设成功则返回 TRUE，失败则返回 FALSE。

 

样例：

 

复制代码
复制代码
<?php

$memcache_obj = new Memcache;
$memcache_obj->addServer('memcache_host', 11211);
$memcache_obj->setCompressThreshold(20000, 0.2);

$memcache_obj = memcache_connect('memcache_host', 11211);
memcache_set_compress_threshold($memcache_obj, 20000, 0.2);

?>
复制代码
复制代码

 

 

Memcache::setServerParams         

 

bool Memcache::setServerParams ( string $host [, int $port [, int $timeout [, int$retry_interval [, bool $status [, callback $failure_callback ]]]]] )

 

说明：

在执行时改动服务器的參数。同样函数是memcache_set_server_params()。

 

參数：

$hostserver的地址

$portserver端口

$timeout连接的持续时间

$retry_interval连接重试的间隔时间。默觉得15,设置为-1表示不进行重试

$status控制server的在线状态

$failure_callback同意设置一个回掉函数来处理错误信息。

 

返回值：

假设成功则返回 TRUE。失败则返回 FALSE。

 

样例：

 

复制代码
复制代码
<?php

function _callback_memcache_failure($host, $port) {
    print "memcache '$host:$port' failed";
}

$memcache = new Memcache;

// 离线模式添加一个server
$memcache->addServer('memcache_host', 11211, false, 1, 1, -1, false);

// 把server设成在线
$memcache->setServerParams('memcache_host', 11211, 1, 15, true, '_callback_memcache_failure');

$memcache_obj = memcache_connect('memcache_host', 11211);
memcache_set_server_params($memcache_obj, 'memcache_host', 11211, 1, 15, true, '_callback_memcache_failure');

?>
复制代码
复制代码

版权声明：本文博客原创文章，博客，未经同意，不得转载。

posted @ 2015-08-18 16:40  phlsheji  阅读(353)  评论(0)  编辑  收藏  举报