1. class
  2. Swoole
  3. \
  4. Coroutine

Coroutine

class Coroutine (View source)

Methods

static mixed
create(callable $func, ...$params)

No description

static mixed
defer(mixed $callback)

No description

static void
set(array $options)

To set runtime configurations of coroutines.

static array|null
getOptions()

To get runtime configurations of coroutines.

static mixed
exists(mixed $cid)

No description

static mixed
yield()

No description

static mixed
cancel(mixed $cid)

No description

static bool
join(array $cid_array, int $timeout = -1)

Waits for a list of coroutines to finish.

static mixed
isCanceled()

No description

static mixed
suspend()

No description

static mixed
resume(mixed $cid)

No description

static mixed
stats()

No description

static mixed
getCid()

No description

static mixed
getuid()

No description

static mixed
getPcid(mixed|null $cid = null)

No description

static mixed
getContext(mixed|null $cid = null)

No description

static mixed
getBackTrace(mixed|null $cid = null, mixed|null $options = null, mixed|null $limit = null)

No description

static mixed
printBackTrace(mixed|null $cid = null, mixed|null $options = null, mixed|null $limit = null)

No description

static mixed
getElapsed(mixed|null $cid = null)

No description

static int|false
getStackUsage(int $cid = null)

Get memory usage of a coroutine.

static mixed
list()

No description

static mixed
listCoroutines()

No description

static mixed
enableScheduler()

No description

static mixed
disableScheduler()

No description

static mixed
gethostbyname(mixed $domain_name, mixed|null $family = null, mixed|null $timeout = null)

No description

static mixed
dnsLookup(mixed $domain_name, mixed|null $timeout = null, mixed|null $type = null)

No description

static mixed
exec(mixed $command, mixed|null $get_error_stream = null)

No description

static mixed
sleep(mixed $seconds)

No description

static mixed
getaddrinfo(mixed $hostname, mixed|null $family = null, mixed|null $socktype = null, mixed|null $protocol = null, mixed|null $service = null, mixed|null $timeout = null)

No description

static mixed
statvfs(mixed $path)

No description

static mixed
readFile(mixed $filename)

No description

static mixed
writeFile(mixed $filename, mixed $data, mixed|null $flags = null)

No description

static mixed
wait(mixed|null $timeout = null)

No description

static mixed
waitPid(mixed $pid, mixed|null $timeout = null)

No description

static mixed
waitSignal(mixed $signo, mixed|null $timeout = null)

No description

static mixed
waitEvent(mixed $fd, mixed|null $events = null, mixed|null $timeout = null)

No description

static mixed
fread(mixed $handle, mixed|null $length = null)

No description

static mixed
fgets(mixed $handle)

No description

static mixed
fwrite(mixed $handle, mixed $string, mixed|null $length = null)

No description

Details

at line 12
static mixed create(callable $func, ...$params)

No description

Parameters

callable $func
...$params

Return Value

mixed

at line 18
static mixed defer(mixed $callback)

No description

Parameters

mixed $callback

Return Value

mixed

at line 25
static void set(array $options)

To set runtime configurations of coroutines.

Parameters

array $options

Return Value

void

at line 32
static array|null getOptions()

To get runtime configurations of coroutines.

Return Value

array|null

at line 38
static mixed exists(mixed $cid)

No description

Parameters

mixed $cid

Return Value

mixed

at line 43
static mixed yield()

No description

Return Value

mixed

at line 49
static mixed cancel(mixed $cid)

No description

Parameters

mixed $cid

Return Value

mixed

at line 64
static bool join(array $cid_array, int $timeout = -1)

Since: 4.8.0

Waits for a list of coroutines to finish.

This method is similar to class \Swoole\Coroutine\WaitGroup and \Swoole\Coroutine\Barrier. They are different implementations of the same functionality.

Parameters

array $cid_array

An array of coroutines.
int $timeout

Return Value

bool

TRUE if succeeds; otherwise FALSE.

See also

WaitGroup
Barrier

at line 69
static mixed isCanceled()

No description

Return Value

mixed

at line 74
static mixed suspend()

No description

Return Value

mixed

at line 80
static mixed resume(mixed $cid)

No description

Parameters

mixed $cid

Return Value

mixed

at line 85
static mixed stats()

No description

Return Value

mixed

