final class EvFork extends EvWatcher (View source)

Class EvFork

Fork watchers are called when a fork() was detected (usually because whoever signalled libev about it by calling EvLoop::fork()). The invocation is done before the event loop blocks next and before EvCheck watchers are being called, and only in the child after the fork. Note that if someone calls EvLoop::fork() in the wrong process, the fork handlers will be invoked, too.

Properties

bool $is_active from  EvWatcher
bool $is_pending from  EvWatcher
mixed $data from  EvWatcher
int $priority from  EvWatcher

Methods

__construct(EvLoop $loop, mixed $callback, mixed $data = null, int $priority = 0)

Constructs an EvFork instance.

int
clear()

Clear watcher pending status.

feed(int $revents)

Feeds the given revents set into the event loop.

getLoop()

Returns the loop responsible for the watcher.

invoke(int $revents)

Invokes the watcher callback with the given received events bit mask.

keepalive(bool $value = true)

Configures whether to keep the loop from returning.

setCallback(callable $callback)

Sets new callback for the watcher.

start()

Starts the watcher.

stop()

Stops the watcher.

static EvFork
createStopped(EvLoop $loop, mixed $callback, mixed $data = null, int $priority = 0)

Creates a stopped EvFork instance.

Details

__construct(EvLoop $loop, mixed $callback, mixed $data = null, int $priority = 0)

Constructs an EvFork instance.

Parameters

EvLoop $loop
mixed $callback
mixed $data
int $priority

int clear()

Clear watcher pending status.

If the watcher is pending, this method clears its pending status and returns its revents bitset (as if its callback was invoked). If the watcher isn't pending it does nothing and returns 0.

Sometimes it can be useful to "poll" a watcher instead of waiting for its callback to be invoked, which can be accomplished with this function.

Return Value

int

In case if the watcher is pending, returns revents bitset as if the watcher callback had been invoked. Otherwise returns 0 .

feed(int $revents)

Feeds the given revents set into the event loop.

Feeds the given revents set into the event loop, as if the specified event had happened for the watcher.

Parameters

int $revents

Bit mask of watcher received events.

EvLoop getLoop()

Returns the loop responsible for the watcher.

Return Value

EvLoop

Event loop object responsible for the watcher.

invoke(int $revents)

Invokes the watcher callback with the given received events bit mask.

Parameters

int $revents

Bit mask of watcher received events.

keepalive(bool $value = true)

Configures whether to keep the loop from returning.

Configures whether to keep the loop from returning. With keepalive value set to FALSE the watcher won't keep Ev::run() / EvLoop::run() from returning even though the watcher is active.

Watchers have keepalive value TRUE by default.

Clearing keepalive status is useful when returning from Ev::run() / EvLoop::run() just because of the watcher is undesirable. It could be a long running UDP socket watcher or so.

Parameters

bool $value

With keepalive value set to FALSE the watcher won't keep Ev::run() / EvLoop::run() from returning even though the watcher is active.

setCallback(callable $callback)

Sets new callback for the watcher.

Parameters

callable $callback

void callback ([ object $watcher = NULL [, int $revents = NULL ]] )

start()

Starts the watcher.

Marks the watcher as active. Note that only active watchers will receive events.

stop()

Stops the watcher.

Marks the watcher as inactive. Note that only active watchers will receive events.

final static EvFork createStopped(EvLoop $loop, mixed $callback, mixed $data = null, int $priority = 0)

Creates a stopped EvFork instance.

Parameters

EvLoop $loop
mixed $callback
mixed $data
int $priority

Return Value

EvFork