aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/modules/luaevent.core.mdwn17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/modules/luaevent.core.mdwn b/doc/modules/luaevent.core.mdwn
index 7408970..c5fa086 100644
--- a/doc/modules/luaevent.core.mdwn
+++ b/doc/modules/luaevent.core.mdwn
@@ -3,8 +3,25 @@ Constants:
* `LEAVE` - When returned will cause event callback to be cancelled
* `EV_READ`
+ * Marks read readiness/event capture.
+ * Read readiness can also mean that an 'accept' operation will succeed, or
+ a disconnection on the other end is detected (read will return nothing).
* `EV_WRITE`
+ * Marks write readiness/event capture.
+ * Can also mark the successful completion of a non-blocking connect
+ if `SO_ERROR`@`SOL_SOCKET` is zero.
+* `EV_SIGNAL`
+ * Marks signal received/event capture
* `EV_TIMEOUT`
+ * Timeout occurred while waiting for an event
+* `EV_PERSIST`
+ * Marks an event as persistent and not one-shot
+* `EV_*`
+ * Can be OR'd together to capture multiple events that make sense.
+ (Should not OR `EV_READ`/`EV_WRITE` with `EV_SIGNAL`)
+ * Can be received OR'd together.
+ For example: `EV_READ` | `EV_TIMEOUT` means that a timeout
+ occurred while waiting for a read event.
* `EVBUFFER_READ`
* `EVBUFFER_WRITE`
* `EVBUFFER_EOF`