PHP中Memcache類函數詳解

Memcache類函數列表以下：

Memcache::add – 添加一個值，若是已經存在，則返回false

Memcache::addServer – 添加一個可供使用的服務器地址

Memcache::close – 關閉一個Memcache對象

Memcache::connect – 建立一個Memcache對象

memcache_debug – 控制調試功能

Memcache::decrement – 對保存的某個key中的值進行減法操做

Memcache::delete – 刪除一個key值

Memcache::flush – 清除全部緩存的數據

Memcache::get – 獲取一個key值

Memcache::getExtendedStats – 獲取進程池中全部進程的運行系通通計

Memcache::getServerStatus – 獲取運行服務器的參數

Memcache::getStats – 返回服務器的一些運行統計信息

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

Memcache::increment – 對保存的某個key中的值進行加法操做

Memcache::pconnect – 建立一個Memcache的持久鏈接對象

Memcache::replace -對一個已有的key進行覆寫操做

Memcache::set – 添加一個值，若是已經存在，則覆寫

Memcache::setCompressThreshold – 對大於某一大小的數據進行壓縮

Memcache::setServerParams – 在運行時修改服務器的參數


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()方法），網絡鏈接只有等須要的時候纔會創建，所以不會由於增長不少的服務器到鏈接池而增長系統負擔，由於不少服務器可能沒有使用。

故障恢復會發生在這個方法執行的任何階段，只要其餘的服務器是正常的，這些鏈接請求的失敗用戶不會注意到。任何一種socket或者memcached服務器級的錯誤能夠觸發故障恢復。正常的客戶端錯誤好比增長一個存在的鍵值不會引起故障恢復。

參數：

$host服務器的地址

$port服務器端口

$persistent是不是一個持久鏈接

$weight這臺服務器在全部服務器中所佔的權重

$timeout鏈接的持續時間

$retry_interval鏈接重試的間隔時間，默認爲15,設置爲-1表示不進行重試

$status控制服務器的在線狀態

$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 )

說明：

關閉memcache服務器鏈接。這個函數不會關閉長鏈接，長鏈接只有在web服務器關閉或者重啓的時候纔會關閉。相同的函數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 ]] )

說明：

打開memcached服務器鏈接，創建一個到memcached服務器的鏈接，用Memcache::connect打開的鏈接會在腳本執行完畢後自動關閉。你也能夠用Memcache::close()去關閉鏈接。相同的函數是memcache_connect()。

參數：

$host：指向memcached正在收聽的連接的主機，這個參數會有另外一種特殊的鏈接方式unix:///path/to/memcached.sock，即用unix的域名sockets，這種狀況下，端口必須設置爲0

$port：指向memcached正在收聽的連接的端口，用unix的域名sockets的狀況下，端口必須設置爲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 ] )

說明：

獲取運行服務器的參數。返回一個服務器在線或者離線的狀態。相同的函數是memcache_get_server_status()

參數：

$host：正在收聽的鏈接的主機

$port正在收聽的鏈接的主機的端口，默認是11211

返回值：

成功返回服務器狀態，服務器沒有啓動會返回0，其餘數字的時候表示服務器是啓動狀態的。

例子：

<?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 ]]] )

說明：

返回服務器的一些運行統計信息。相同的函數是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()

返回值：

成功返回服務器的版本信息，失敗的時候返回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，這種狀況下，端口必須設置爲0

$port：指向memcached正在收聽的連接的端口，用unix的域名sockets的狀況下，端口必須設置爲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()。

參數：

$host服務器的地址

$port服務器端口

$timeout鏈接的持續時間

$retry_interval鏈接重試的間隔時間，默認爲15,設置爲-1表示不進行重試

$status控制服務器的在線狀態

$failure_callback容許設置一個回掉函數來處理錯誤信息。

返回值：

若是成功則返回 TRUE，失敗則返回 FALSE。

例子： <?php function _callback_memcache_failure($host, $port) {     print "memcache '$host:$port' failed"; } $memcache = new Memcache; // 離線模式增長一個服務器 $memcache->addServer('memcache_host', 11211, false, 1, 1, -1, false); // 把服務器設成在線 $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'); ?>