event_set()

event_set - Prepare an event

Syntax

bool event_set (resource $event, resource $fd, int $events, mixed $callback, mixed $arg)

Arguments

• event - Valid event resource.
• fd - Valid PHP stream resource. The stream must be castable to file descriptor, so you most likely won\'t be able to use any of filtered streams.
• events - A set of flags indicating the desired event, can be EV_READ and/or EV_WRITE. The additional flag EV_PERSIST makes the event to persist until event_del() is called, otherwise the callback is invoked only once.
• callback - Callback function to be called when the matching event occurs.
• arg - Optional callback parameter.

Description

Prepares the event to be used in event_add(). The event is prepared to call the function specified by the callback on the events specified in parameter events, which is a set of the following flags: EV_TIMEOUT, EV_SIGNAL, EV_READ and EV_WRITE.

Version

PHP PECL libevent >= 0.0.1

Return value

event_set() returns TRUE on success or FALSE on error.