acl::master_udp类 参考

#include <master_udp.hpp>

类 acl::master_udp 继承关系图:

acl::master_udp 的协作图:

Public 成员函数
void	run_daemon (int argc, char **argv)
bool	run_alone (const char *addrs, const char *path=NULL, unsigned int count=1)
void	lock (void)
void	unlock (void)
Public 成员函数 继承自 acl::master_base
master_base &	set_cfg_bool (master_bool_tbl *table)
master_base &	set_cfg_int (master_int_tbl *table)
master_base &	set_cfg_int64 (master_int64_tbl *table)
master_base &	set_cfg_str (master_str_tbl *table)
bool	daemon_mode (void) const
bool	proc_set_timer (event_timer *timer)
void	proc_del_timer (event_timer *timer)

Protected 成员函数
	master_udp ()
virtual	~master_udp ()
virtual void	on_read (socket_stream *stream)=0
virtual void	proc_on_bind (socket_stream &)
virtual void	proc_on_unbind (socket_stream &)
virtual void	thread_on_init (void)
const std::vector< socket_stream * > &	get_sstreams () const
const char *	get_conf_path (void) const
Protected 成员函数 继承自 acl::master_base
	master_base ()
virtual	~master_base ()
virtual void	proc_on_listen (server_socket &ss)
virtual void	proc_pre_jail ()
virtual void	proc_on_init ()
virtual void	proc_on_exit ()
virtual bool	proc_on_sighup (string &)
void	set_event (ACL_EVENT *event)
ACL_EVENT *	get_event (void) const
Protected 成员函数 继承自 acl::acl::noncopyable
	noncopyable ()
	~noncopyable ()

额外继承的成员函数
Protected 属性 继承自 acl::master_base
bool	daemon_mode_
bool	proc_inited_
std::vector< server_socket * >	servers_
master_conf	conf_

详细描述

在文件 master_udp.hpp 第 12 行定义.

构造及析构函数说明

master_udp()

acl::master_udp::master_udp ( )

protected

~master_udp()

virtual acl::master_udp::~master_udp ( )

protectedvirtual

成员函数说明

get_conf_path()

const char* acl::master_udp::get_conf_path ( void  ) const

protected

获得配置文件路径

返回

{const char*} 返回值为 NULL 表示没有设配置文件

get_sstreams()

const std::vector<socket_stream*>& acl::master_udp::get_sstreams ( ) const

inlineprotected

获得本地监听的套接口流对象集合

返回

{const std::vector<socket_stream*>&}

在文件 master_udp.hpp 第 64 行定义.

        {
                return sstreams_;
        }

lock()

void acl::master_udp::lock

(

void

)

on_read()

virtual void acl::master_udp::on_read ( socket_stream *  stream )

protectedpure virtual

纯虚函数：当 UDP 流有数据可读时回调子类此函数，该方法在子线程中调用

参数

stream

{socket_stream*}

proc_on_bind()

virtual void acl::master_udp::proc_on_bind ( socket_stream &  )

inlineprotectedvirtual

当绑定 UDP 地址成功后回调此虚方法，该方法在子线程中被调用

在文件 master_udp.hpp 第 48 行定义.

{}

proc_on_unbind()

virtual void acl::master_udp::proc_on_unbind ( socket_stream &  )

inlineprotectedvirtual

当解绑 UDP 地址时回调此虚方法，该方法在子线程中被调用

在文件 master_udp.hpp 第 53 行定义.

{}

run_alone()

bool acl::master_udp::run_alone	(	const char *	addrs,
		const char *	path = NULL,
		unsigned int	count = 1
	)

在单独运行时的处理函数，用户可以调用此函数进行一些必要的调试工作

参数

addrs	{const char*} 服务监听地址列表，格式：IP:PORT, IP:PORT...
path	{const char*} 配置文件全路径
count	{unsigned int} 循环服务的次数，达到此值后函数自动返回； 若该值为 0 则表示程序一直循环处理外来请求而不返回

返回

{bool} 监听是否成功

run_daemon()

void acl::master_udp::run_daemon	(	int	argc,
		char **	argv
	)

开始运行，调用该函数是指该服务进程是在 acl_master 服务框架 控制之下运行，一般用于生产机状态

参数

argc	{int} 从 main 中传递的第一个参数，表示参数个数
argv	{char**} 从 main 中传递的第二个参数

thread_on_init()

virtual void acl::master_udp::thread_on_init ( void  )

inlineprotectedvirtual

当线程初始化时该虚方法将被调用

在文件 master_udp.hpp 第 58 行定义.

{}

unlock()

void acl::master_udp::unlock

(

void

)

---

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

• include/acl_cpp/master/master_udp.hpp