reply = redisCommand(context, "SET foo %b", value, (size_t) valuelen);
在API內部,Hiredis根據不同的參數分割命令轉化為操作redis數據庫的標準命令,你可以格式化多個參數來構造redis的命令,如下
reply = redisCommand(context, "SET key:%s %s", myid, value);
處理redis應答
當命令被成功執行后redisCommand會有相應的返回值。如果有錯誤發生,返回值為NULL并且redisReply結構體中的err變量將會被設置成相應的值(請參照Errors章節)。一旦有錯誤發生context不能被重用并且你需要建立一個新的連接。
redisCommand執行后返回值類型為redisReply。通過redisReply結構體中的type變量可以確定命令執行的情況。
REDIS_REPLY_STATUS:
返回執行結果為狀態的命令。比如set命令的返回值的類型是REDIS_REPLY_STATUS,然后只有當返回信息是"OK"時,才表示該命令執行成功。可以通過reply->str得到文字信息,通過reply->len得到信息長度。
REDIS_REPLY_ERROR:
返回錯誤。錯誤信息可以通過reply->str得到文字信息,通過reply->len得到信息長度。
REDIS_REPLY_INTEGER:
返回整型標識。可以通過reply->integer變量得到類型為long long的值。
REDIS_REPLY_NIL:
返回nil對象,說明不存在要訪問的數據。
REDIS_REPLY_STRING:
返回字符串標識。可以通過reply->str得到具體值,通過reply->len得到信息長度。
REDIS_REPLY_ARRAY:
返回數據集標識。數據集中元素的數目可以通過reply->elements獲得,每個元素是個redisReply對象,元素值可以通過reply->element[..index..].*形式獲得,用在獲取多個數據結果的操作。
執行完命令調用后應該通過freeReplyObject()釋放redisReply,對于嵌套對象(比如數組)要注意,并不需要嵌套進行釋放,這樣是有害的會造成內存破壞。
Important:hiredis當前版本 (0.10.0)當使用異步API時會自己釋放replies對象。這意味著你使用異步API時并不需要主動調用freeReplyObject 。relpy對象當回調返回時將會被自動釋放。但是這種行為也許會在將來的版本中改變,所以升級時請密切關注升級日志。
清理連接資源
斷開連接并且釋放context使用以下函數
void redisFree(redisContext *c);
此函數立馬關閉socket并且釋放創建context時分配的資源。
發送多個命令參數
和redisCommand函數相似,redisCommandArgv函數可以用于傳輸多個命令參數。函數原型為
void *redisCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen);
,類似于 lpush, del key1 key2..., zadd key score1 member1 score2 member2...這類命令, 其中 argc是傳遞參數的個數, argv主要用于傳遞的string的value, 而argvlen 是每個string的size。
此函數返回值與redisCommand相似。參考https://gist.github.com/dspezia/1455082
管線(Pipelining)
為了搞清楚Hiredis在阻塞連接下的管線操作,需要理解其內部執行過程。
當任何類似于redisCommand的函數被調用,Hiredis首先將命令格式化為redis支持的命令協議。被格式化后的命令被放入context的輸出緩沖區,這個緩沖區是動態的,所以它可以容納任意數量的命令。在命令進入輸出緩沖區后,redisGetReply 函數被調用。這個函數有以下兩種執行方式:
輸入緩沖區非空:
從輸入緩沖區中嘗試解析單獨的reply對象并且返回reply
如果沒有reply能被解析,執行步驟2
輸入緩沖區為空:
將整個輸出緩沖區寫入socket
從socket中讀取數據直到有一個reply能被解析
Hiredis為了有效利用socket還提供了redisGetReply的接口。對于管線命令,需要完成的唯一事情就是填充輸出緩沖區。有兩個函數被用于執行此操作,這兩個函數基本與redisCommand函數功能類似,但是他們不返回reply
void redisAppendCommand(redisContext *c, const char *format, ...);void redisAppendCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen);
當這兩個函數被一次或多次調用時,通過redisGetReply依次返回replies。redisGetReply的返回值要么是REDISOK或是REDISERR,REDIS_ERR意味著獲得reply發生了錯誤,想要得到具體的錯誤原因可以通過err變量來獲取。
以下通過一個簡單例子說明管線的使用:
redisReply *reply;redisAppendCommand(context,"SET foo bar");redisAppendCommand(context,"GET foo");redisGetReply(context,&reply); // reply for SETfreeReplyObject(reply);redisGetReply(context,&reply); // reply for GETfreeReplyObject(reply);
redisGetReply這個API也可以被用來實現阻塞的訂閱模式
reply = redisCommand(context,"SUBSCRIBE foo");freeReplyObject(reply);while(redisGetReply(context,&reply) == REDIS_OK) {// consume messagefreeReplyObject(reply);}
Errors
如果某些函數(如redisConnect, redisCommand(調用不成功,函數返回值為NULL或者REDIS_ERR,此時context結構體中的err成員為非零值,可能為以下幾種常量
REDIS_ERR_IO:當創建連接時(試著寫socket或者讀socket)發生的I/O錯誤。如果你在代碼中包含了errno.h頭文件,你便能得到準確的錯誤碼。
REDIS_ERR_EOF:redis服務端已經關閉了此連接。
REDIS_ERR_PROTOCOL:服務端解析協議時發生了錯誤。
REDIS_ERR_OTHER:其他錯誤。目前僅僅表示無法解析目標主機名的錯誤。
在錯誤情況下,可以通過context結構體中的errstr成員得到錯誤的確切描述。
異步API
Hiredis自帶的異步API很容易和一些基于事件的庫結合使用。比如和libev、ibevent的結合使用。
連接
函數redisAsyncConnect被用來和redis建立非阻塞連接。它返回redisAsyncContext的結構體,結構體的err成員用來檢查在創建連接的過程中是否發生了錯誤。因為創建的是非阻塞的連接,內核并不能立馬返回一個連接指定主機的結果。
redisAsyncContext *c = redisAsyncConnect("127.0.0.1", 6379);if (c->err) {printf("Error: %s/n", c->errstr);// handle error}
異步Context可設置一個響應斷開連接事件的回調函數,當連接斷開時會相應執行。回調函數的原型為
void(const redisAsyncContext *c, int status);
在斷開連接的情況下,當連接是由用戶自己斷開的status參數為REDISOK,如果出現了其他錯誤status參數為REDISERR,當錯誤時通過err成員可以得到準確的錯誤碼。
當回調執行完畢后context對象會自己釋放資源。此事件的回調函數給你創建一個新連接提供了便利。
一個context對象僅能設置一次斷開連接的回調,如果再進行下一次設置將會返回REDIS_ERR。設置斷開連接回調函數的原型為:
int redisAsyncSetDisconnectCallback(redisAsyncContext *ac, redisDisconnectCallback *fn);
發送操作命令并且響應回調事件
在異步的情況下,redis的操作指令將會被自動加入事件循環隊列。由于發送命令執行的過程是異步的,當命令執行完畢后將會調用相應的回調函數。回調函數的原型為
void(redisAsyncContext *c, void *reply, void *privdata);
privdata參數是由調用者自己定義的數據類型。
以下是進行異步命令操作的函數:
int redisAsyncCommand(redisAsyncContext *ac, redisCallbackFn *fn, void *privdata,const char *format, ...);
int redisAsyncCommandArgv( redisAsyncContext *ac, redisCallbackFn *fn, void *privdata, int argc, const char **argv, const size_t *argvlen);
命令的使用方式和上面所講的同步接口類似。執行成功返回REDIS_OK,否則返回REDIS_ERR。比如連接已經關閉的情況下再使用redisAsyncCommand向此連接執行命令就會返回REDIS_ERR。
回調執行完畢后如果reply不為空,回調執行完畢后將自動對reply的資源進行回收。
當context發生錯誤時回調得到的reply將為空。
斷開連接
一個異步的連接可以通過下面這個函數終止
void redisAsyncDisconnect(redisAsyncContext *ac);
當這個函數被調用時,連接并不會被立即關閉,而是等待所有這個連接的異步命令操作執行完畢,并且回調事件已經執行完畢后才關閉此連接,這時在響應關閉連接事件的回調函數中得到的狀態為REDIS_OK,此連接的資源也將會被自動回收。
將其掛接到事件庫X
在context對象被創建后進行很少的幾步操作就可以進行掛接。參看目錄adapters/下是如何掛接到libev 和 libevent下的。
應答解析API
Hiredis自帶的答復解析API ,可以很容易與更高層次的語言進行綁定