acl/lib_acl_cpp/include/acl_cpp/redis/redis_hash.hpp

#pragma once
#include "acl_cpp/acl_cpp_define.hpp"
#include <map>
#include <vector>
#include "acl_cpp/stdlib/string.hpp"
#include "acl_cpp/redis/redis_command.hpp"

namespace acl
{

class redis_client;
class redis_result;

class ACL_CPP_API redis_hash : public redis_command
{
public:
	redis_hash(redis_client* conn = NULL);
	~redis_hash();

	/////////////////////////////////////////////////////////////////////

	/**
	 * 将多个"域-值"对添加至 KEY 对应的哈希表中
	 * @param key {const char*} KEY 值
	 * @return {bool} 添加是否成功
	 */
	bool hmset(const char* key, const std::map<string, string>& attrs);
	bool hmset(const char* key, const std::map<string, char*>& attrs);
	bool hmset(const char* key, const std::map<string, const char*>& attrs);

	bool hmset(const char* key, const std::map<int, string>& attrs);
	bool hmset(const char* key, const std::map<int, char*>& attrs);
	bool hmset(const char* key, const std::map<int, const char*>& attrs);

	/////////////////////////////////////////////////////////////////////

	/**
	 * 根据 KEY 值将多个"域-值"对从哈希表中取出
	 * @param key {const char*} KEY 值
	 * @return {bool} 操作是否成功，如果返回成功，可以通过方法 hmget_result 根据
	 *  下标值取得对应的值，或直接调用 get_result 方法取得 redis_result
	 */
	bool hmget(const char* key, const std::vector<string>& names,
		std::vector<string>* result = NULL);
	bool hmget(const char* key, const std::vector<char*>& names,
		std::vector<string>* result = NULL);
	bool hmget(const char* key, const std::vector<const char*>& names,
		std::vector<string>* result = NULL);
	bool hmget(const char* key, const std::vector<int>& names,
		std::vector<string>* result = NULL);

	bool hmget(const char* key, const char* names[], size_t argc,
		std::vector<string>* result = NULL);
	bool hmget(const char* key, const int names[], size_t argc,
		std::vector<string>* result = NULL);
	bool hmget(const char* key, const char* names[], const size_t lens[],
		size_t argc, std::vector<string>* result = NULL);

	/**
	 * 当 hmget 获得 true 时调用本方法来获得对应下标的值，下标顺序与 hmget 中的数组
	 * 的下标顺序相同
	 * @param i {size_t} 下标（从 0 开始）
	 * @param len {size_t*} 若该指针非空，则存储所返回结果的长度（仅当该方法返回非
	 *  空指针时有效）
	 * @return {const char*} 返回对应下标的值，当返回 NULL 时表示该下标没有值，
	 *  为了保证使用上的安全性，返回的数据总能保证最后是以 \0 结尾，在计算数据长度时
	 *  不包含该结尾符
	 */
	const char* hmget_value(size_t i, size_t* len = NULL) const;
	const redis_result* hmget_child(size_t i) const;
	size_t hmget_size() const;

	/////////////////////////////////////////////////////////////////////

	int hset(const char* key, const char* name, const char* value);
	int hset(const char* key, const char* name,
		const char* value, size_t value_len);
	int hset(const char* key, const char* name, size_t name_len,
		const char* value, size_t value_len);

	int hsetnx(const char* key, const char* name, const char* value);
	int hsetnx(const char* key, const char* name,
		const char* value, size_t value_len);
	int hsetnx(const char* key, const char* name, size_t name_len,
		const char* value, size_t value_len);

	bool hget(const char* key, const char* name, string& result);
	bool hget(const char* key, const char* name,
		size_t name_len, string& result);

	bool hgetall(const char* key, std::map<string, string>& result);
	bool hgetall(const char* key, std::vector<string>& names,
		std::vector<string>& values);
	bool hgetall(const char* key, std::vector<const char*>& names,
		std::vector<const char*>& values);

	int hdel(const char* key, const char* first_name, ...)
		ACL_CPP_PRINTF(3, 4);;
	int hdel(const char* key, const char* names[], size_t argc);
	int hdel(const char* key, const char* names[],
		const size_t names_len[], size_t argc);
	int hdel(const char* key, const std::vector<string>& names);
	int hdel(const char* key, const std::vector<char*>& names);
	int hdel(const char* key, const std::vector<const char*>& names);

	bool hincrby(const char* key, const char* name,
		long long int inc, long long int* result = NULL);
	bool hincrbyfloat(const char* key, const char* name,
		double inc, double* result = NULL);

	bool hkeys(const char* key, std::vector<string>& names);

	bool hexists(const char* key, const char* name);
	bool hexists(const char* key, const char* name, size_t name_len);

	int hlen(const char* key);

	/**
	 * 命令用于迭代哈希键中的键值对
	 * @param key {const char*} 哈希键值
	 * @param cursor {int} 游标值，开始遍历时该值写 0
	 * @param out {std::map<string>&} 结果集
	 * @param pattern {const char*} 匹配模式，glob 风格，非空时有效
	 * @param count {const size_t*} 限定的结果集数量，非空指针时有效
	 * @return {int} 下一个游标位置，含义如下：
	 *   0：遍历结束
	 *  -1: 出错
	 *  >0: 游标的下一个位置
	 */
	int hscan(const char* key, int cursor, std::map<string, string>& out,
		const char* pattern = NULL, const size_t* count = NULL);
};

} // namespace acl