at line 90
static mixed getCid()

No description

Return Value

mixed

at line 95
static mixed getuid()

No description

Return Value

mixed

at line 101
static mixed getPcid(mixed|null $cid = null)

No description

Parameters

mixed|null $cid

Return Value

mixed

at line 107
static mixed getContext(mixed|null $cid = null)

No description

Parameters

mixed|null $cid

Return Value

mixed

at line 115
static mixed getBackTrace(mixed|null $cid = null, mixed|null $options = null, mixed|null $limit = null)

No description

Parameters

mixed|null $cid
mixed|null $options
mixed|null $limit

Return Value

mixed

at line 123
static mixed printBackTrace(mixed|null $cid = null, mixed|null $options = null, mixed|null $limit = null)

No description

Parameters

mixed|null $cid
mixed|null $options
mixed|null $limit

Return Value

mixed

at line 129
static mixed getElapsed(mixed|null $cid = null)

No description

Parameters

mixed|null $cid

Return Value

mixed

at line 138
static int|false getStackUsage(int $cid = null)

Since: 4.8.0

Get memory usage of a coroutine.

Parameters

int $cid

If this parameter is not passed in, current coroutine ID will be used.

Return Value

int|false

Memory usage of the coroutine; FALSE if the specified coroutine doesn't exist.

at line 143
static mixed list()

No description

Return Value

mixed

at line 148
static mixed listCoroutines()

No description

Return Value

mixed

at line 153
static mixed enableScheduler()

No description

Return Value

mixed

at line 158
static mixed disableScheduler()

No description

Return Value

mixed

at line 166
static mixed gethostbyname(mixed $domain_name, mixed|null $family = null, mixed|null $timeout = null)

No description

Parameters

mixed $domain_name
mixed|null $family
mixed|null $timeout

Return Value

mixed

at line 174
static mixed dnsLookup(mixed $domain_name, mixed|null $timeout = null, mixed|null $type = null)

No description

Parameters

mixed $domain_name
mixed|null $timeout
mixed|null $type

Return Value

mixed

at line 181
static mixed exec(mixed $command, mixed|null $get_error_stream = null)

No description

Parameters

mixed $command
mixed|null $get_error_stream

Return Value

mixed

at line 187
static mixed sleep(mixed $seconds)

No description

Parameters

mixed $seconds

Return Value

mixed

at line 198
static mixed getaddrinfo(mixed $hostname, mixed|null $family = null, mixed|null $socktype = null, mixed|null $protocol = null, mixed|null $service = null, mixed|null $timeout = null)

No description

Parameters

mixed $hostname
mixed|null $family
mixed|null $socktype
mixed|null $protocol
mixed|null $service
mixed|null $timeout

Return Value

mixed

at line 204
static mixed statvfs(mixed $path)

No description

Parameters

mixed $path

Return Value

mixed

at line 210
static mixed readFile(mixed $filename)

No description

Parameters

mixed $filename

Return Value

mixed

at line 218
static mixed writeFile(mixed $filename, mixed $data, mixed|null $flags = null)

No description

Parameters

mixed $filename
mixed $data
mixed|null $flags

Return Value

mixed

at line 224
static mixed wait(mixed|null $timeout = null)

No description

Parameters

mixed|null $timeout

Return Value

mixed

at line 231
static mixed waitPid(mixed $pid, mixed|null $timeout = null)

No description

Parameters

mixed $pid
mixed|null $timeout

Return Value

mixed

at line 238
static mixed waitSignal(mixed $signo, mixed|null $timeout = null)

No description

Parameters

mixed $signo
mixed|null $timeout

Return Value

mixed

at line 246
static mixed waitEvent(mixed $fd, mixed|null $events = null, mixed|null $timeout = null)

No description

Parameters

mixed $fd
mixed|null $events
mixed|null $timeout

Return Value

mixed

at line 253
static mixed fread(mixed $handle, mixed|null $length = null)

No description

Parameters

mixed $handle
mixed|null $length

Return Value

mixed

at line 259
static mixed fgets(mixed $handle)

No description

Parameters

mixed $handle

Return Value

mixed

at line 267
static mixed fwrite(mixed $handle, mixed $string, mixed|null $length = null)

No description

Parameters

mixed $handle
mixed $string
mixed|null $length

Return Value

mixed