Tue, 20 Nov 2007 15:40:23 -0500
doc: Update luaevent.core to contain docs on EV_* values
48
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
1 | ---- |
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
2 | Constants: |
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
3 | |
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
4 | * `LEAVE` - When returned will cause event callback to be cancelled |
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
5 | * `EV_READ` |
51
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
6 | * Marks read readiness/event capture. |
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
7 | * Read readiness can also mean that an 'accept' operation will succeed, or |
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
8 | a disconnection on the other end is detected (read will return nothing). |
48
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
9 | * `EV_WRITE` |
51
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
10 | * Marks write readiness/event capture. |
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
11 | * Can also mark the successful completion of a non-blocking connect |
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
12 | if `SO_ERROR`@`SOL_SOCKET` is zero. |
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
13 | * `EV_SIGNAL` |
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
14 | * Marks signal received/event capture |
48
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
15 | * `EV_TIMEOUT` |
51
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
16 | * Timeout occurred while waiting for an event |
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
17 | * `EV_PERSIST` |
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
18 | * Marks an event as persistent and not one-shot |
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
19 | * `EV_*` |
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
20 | * Can be OR'd together to capture multiple events that make sense. |
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
21 | (Should not OR `EV_READ`/`EV_WRITE` with `EV_SIGNAL`) |
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
22 | * Can be received OR'd together. |
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
23 | For example: `EV_READ` | `EV_TIMEOUT` means that a timeout |
a11824050314
doc: Update luaevent.core to contain docs on EV_* values
Thomas Harning Jr <harningt@gmail.com>
parents:
48
diff
changeset
|
24 | occurred while waiting for a read event. |
48
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
25 | * `EVBUFFER_READ` |
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
26 | * `EVBUFFER_WRITE` |
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
27 | * `EVBUFFER_EOF` |
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
28 | * `EVBUFFER_ERROR` |
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
29 | * `EVBUFFER_TIMEOUT` |
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
30 | |
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
31 | Functions: |
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
32 | |
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
33 | [[toc levels=1]] |
7e1abd8cb4e8
docs: Beginning of luaevent.core documentation
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
34 |