#pragma once #include "acl_cpp/acl_cpp_define.hpp" #include #ifdef WIN32 #include #endif struct ACL_ASTREAM; struct ACL_VSTREAM; namespace acl { /** * 异步流回调类 */ class ACL_CPP_API aio_callback { public: aio_callback(void) {} virtual ~aio_callback(void) {}; virtual void close_callback() {} virtual bool timeout_callback() { return false; } /** * 读回调虚函数,该回调函数当满足了类 aio_istream 实例中的 * gets/read 的可读条件后被调用,由异步框架内部将符合条件的数 * 据读出,直接传递给用户的子类 * @param data {char*} 读到的数据的指针地址 * @param len {int} 读到的数据长度(> 0) * @return {bool} 该函数返回 false 通知异步引擎关闭该异步流 */ virtual bool read_callback(char* data, int len) { (void) data; (void) len; return true; } /** * 读回调虚函数,该回调函数当满足了类 aio_istream 实例中的 * read_wait 的可读条件即异步流中有数据可读时被调用;当超时时会 * 调用 timeout_callback,流异常被关闭时会调用 close_callback */ virtual bool read_wakeup() { return true; } /** * 写成功后的回调虚函数 * @return {bool} 该函数返回 false 通知异步引擎关闭该异步流 */ virtual bool write_callback() { return true; } /** * 读回调虚函数,该回调函数当满足了类 aio_ostream 实例中的 * write_wait 的可写条件即异步流可写时被调用;当超时时会 * 调用 timeout_callback,流异常被关闭时会调用 close_callback */ virtual bool write_wakeup() { return true; } protected: private: }; struct AIO_CALLBACK { aio_callback* callback; bool enable; }; class aio_handle; /** * 异步流基类,该类为纯虚类,不能被直接实例化,只能被子类继承使用 * 该类只能在堆上分配,不能在栈上分配 */ class ACL_CPP_API aio_stream { public: /** * 构造函数 * @param handle {aio_handle*} */ aio_stream(aio_handle* handle); /** * 关闭异步流 */ void close(); /** * 添加关闭时的回调类对象指针,如果该回调类对象已经存在,则只是 * 使该对象处于打开可用状态 * @param callback {aio_callback*} 继承 aio_callback 的子类回调类对象, * 当异步流关闭前会先调用此回调类对象中的 close_callback 接口 */ void add_close_callback(aio_callback* callback); /** * 添加超时时的回调类对象指针,如果该回调类对象已经存在,则只是 * 使该对象处于打开可用状态 * @param callback {aio_callback*} 继承 aio_callback 的子类回调类对象, * 当异步流关闭前会先调用此回调类对象中的 timeout_callback 接口 */ void add_timeout_callback(aio_callback* callback); /** * 删除关闭时的回调类对象指针 * @param callback {aio_callback*} 从 aio_callback 继承的子类对象指针, * 若该值为空,则删除所有的关闭回调对象 * @return {int} 返回被从回调对象集合中删除的回调对象的个数 */ int del_close_callback(aio_callback* callback = NULL); /** * 删除超时时的回调类对象指针 * @param callback {aio_callback*} 从 aio_callback 继承的子类对象指针, * 若该值为空,则删除所有的超时回调对象 * @return {int} 返回被从回调对象集合中删除的回调对象的个数 */ int del_timeout_callback(aio_callback* callback = NULL); /** * 禁止关闭的回调类对象,但并不从关闭对象集合中删除 * @param callback {aio_callback*} 从 aio_callback 继承的子类对象指针, * 若该值为空,则禁止所有的关闭回调对象 * @return {int} 返回被从回调对象集合中禁用的回调对象的个数 */ int disable_close_callback(aio_callback* callback = NULL); /** * 禁止超时的回调类对象,但并不从超时对象集合中删除 * @param callback {aio_callback*} 从 aio_callback 继承的子类对象指针, * 若该值为空,则禁止所有的超时回调对象 * @return {int} 返回被从回调对象集合中禁用的回调对象的个数 */ int disable_timeout_callback(aio_callback* callback = NULL); /** * 启用所有的回调对象被调用 * @param callback {aio_callback*} 启用指定的回调对象,如果该值为空, * 则启用所有的关闭回调对象 * @return {int} 返回被启用的回调对象的个数 */ int enable_close_callback(aio_callback* callback = NULL); /** * 启用所有的回调对象被调用 * @param callback {aio_callback*} 启用指定的回调对象,如果该值为空, * 则启用所有的超时回调对象 * @return {int} 返回被启用的回调对象的个数 */ int enable_timeout_callback(aio_callback* callback = NULL); /** * 获得异步流对象 ACL_ASTREAM * @return {ACL_ASTREAM*} */ ACL_ASTREAM* get_astream() const; /** * 获得异步流对象中的同步流对象 ACL_VSTREAM * @return {ACL_VSTREAM*} */ ACL_VSTREAM* get_vstream() const; /** * 获得异步流中的 SOCKET 描述符 * @return {ACL_SOCKET} 若不存在则返回 -1(UNIX) 或 INVALID_SOCKET(win32) */ #ifdef WIN32 SOCKET get_socket() const; SOCKET sock_handle() const #else int get_socket() const; int sock_handle() const #endif { return get_socket(); } /** * 获得异步流事件句柄 * @return {aio_handle&} */ aio_handle& get_handle() const; /** * 判断流是否处于 hooked 状态 * @return {bool} */ bool is_hooked() const; protected: aio_handle* handle_; ACL_ASTREAM* stream_; virtual ~aio_stream(); /** * 通过此函数来动态释放只能在堆上分配的异步流类对象 */ virtual void destroy(); /** * 子类应在创建成功后调用该函数通知基类增加异步流句柄数, * 同时 hook 流关闭及流超时时的回调过程 */ void hook_error(); private: bool error_hooked_; std::list close_callbacks_; std::list timeout_callbacks_; static int close_callback(ACL_ASTREAM*, void*); static int timeout_callback(ACL_ASTREAM*, void*); }; } // namespace acl