模块 coroutine

并发控制模块

coroutine 模块提供了一个用于控制 fiber 执行顺序的 API。它允许开发者手动切换 fiber，从而实现协作式多任务。coroutine 模块的一个重要的函数是 sleep 函数，它允许当前正在执行的 fiber 让出 CPU，让其他 fiber 运行。

以下是一个简单的示例代码，演示了如何使用 coroutine 模块：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
const coroutine = require('coroutine');

function foo() {
    console.log('start foo');
    coroutine.sleep(1000); // enter sleep mode
    console.log('end foo');
}

function bar() {
    console.log('start bar');
    coroutine.sleep(2000);
    console.log('end bar');
}

coroutine.start(foo);
coroutine.start(bar);

在上面的代码中，我们定义了两个函数 foo 和 bar，然后使用 coroutine.start 函数启动两个 fiber。在每个 fiber 中，我们使用 coroutine.sleep 函数来让出 CPU，让其他 fiber 运行。

对象

Lock

锁对象，参见 Lock

1
Lock coroutine.Lock;

---

Semaphore

信号量对象，参见 Semaphore

1
Semaphore coroutine.Semaphore;

---

Condition

条件变量对象，参见 Condition

1
Condition coroutine.Condition;

---

Event

事件对象，参见 Event

1
Event coroutine.Event;

---

Worker

独立线程工作对象，参见 Worker

1
Worker coroutine.Worker;

静态函数

start

启动一个纤程并返回纤程对象

1
2
static Fiber coroutine.start(Function func,
    ...args);

调用参数:

• func: Function, 制定纤程执行的函数
• args: ..., 可变参数序列，此序列会在纤程内传递给函数

返回结果:

• Fiber, 返回纤程对象

---

parallel

并行执行一组函数，并等待返回

1
2
static Array coroutine.parallel(Array funcs,
    Integer fibers = -1);

调用参数:

• funcs: Array, 并行执行的函数数组
• fibers: Integer, 限制并发 fiber 数量，缺省为 -1，启用与 funcs 数量相同 fiber

返回结果:

• Array, 返回函数执行结果的数组

---

并行执行一个函数处理一组数据，并等待返回

1
2
3
static Array coroutine.parallel(Array datas,
    Function func,
    Integer fibers = -1);

调用参数:

• datas: Array, 并行执行的数据数组
• func: Function, 并行执行的函数
• fibers: Integer, 限制并发 fiber 数量，缺省为 -1，启用与 datas 数量相同 fiber

返回结果:

• Array, 返回函数执行结果的数组

---

并行执行一个函数多次，并等待返回

1
2
3
static Array coroutine.parallel(Function func,
    Integer num,
    Integer fibers = -1);

调用参数:

• func: Function, 并行执行的函数数
• num: Integer, 重复任务数量
• fibers: Integer, 限制并发 fiber 数量，缺省为 -1，启用与 funcs 数量相同 fiber

返回结果:

• Array, 返回函数执行结果的数组

---

并行执行一组函数，并等待返回

1
static Array coroutine.parallel(...funcs);

调用参数:

• funcs: ..., 一组并行执行的函数

返回结果:

• Array, 返回函数执行结果的数组

---

current

返回当前纤程

1
static Fiber coroutine.current();

返回结果:

• Fiber, 当前纤程对象

---

sleep

暂停当前纤程指定的时间

1
static coroutine.sleep(Integer ms = 0) async;

调用参数:

• ms: Integer, 指定要暂停的时间，以毫秒为单位，缺省为 0，即有空闲立即回恢复运行

静态属性

fibers

Array, 返回当前正在运行的全部 fiber 数组

1
static readonly Array coroutine.fibers;

---

spareFibers

Integer, 查询和设置空闲 Fiber 数量，服务器抖动较大时可适度增加空闲 Fiber 数量。缺省为 256

1
static Integer coroutine.spareFibers;

---

vmid

Integer, 查询当前 vm 编号

1
static readonly Integer coroutine.vmid;

---

loglevel

Integer, 修改和查询本 vm 的输出级别，用以过滤输出信息，缺省为 console.NOTSET，全部输出

1
static Integer coroutine.loglevel;