EVENT_SET(3) 1 EVENT_SET(3)
event_set - Prepare an event
SYNOPSIS
bool event_set (resource $event, mixed $fd, int $events, mixed $callback, [mixed $arg])
DESCRIPTION
Prepares the event to be used in event_add(3). The event is prepared to call the function specified by the $callback on the events speci-
fied in parameter $events, which is a set of the following flags: EV_TIMEOUT, EV_SIGNAL, EV_READ, EV_WRITE and EV_PERSIST.
If EV_SIGNAL bit is set in parameter $events, the $fd is interpreted as signal number.
After initializing the event, use event_base_set(3) to associate the event with its event base.
In case of matching event, these three arguments are passed to the $callback function:
o $fd
- Signal number or resource indicating the stream.
o $events
- A flag indicating the event. Consists of the following flags: EV_TIMEOUT, EV_SIGNAL, EV_READ, EV_WRITE and EV_PERSIST.
o $arg
- Optional parameter, previously passed to event_set(3) as $arg.
PARAMETERS
o $event
- Valid event resource.
o $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 fil-
tered streams.
o $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(3) is called, otherwise the callback is invoked only once.
o $callback
- Callback function to be called when the matching event occurs.
o $arg
- Optional callback parameter.
RETURN VALUES
event_set(3) returns TRUE on success or FALSE on error.
CHANGELOG
+--------+------------------------------+
|Version | |
| | |
| | Description |
| | |
+--------+------------------------------+
| 0.0.4 | |
| | |
| | |
| | EV_SIGNAL support was added. |
| | |
+--------+------------------------------+
PHP Documentation Group EVENT_SET(3)
