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()。

例子：


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

例子：


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

例子：


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

例子：


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

例子：


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

例子：


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

例子：


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

例子：


$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

例子：

$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，其他數位時候表示伺服器是啟動狀態的。

例子：


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

例子：


$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


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


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

例子：


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

例子：


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');

?>

