yev_stop_event()
#
yev_stop_event()
stops the specified event, ensuring that its associated file descriptor is closed if applicable. This operation is idempotent, meaning it can be called multiple times without adverse effects.
Prototype
int yev_stop_event(
yev_event_h yev_event
);
Parameters
Key |
Type |
Description |
---|---|---|
|
|
Handle to the event that should be stopped. |
Return Value
Returns 0
on success, or -1
if an error occurs.
Notes
If the event is a connect
, timer
, or accept
event, the associated socket will be closed.
If the event is in an idle state, it can be reused; otherwise, a new event must be created.
Prototype
// Not applicable in JS
Prototype
# Not applicable in Python
Examples
// TODO C examples
// TODO JS examples
# TODO Python examples