redis_client_pool.hpp

浏览该文件的文档.

#pragma once
#include "../acl_cpp_define.hpp"
#include "../connpool/connect_pool.hpp"

#if !defined(ACL_CLIENT_ONLY) && !defined(ACL_REDIS_DISABLE)

namespace acl
{

class sslbase_conf;

/**
 * redis 连接池类，该类继承于 connect_pool，在 connect_pool 定义了通用的有关
 * TCP 连接池的通用方法。
 * redis connection pool inherting from connect_pool, which includes
 * TCP connection pool methods.
 */
class ACL_CPP_API redis_client_pool : public connect_pool
{
public:
        /**
         * 构造函数
         * constructor
         * @param addr {const char*} 服务端地址，格式：ip:port
         *  the redis-server's listening address, format: ip:port
         * @param count {size_t} 连接池的最大连接数限制，如果此值为 0，则连接池
         *  没有上限限制。
         *  the max connections for each connection pool. there is
         *  no connections limit of the pool when the count is 0.
         * @param idx {size_t} 该连接池对象在集合中的下标位置(从 0 开始)
         *  the subscript of the connection pool in the connection cluster
         */
        redis_client_pool(const char* addr, size_t count, size_t idx = 0);

        virtual ~redis_client_pool(void);

        /**
         * 设置 SSL 通信方式下的配置句柄，内部缺省值为 NULL，如果设置了 SSL 连
         * 接配置对象，则内部切换成 SSL 通信方式
         * set SSL communication with Redis-server if ssl_conf not NULL
         * @param ssl_conf {sslbase_conf*}
         * @return {redis_client_pool&}
         */
        redis_client_pool& set_ssl_conf(sslbase_conf* ssl_conf);

        /**
         * 设置连接 redis 服务器的连接密码
         * @param pass {const char*} 连接密码
         * @return {redis_client_pool&}
         */
        redis_client_pool& set_password(const char* pass);

        /**
         * 在非集群模式下，本方法用来设置连接建立后所选择的db
         * in no-cluster mode, the method is used to select the db after
         * the connection is created
         * @param dbnum {int}
         * @return {redis_client_pool&}
         */
        redis_client_pool& set_db(int dbnum);

        /**
         * 获得本连接池所对应的db
         * get the current db of the connections pool
         * @return {int}
         */
        int get_db(void) const
        {
                return dbnum_;
        }

protected:
        /**
         * 基类纯虚函数: 调用此函数用来创建一个新的连接
         * virtual function in class connect_pool to create a new connection
         * @return {connect_client*}
         */
        connect_client* create_connect(void);

private:
        char* pass_;
        int   dbnum_;
        sslbase_conf* ssl_conf_;
};

} // namespace acl

#endif // !defined(ACL_CLIENT_ONLY) && !defined(ACL_REDIS_DISABLE)