acl  3.5.3.0
Public 成员函数 | Protected 成员函数 | 所有成员列表
acl::ipc_client类 参考

#include <ipc_client.hpp>

+ 类 acl::ipc_client 继承关系图:
+ acl::ipc_client 的协作图:

Public 成员函数

 ipc_client (long long int magic=-1)
 
virtual ~ipc_client ()
 
virtual void destroy ()
 
virtual void on_open ()
 
virtual void on_close ()
 
virtual void on_message (int nMsg, void *data, int dlen)
 
bool open (aio_handle *handle, const char *addr, int timeout)
 
void open (aio_socket_stream *client)
 
bool open (const char *addr, int timeout)
 
void open (socket_stream *client)
 
void wait ()
 
void close ()
 
bool active () const
 
void append_message (int nMsg)
 
void delete_message (int nMsg)
 
void send_message (int nMsg, const void *data, int dlen)
 
aio_socket_stream * get_async_stream () const
 
aio_handle & get_handle () const
 
socket_stream * get_sync_stream () const
 

Protected 成员函数

void trigger (int nMsg, void *data, int dlen)
 

详细描述

异步IP消息类

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

构造及析构函数说明

◆ ipc_client()

acl::ipc_client::ipc_client ( long long int  magic = -1)

◆ ~ipc_client()

virtual acl::ipc_client::~ipc_client ( )
virtual

成员函数说明

◆ active()

bool acl::ipc_client::active ( ) const

连接流是否正常打开着

返回
{bool}

◆ append_message()

void acl::ipc_client::append_message ( int  nMsg)

添加指定消息的回调过程对象

参数
nMsg{int} 消息号

◆ close()

void acl::ipc_client::close ( )

主动关闭消息流

◆ delete_message()

void acl::ipc_client::delete_message ( int  nMsg)

删除指定消息的回调过程对象

参数
nMsg{int} 消息号

◆ destroy()

virtual void acl::ipc_client::destroy ( void  )
inlinevirtual

直接销毁接口，子类可以重载该接口

在文件 ipc_client.hpp 第 46 行定义.

47  {
48  delete this;
49  }

◆ get_async_stream()

aio_socket_stream* acl::ipc_client::get_async_stream ( ) const

获得异步流句柄

返回
{aio_socket_stream*}

◆ get_handle()

aio_handle& acl::ipc_client::get_handle ( ) const

获得异步引擎句柄

◆ get_sync_stream()

socket_stream* acl::ipc_client::get_sync_stream ( ) const

获得同步流够本

返回
{socket_stream*}

◆ on_close()

virtual void acl::ipc_client::on_close ( void  )
inlinevirtual

当异步流关闭时的回调接口

在文件 ipc_client.hpp 第 59 行定义.

59 {}

◆ on_message()

virtual void acl::ipc_client::on_message ( int  nMsg,
void *  data,
int  dlen 
)
virtual

当收到消息时的回调函数，子类必须实现该接口

参数
nMsg{int} 用户添加的自定义消息值
data{void*} 消息数据
dlen{int} 消息数据的长度

◆ on_open()

virtual void acl::ipc_client::on_open ( )
inlinevirtual

当调用 open 函数连接消息服务器成功时调用此函数

在文件 ipc_client.hpp 第 54 行定义.

54 {}

◆ open() [1/4]

bool acl::ipc_client::open ( aio_handle *  handle,
const char *  addr,
int  timeout 
)

与消息服务器之间建立连接并创建异步流

参数
handle{aio_handle*} 异步引擎句柄
addr{const char*} 消息服务器监听地址，格式为: IP:PORT(支持_WIN32/UNIX)，unix_path (仅支持UNIX)
timeout{int} 连接超时时间

◆ open() [2/4]

void acl::ipc_client::open ( aio_socket_stream *  client)

异步流已经建立，调用此函数完成 ipc_client 连接过程

参数
client{aio_socket_stream*} 异步连接流

◆ open() [3/4]

bool acl::ipc_client::open ( const char *  addr,
int  timeout 
)

与消息服务器之间建立连接并创建同步流

参数
addr{const char*} 消息服务器监听地址，格式为: IP:PORT(支持_WIN32/UNIX)，unix_path (仅支持UNIX)
timeout{int} 连接超时时间

◆ open() [4/4]

void acl::ipc_client::open ( socket_stream *  client)

同步流已经建立，调用此函数完成 ipc_client 连接过程

参数
client{socket_stream*} 异步连接流

◆ send_message()

void acl::ipc_client::send_message ( int  nMsg,
const void *  data,
int  dlen 
)

发送消息

参数
nMsg{int} 消息号
data{const void*} 数据
dlen{int} 数据长度

◆ trigger()

void acl::ipc_client::trigger ( int  nMsg,
void *  data,
int  dlen 
)
protected

触发消息过程

参数
nMsg{int} 消息ID
data{void*} 接收到的消息数据地址
dlen{int} 接收到的消息数据长度

◆ wait()

void acl::ipc_client::wait ( )

消息流已经创建，调用此函数打开 IPC 通道

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