connect_client.hpp

浏览该文件的文档.

#pragma once
#include "../acl_cpp_define.hpp"
#include "../stdlib/noncopyable.hpp"

namespace acl
{

class connect_pool;

class ACL_CPP_API connect_client : public noncopyable
{
public:
        connect_client(void)
        : conn_timeout_(5)
        , rw_timeout_(5)
        , when_(0)
        , pool_(NULL) {}

        virtual ~connect_client() {}

        /**
         * 获得该连接对象最近一次被使用的时间截
         * @return {time_t}
         */
        time_t get_when()
        {
                return when_;
        }

        /**
         * 设置该连接对象当前被使用的时间截
         */
        void set_when(time_t when)
        {
                when_ = when;
        }

        /**
         * 纯虚函数，子类必须实现此函数用于连接服务器
         * @return {bool} 是否连接成功
         */
        virtual bool open() = 0;

        /**
         * 获得连接池对象引用，在 connect_pool 内部创建
         * 连接对象会调用 set_pool 设置连接池对象句柄
         * @return {connect_pool*}
         */
        connect_pool* get_pool() const
        {
                return pool_;
        }

public:
        /**
         * 虚函数，该函数设置网络连接超时时间及网络 IO 超时时间，子类可以重载该虚函数，
         * 以便于设置内部的对象超时时间
         * @param conn_timeout {int} 网络连接超时时间(秒)
         * @param rw_timeout {int} 网络 IO 超时时间(秒)
         */
        virtual void set_timeout(int conn_timeout, int rw_timeout)
        {
                conn_timeout_ = conn_timeout;
                rw_timeout_ = rw_timeout;
        }

protected:
        int   conn_timeout_;
        int   rw_timeout_;

        friend class connect_pool;

        time_t when_;
        connect_pool* pool_;

        void set_pool(connect_pool* pool)
        {
                pool_ = pool;
        }
};

} // namespace acl