acl::connect_client类 参考

#include <connect_client.hpp>

类 acl::connect_client 继承关系图:

acl::connect_client 的协作图:

Public 成员函数
	connect_client (void)
virtual	~connect_client ()
time_t	get_when ()
void	set_when (time_t when)
virtual bool	open ()=0
connect_pool *	get_pool () const
virtual void	set_timeout (int conn_timeout, int rw_timeout)

Protected 成员函数
void	set_pool (connect_pool *pool)
Protected 成员函数 继承自 acl::acl::noncopyable
	noncopyable ()
	~noncopyable ()

Protected 属性
int	conn_timeout_
int	rw_timeout_
time_t	when_
connect_pool *	pool_

友元
class	connect_pool

详细描述

在文件 connect_client.hpp 第 10 行定义.

构造及析构函数说明

connect_client()

acl::connect_client::connect_client ( void  )

inline

在文件 connect_client.hpp 第 13 行定义.

        : conn_timeout_(5)
        , rw_timeout_(5)
        , when_(0)
        , pool_(NULL) {}

~connect_client()

virtual acl::connect_client::~connect_client ( )

inlinevirtual

在文件 connect_client.hpp 第 19 行定义.

{}

成员函数说明

get_pool()

connect_pool* acl::connect_client::get_pool ( ) const

inline

获得连接池对象引用，在 connect_pool 内部创建 连接对象会调用 set_pool 设置连接池对象句柄

返回

{connect_pool*}

在文件 connect_client.hpp 第 49 行定义.

        {
                return pool_;
        }

get_when()

time_t acl::connect_client::get_when ( )

inline

获得该连接对象最近一次被使用的时间截

返回

{time_t}

在文件 connect_client.hpp 第 25 行定义.

        {
                return when_;
        }

open()

virtual bool acl::connect_client::open ( )

pure virtual

纯虚函数，子类必须实现此函数用于连接服务器

返回

{bool} 是否连接成功

在 acl::http_request, acl::db_handle, acl::memcache, acl::redis_client, acl::mqtt_client , 以及 acl::tcp_client 内被实现.

set_pool()

void acl::connect_client::set_pool ( connect_pool *  pool )

inlineprotected

在文件 connect_client.hpp 第 76 行定义.

        {
                pool_ = pool;
        }

set_timeout()

virtual void acl::connect_client::set_timeout ( int  conn_timeout, int  rw_timeout  )

inlinevirtual

虚函数，该函数设置网络连接超时时间及网络 IO 超时时间，子类可以重载该虚函数， 以便于设置内部的对象超时时间

参数

conn_timeout	{int} 网络连接超时时间(秒)
rw_timeout	{int} 网络 IO 超时时间(秒)

在文件 connect_client.hpp 第 61 行定义.

        {
                conn_timeout_ = conn_timeout;
                rw_timeout_ = rw_timeout;
        }

set_when()

void acl::connect_client::set_when ( time_t  when )

inline

设置该连接对象当前被使用的时间截

在文件 connect_client.hpp 第 33 行定义.

        {
                when_ = when;
        }

友元及相关函数文档

connect_pool

friend class connect_pool

friend

在文件 connect_client.hpp 第 71 行定义.

类成员变量说明

conn_timeout_

int acl::connect_client::conn_timeout_

protected

在文件 connect_client.hpp 第 68 行定义.

pool_

connect_pool* acl::connect_client::pool_

protected

在文件 connect_client.hpp 第 74 行定义.

rw_timeout_

int acl::connect_client::rw_timeout_

protected

在文件 connect_client.hpp 第 69 行定义.

when_

time_t acl::connect_client::when_

protected

在文件 connect_client.hpp 第 73 行定义.

---

该类的文档由以下文件生成:

• include/acl_cpp/connpool/connect_client.hpp