Coroutine\Scheduler

?> 所有的协程必须在协程容器里面创建，Swoole程序启动的时候大部分情况会自动创建协程容器，用Swoole启动程序的方式一共有三种：

• 调用异步风格服务端程序的start方法，此种启动方式会在事件回调中创建协程容器，参考enable_coroutine。
• 调用Swoole提供的2个进程管理模块Process和Process\Pool的start方法，此种启动方式会在进程启动的时候创建协程容器，参考这两个模块构造函数的enable_coroutine参数。
• 其他直接裸写协程的方式启动程序，需要先创建一个协程容器(Co\run()函数，可以理解为java、c的main函数)，例如：

• 启动一个全协程HTTP服务

Co\run(function () {
    $server = new Co\Http\Server("127.0.0.1", 9502, false);
    $server->handle('/', function ($request, $response) {
        $response->end("<h1>Index</h1>");
    });
    $server->handle('/test', function ($request, $response) {
        $response->end("<h1>Test</h1>");
    });
    $server->handle('/stop', function ($request, $response) use ($server) {
        $response->end("<h1>Stop</h1>");
        $server->shutdown();
    });
    $server->start();
});
echo 1;//得不到执行

• 添加2个协程并发的做一些事情

Co\run(function () {
    go(function() {
        var_dump(file_get_contents("http://www.xinhuanet.com/"));
    });

    go(function() {
        Co::sleep(1);
        echo "done\n";
    });
});
echo 1;//可以得到执行

!> 在Swoole v4.4+版本可用。

!> 不可以嵌套Co\run()。
Co\run()里面的逻辑如果有未处理的事件在Co\run()之后就进行EventLoop，后面的代码将得不到执行，反之，如果没有事件了将继续向下执行，可以再次Co\run()。

上文的Co\run()函数其实是对Swoole\Coroutine\Scheduler类(协程调度器类)的封装，想了解细节的同学可以看Swoole\Coroutine\Scheduler的方法：

set()

?> 设置协程运行时参数。

?> 是Coroutine::set方法的别名。请参考 Coroutine::set 文档

Swoole\Coroutine\Scheduler->set(array $options): bool;

• 示例

$sch = new Co\Scheduler;
$sch->set(['max_coroutine' => 100]);

add()

?> 添加任务。

Swoole\Coroutine\Scheduler->add(callable $fn, ... $args): bool;

• 参数

  • callable $fn

    • 功能：回调函数
    • 默认值：无
    • 其它值：无

  • ... $args

    • 功能：可选参数，将传递给协程
    • 默认值：无
    • 其它值：无

• 示例

$scheduler = new Swoole\Coroutine\Scheduler;
$scheduler->add(function ($a, $b) {
    Co::sleep(1);
    echo assert($a == 'hello') . PHP_EOL;
    echo assert($b == 12345) . PHP_EOL;
    echo "Done.\n";
}, "hello", 12345);

$scheduler->start();

• 注意

  !> 与go函数不同，这里添加的协程不会立即执行，而是等待调用start方法时，一起启动并执行。如果程序中仅添加了协程，未调用start启动，协程函数$fn将不会被执行。

parallel()

?> 添加并行任务。

?> 与add方法不同，parallel方法会创建并行协程。在start时会同时启动$num个$fn协程，并行地执行。

Swoole\Coroutine\Scheduler->parallel(int $num, callable $fn, ... $args): bool;

• 参数

  • int $num

    • 功能：启动协程的个数
    • 默认值：无
    • 其它值：无

  • callable $fn

    • 功能：回调函数
    • 默认值：无
    • 其它值：无

  • ... $args

    • 功能：可选参数，将传递给协程
    • 默认值：无
    • 其它值：无

• 示例

$sch = new Swoole\Coroutine\Scheduler;

$sch->parallel(10, function ($t, $n) {
    Co::sleep($t);
    echo "Co ".Co::getCid()."\n";
}, 0.05, 'A');

$sch->start();

start()

?> 启动程序。

?> 遍历add和parallel方法添加的协程任务，并执行。

Swoole\Coroutine\Scheduler->start(): bool;

• 返回值

  • 启动成功，会执行所有添加的任务，所有协程退出时start会返回true
  • 启动失败返回false，原因可能是已经启动了或者已经创建了其他调度器无法再次创建