目次
2.1.2 タイムアウト期間を設定し、接続待機をブロックします。
2.1.3 ノンブロッキング、接続の有無に関係なくすぐに戻ります。
序文
HiredisはredisのCクライアントライブラリ機能であり、同期API、非同期API、解析APIなど複数のAPIを備えています。このライブラリの API を使用すると、C 言語コードを使用して Redis データベースに接続し、操作できます。以下に、一般的に使用される API をいくつか紹介します。
1.ハイディスのインストール
Hiredis ソース コード アドレス: GitHub - redis/hiredis: Redis >= 1.2 用の最小限の C クライアント
コード管理ツール git を使用してコードを複製したり、圧縮パッケージをダウンロードしたりできます。tar -xzf を使用して、圧縮パッケージを解凍します。
Hiredis ディレクトリに入り、最初に make コマンドを使用し、次に make install コマンドを使用します。
コード内で Hiredis ライブラリを参照する場合は、次の点に注意する必要があります。
- gcc/g++ でコンパイルする場合は、ライブラリ名 -lhiredis を指定する必要があります。
- Hiredis ライブラリのパスを LD_LIBRARY_PATH 環境変数に追加する必要があります。そうしないと、動的接続中に Hiredis ライブラリが見つかりません。プロセス ダイナミック リンク ライブラリは、この環境変数のパスにあります。デフォルトでは、hiredis は /usr/local/lib ディレクトリにインストールされます。
2. 同期API
2.1. Redis データベースに接続する
2.1.1 タイムアウトなし、接続待機をブロックする
redisContext* redisConnect(const char* ip, int port);パラメータの説明:
ip: は Redis データベースの IP アドレスで、リモート IP またはローカル IP 127.0.0.1 を指定できます。
port: Redis データベースによって監視されるポート番号。デフォルトは 6379 です。
戻り値:
戻り値は、ライブラリのコンテキストである redisContext オブジェクトへのポインターです。このオブジェクトの具体的な構成を知る必要はありませんが、その使用方法を知る必要があります。
接続エラーが発生した場合、返される redisContext オブジェクトの err は 1 に設定され、エラー情報は errstr に格納されます。
typedef struct redisContext {
int err; /* Error flags, 0 when there is no error */
char errstr[128]; /* String representation of error when applicable */
int fd;
int flags;
char *obuf; /* Write buffer */
redisReader *reader; /* Protocol reader */
enum redisConnectionType connection_type;
struct timeval *timeout;
struct {
char *host;
char *source_addr;
int port;
} tcp;
struct {
char *path;
} unix_sock;
} redisContext;
2.1.2 タイムアウト期間を設定し、接続待機をブロックします。
redisContext *redisConnectWithTimeout(const char *ip, int port, const struct timeval tv); 2.1.3 ノンブロッキング、接続の有無に関係なくすぐに戻ります。
redisContext *redisConnectNonBlock(const char *ip, int port);2.2. コマンドの実行
2.2.1 実行コンテキストを返す
void *redisCommand(redisContext* c, char *format, ...);パラメータの説明:
c は redisContext オブジェクトであり、redisConnect 関数は値を返します。
後者のパラメータは不定パラメータです。対応するパラメータはフォーマット形式で指定できます。printf 関数と似ています。
戻り値:
戻り値は void 型のポインタで、実際には redisReply 型へのポインタです。
redisReply タイプの定義:
/* This is the reply object returned by redisCommand() */
typedef struct redisReply {
/*命令执行结果的返回类型*/
int type; /* REDIS_REPLY_* */
/*存储执行结果返回为整数*/
long long integer; /* The integer when type is REDIS_REPLY_INTEGER */
/*字符串值的长度*/
size_t len; /* Length of string */
/*存储命令执行结果返回是字符串*/
char *str; /* Used for both REDIS_REPLY_ERROR and REDIS_REPLY_STRING */
/*返回结果是数组的大小*/
size_t elements; /* number of elements, for REDIS_REPLY_ARRAY */
/*存储执行结果返回是数组*/
struct redisReply **element; /* elements vector for REDIS_REPLY_ARRAY */
} redisReply;
戻り値結果の型はreply->typeで、replyはredisReply*型となります。
- REDIS_REPLY_STRING == 1: 戻り値は文字列であり、その文字列は redis->str に格納されます。文字列の長さは redis->len です。
- REDIS_REPLY_ARRAY == 2: 戻り値は配列であり、配列のサイズは Reply->elements に格納され、配列の値は redis->element[i] に格納されます。配列には、redisReply オブジェクトへのポインターが格納されます。
- REDIS_REPLY_INTEGER == 3: 戻り値は整数longlongです。
- REDIS_REPLY_NIL == 4: 戻り値の結果は空です。これは、実行結果が空であることを意味します。
- REDIS_REPLY_STATUS == 5: コマンド実行のステータスを返します。例: set foo bar はステータス "OK" を返します。このステータスは str Reply->str == "OK" に保存されます。
- REDIS_REPLY_ERROR == 6: コマンド実行エラー。エラー情報は Reply->str に格納されます。
void* redisCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen);パラメータの説明:
argc: コマンドパラメータの数が格納されます（以下の例ではargc=3）。
argv: 各コマンドパラメータを格納するポインタ、argv={"set","foo","bar"}
argvlen: この配列には、コマンド自体を含む、コマンド パラメーター内の各パラメーターの長さが格納されます。たとえば、上の例の argvlen={3,3,3} では、argvlen が空の場合、strlen 関数が内部で自動的に呼び出され、各パラメーターの長さを確認します。
各コマンド引数の長さを指定します。これにはバイナリセーフ関数を使用できます。この関数は、「\0」ではなく長さに基づいて文字列を終了します。
戻り値:
戻り値はredisCommandと同じです。
例：
#include <iostream>
#include "../hiredis/hiredis.h"
void hiredisTest()
{
redisContext* c = redisConnect("127.0.0.1", 6379);
if(!c)
{
std::cout << "error" << std::endl;
return;
}
else if(c->err)
{
std::cout << c->errstr << std::endl;
return;
}
std::cout << "success" << std::endl;
//执行命令
const char* s1 = "k1";
const char* s2 = "v1";
const char* s3 = "k2";
const char* s4 = "v2";
redisReply* replyPtr = (redisReply*)redisCommand(c, "mset %s %s %s %s", s1, s2, s3, s4);
if(replyPtr || replyPtr->type == REDIS_REPLY_ERROR)
{
if(replyPtr)
{
std::cout << replyPtr->str << std::endl;
}
else
{
std::cout << "redis command error" << std::endl;
}
}
freeReplyObject(replyPtr);
int argc = 3;
const char *argv[] = {"mget", "k1", "k2"};
size_t arglen[] = {4, 2, 2};
redisReply* replyPtr1 = (redisReply*)redisCommandArgv(c, argc, argv, arglen);
if(!replyPtr1 || replyPtr1->type == REDIS_REPLY_ERROR)
{
if(replyPtr1)
{
std::cout << replyPtr1->str << std::endl;
}
else
{
std::cout << "redis command error" << std::endl;
}
}
std::cout << replyPtr1->type << std::endl;
for(size_t i = 0; i < replyPtr1->elements; ++i)
{
std::cout << replyPtr1->element[i]->str << "\t";
}
std::cout<< std::endl;
freeReplyObject(replyPtr1);
redisFree(c);
}
int main()
{
hiredisTest();
return 0;
}2.2.2 実行コンテキストが返されない
void redisAppendCommand(redisContext *c, const char *format, ...);パラメータはredisCommandと同じです。
void redisAppendCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen);
パラメータはredisCommandArgvと同じです。
int redisGetReply(redisContext *c, void **reply);機能:実行コマンドコンテキストを取得します。
パラメータの説明:
c は、ライブラリのコンテキストである redisConnect の戻り値です。
Reply は redisReply ポインターのアドレスであり、コマンド実行コンテキストを取得するために使用される出力パラメーターです。
戻り値の説明:
成功すると REDIS_OK が返され、失敗すると REDIS_ERR が返されます。
2.3. リソースのリリース
Hiredis は接続中およびコマンド実行中にコンテキストを生成し、新しいスペースを開くため、解放する必要があります。解放しないとメモリ リークが発生します。
2.3.1 接続コンテキストの切断と解放
void redisFree(redisContext *c);2.3.2 コマンド実行コンテキストの解放
void freeReplyObject(void *reply);