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