OpenSwoole\Coroutine::set

Coroutine Configuration Options

When running a OpenSwoole HTTP Server or using coroutines within a container context, you can set a range of configuration options to dictate how OpenSwoole should operate with coroutines.

Coroutines have configuration options and these options can be set in a few different ways, depending on how you are using OpenSwoole. If you are running a OpenSwoole HTTP server you should be using OpenSwoole\Coroutine::set() before you start your server to change any default coroutine options.

You can set coroutine options within your $server->set() method but this is not recommended and will end up overwriting any changes set by OpenSwoole\Coroutine::set(). For any server configuration (TCP or HTTP), you should do this from the server classes and for any coroutine configuration, you should only be using OpenSwoole\Coroutine::set().

Also consider that you don't need to run a OpenSwoole server of any kind in order to use coroutines, you can simply use them directly inside a PHP file without a server running, you just need to wrap them inside a coroutine container context, which we are going to explore next...

Configuration Example

Before you use any coroutines you can use OpenSwoole\Coroutine::set(array $options) to change default options:

<?php
$options = [
    'max_concurrency' => 0,
    'max_coroutine' => 4096,
    'stack_size' => 2 * 1024 * 1024,
    'socket_connect_timeout' => 1,
    'socket_timeout' => -1,
    'socket_read_timeout' => -1,
    'socket_write_timeout' => -1,
    'log_level' => OpenSwoole\Constant::LOG_INFO,
    'hook_flags' => OpenSwoole\Runtime::HOOK_ALL,
    'trace_flags' => OpenSwoole\Constant::TRACE_ALL,
    'dns_cache_expire' => 60,
    'dns_cache_capacity' => 1000,
    'dns_server' => '8.8.8.8',
    'display_errors' => false,
    'aio_core_worker_num' => 10,
    'aio_worker_num' => 10,
    'aio_max_wait_time' => 1,
    'aio_max_idle_time' => 1,
    'exit_condition' => function() {
        return OpenSwoole\Coroutine::stats()['coroutine_num'] === 0;
    },
];

OpenSwoole\Coroutine::set($options);

...

Coroutine Options with a Server

If you are using a OpenSwoole server of any kind and you want to change default coroutine options, you can use OpenSwoole\Coroutine::set() to do this, it is only recommended to be done before you start your server.

<?php

// Set coroutine options before you start a server...
OpenSwoole\Coroutine::set([
        'max_coroutine' => 800,
]);

$server = new OpenSwoole\HTTP\Server("127.0.0.1", 9501);

/*
 * If this was not a comment, then the max_coroutine option
 * would be overwritten and is not recommended, use the
 * specific coroutine set method to change coroutine
 * options and use the server set method for server
 * options only.
 *
 */
$server->set([
    //'max_coroutine' => 100,
]);

$server->on("Start", function (OpenSwoole\Http\Server $server)
{
    echo "OpenSwoole HTTP server  started at http://127.0.0.1:9501\n";

    // Show Server settings
    var_dump('Server Settings: ', $server->setting);

    // Show Coroutine options
    var_dump('Coroutine Options: ', OpenSwoole\Coroutine::getOptions());
});

...

$server->start();

You can change coroutine options on the fly, although it is not recommended, it is possible. Some options can only be set once at the beginning. The OpenSwoole hook_flags options can be changed on the fly throughout a process or server lifetime.

Configuration Overview