#pragma once #include "acl_cpp/acl_cpp_define.hpp" #include namespace acl { typedef enum { REDIS_RESULT_UNKOWN, REDIS_RESULT_NIL, REDIS_RESULT_ERROR, REDIS_RESULT_STATUS, REDIS_RESULT_INTEGER, REDIS_RESULT_STRING, REDIS_RESULT_ARRAY, } redis_result_t; class string; class dbuf_pool; class redis_client; /** * 对 redis-server 返回结果对象类,对 redis-server 返回的数据进行分析后创建 * redis_result 类对象。 * the redis result for redis-server's reply */ class ACL_CPP_API redis_result { public: redis_result(dbuf_pool* pool); /** * 重载了 new/delete 操作符,在 new 新对象时,使内存的分配在 * 内存池进行分配 * override new/delete operator, when the new object was created, * memory was alloc in dbuf_pool, which is a memroy pool allocator */ void *operator new(size_t size, dbuf_pool* pool); void operator delete(void* ptr, dbuf_pool* pool); /** * 获得当前结果结点的数据类型 * get the data type of the reply from redis-server * @return {redis_result_t} * defined above REDIS_RESULT_ */ redis_result_t get_type() const { return result_type_; } /** * 获得当前结果结点存储的对象的个数 * get the number of objects from redis-server * @return {size_t} 返回值与存储类型的对应关系如下: * the relation between returned value and result type show below: * REDIS_RESULT_ERROR: 1 * REDIS_RESULT_STATUS: 1 * REDIS_RESULT_INTEGER: 1 * REDIS_RESULT_STRING: > 0 时表示该字符串数据被切分成非连接内存块的个数 * REDIS_RESULT_ARRAY: children_->size() */ size_t get_size() const; /** * 当返回值为 REDIS_RESULT_INTEGER 类型时,本方法返回对应的 32 位整数值 * get the 32 bits integer for REDIS_RESULT_INTEGER result * @param success {bool*} 本指针非 NULL 时记录操作过程是否成功 * when not NULL, storing the status of success * @return {int} */ int get_integer(bool* success = NULL) const; /** * 当返回值为 REDIS_RESULT_INTEGER 类型时,本方法返回对应的 64 位整数值 * get the 64 bits integer for REDIS_RESULT_INTEGER result * @param success {bool*} 本指针非 NULL 时记录操作过程是否成功 * when not NULL, storing the status of success * @return {long long int} */ long long int get_integer64(bool* success = NULL) const; /** * 当返回值为 REDIS_RESULT_STATUS 类型时,本方法返回状态信息 * get operation status for REDIS_RESULT_STATUS result * @return {const char*} 返回 "" 表示出错 * error if empty string returned */ const char* get_status() const; /** * 当出错时返回值为 REDIS_RESULT_ERROR 类型,本方法返回出错信息 * when some error happened, this can get the error information * @return {const char*} 返回空串 "" 表示没有出错信息 * there was no error information if empty string returned */ const char* get_error() const; /** * 返回对应下标的数据(当数据类型非 REDIS_RESULT_ARRAY 时) * get the string data of associated subscript(just for the type * of no REDIS_RESULT_ARRAY) * @param i {size_t} 数组下标 * the array's subscript * @param len {size_t*} 当为非 NULL 指针时存储所返回数据的长度 * when not NULL, the parameter will store the length of the result * @return {const char*} 返回 NULL 表示下标越界 * NULL if nothing exists or the subscript is out of bounds */ const char* get(size_t i, size_t* len = NULL) const; /** * 返回所有的数据数组(当数据类型非 REDIS_RESULT_ARRAY 时)地址 * return all data's array if the type isn't REDIS_RESULT_ARRAY * @return {const char**} */ const char** gets_argv() const { return (const char**) argv_; } /** * 返回所有的数据长度数组(当数据类型非 REDIS_RESULT_ARRAY 时)地址 * return all length's array if the type isn't REDIS_RESULT_ARRAY * @return {const size_t*} */ const size_t* get_lens() const { return lens_; } /** * 返回所有数据的总长度(当数据类型非 REDIS_RESULT_ARRAY 时) * return the total length of all data for no REDIS_RESULT_ARRAY * @return {size_t} */ size_t get_length() const; /** * 当数据类型为 REDIS_RESULT_STRING 类型时,该函数将按内存块存放的数据 * 存储至连接内存中,但需要注意防止内存溢出 * compose a continus data for the slicing chunk data internal * @param buf {string&} 存储结果数据,内部会先调用 buf.clear() * store the result * @return {int} 数据的总长度,返回值 -1 表示内部数组为空 * return the total length of data, -1 if data array has no elements */ int argv_to_string(string& buf) const; int argv_to_string(char* buf, size_t size) const; /** * 当数据类型为 REDIS_RESULT_ARRAY 类型时,该函数返回所有的数组对象 * return the objects array when result type is REDIS_RESULT_ARRAY * @param size {size_t*} 当返回数组非空时,则该地址存放数组长度 * store the array's length if size isn't NULL * @return {const const redis_result*} */ const redis_result** get_children(size_t* size) const; /** * 当数据类型为 REDIS_RESULT_ARRAY 类型时,该函数返回对应下标的结果对象 * get one object of the given subscript from objects array * @param i {size_t} 下标值 * the given subscript * @return {const redis_result*} 当下标值越界或结果不存在时,则返回 NULL * NULL if subscript is out of bounds or object not exist */ const redis_result* get_child(size_t i) const; /** * 返回构造函数传入的内存池对象 * get the memory pool object set in constructor * @return {dbuf_pool*} */ dbuf_pool* get_pool() { return pool_; } private: ~redis_result(); friend class redis_client; void clear(); redis_result& set_type(redis_result_t type); redis_result& set_size(size_t size); redis_result& put(const char* buf, size_t len); redis_result& put(const redis_result* rr, size_t idx); private: redis_result_t result_type_; dbuf_pool* pool_; size_t size_; size_t idx_; const char** argv_; size_t* lens_; //std::vector* children_; const redis_result** children_; size_t children_size_; size_t children_idx_; }; } // namespace acl