# HG changeset patch
# User Thomas Harning Jr <harningt@gmail.com>
# Date 1195591223 18000
# Node ID a118240503149096d9528699f21198e2c2387862
# Parent  739e353c4e977fa06276d67a389be61d9658bb2e
doc: Update luaevent.core to contain docs on EV_* values

diff -r 739e353c4e97 -r a11824050314 doc/modules/luaevent.core.mdwn
--- a/doc/modules/luaevent.core.mdwn	Tue Nov 20 15:36:38 2007 -0500
+++ b/doc/modules/luaevent.core.mdwn	Tue Nov 20 15:40:23 2007 -0500
@@ -3,8 +3,25 @@
 
 * `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`