mirror of
https://gitee.com/acl-dev/acl.git
synced 2024-12-15 09:20:52 +08:00
99 lines
1.9 KiB
C++
99 lines
1.9 KiB
C++
#pragma once
|
||
|
||
struct ACL_FIBER;
|
||
|
||
namespace acl {
|
||
|
||
/**
|
||
* 协程类定义，纯虚类，需要子类继承并实现纯虚方法
|
||
*/
|
||
class fiber
|
||
{
|
||
public:
|
||
fiber(void);
|
||
virtual ~fiber(void);
|
||
|
||
/**
|
||
* 在创建一个协程类后，需要本函数启动协程
|
||
* @param stack_size {size_t} 创建的协程对象的栈大小
|
||
*/
|
||
void start(size_t stack_size = 64000);
|
||
|
||
/**
|
||
* 获得本协程对象的 ID 号
|
||
* @return {int}
|
||
*/
|
||
int get_id(void) const;
|
||
|
||
/**
|
||
* 获得当前运行的协程对象的 ID 号
|
||
*/
|
||
static int self(void);
|
||
|
||
/**
|
||
* 获得当前协程在执行某个系统 API 出错时的错误号
|
||
* return {int}
|
||
*/
|
||
int get_errno(void) const;
|
||
|
||
/**
|
||
* 设置当前协程的错误号
|
||
* @param errnum {int}
|
||
*/
|
||
void set_errno(int errnum);
|
||
|
||
/**
|
||
* 启动协程运行的调度过程
|
||
*/
|
||
static void schedule(void);
|
||
|
||
/**
|
||
* 停止协程调度过程
|
||
*/
|
||
static void stop(void);
|
||
|
||
public:
|
||
/**
|
||
* 将当前正在运行的协程(即本协程) 挂起
|
||
*/
|
||
void yield(void);
|
||
|
||
/**
|
||
* 挂起当前协程，执行等待队列中的下一个协程
|
||
*/
|
||
void switch_to_next(void);
|
||
|
||
/**
|
||
* 将指定协程对象置入待运行队列中
|
||
* @param f {fiber&}
|
||
*/
|
||
static void ready(fiber& f);
|
||
|
||
/**
|
||
* 返回本协程对象对应的 C 语言的协程对象
|
||
* @return {ACL_FIBER *}
|
||
*/
|
||
ACL_FIBER *get_fiber(void) const;
|
||
|
||
/**
|
||
* 线程启动后调用此函数设置当前线程是否需要 hook 系统 API，内部缺省
|
||
* 会 hook 系统 API
|
||
* @param on {bool}
|
||
*/
|
||
static void hook_api(bool on);
|
||
|
||
protected:
|
||
/**
|
||
* 纯虚函数，子类必须实现本函数，当通过调用 start 方法启动协程后，本
|
||
* 虚函数将会被调用，从而通知子类
|
||
*/
|
||
virtual void run(void) = 0;
|
||
|
||
private:
|
||
ACL_FIBER *f_;
|
||
|
||
static void fiber_callback(ACL_FIBER *f, void *ctx);
|
||
};
|
||
|
||
} // namespace acl
|