Mercurial > luaevent-prosody / annotate
doc/api.mdwn@e8e83eac4d9a (annotated)
doc/api.mdwn
Fri, 16 Nov 2007 11:26:01 -0500
- author
- Thomas Harning Jr <harningt@gmail.com>
- date
- Fri, 16 Nov 2007 11:26:01 -0500
- changeset 44
- e8e83eac4d9a
- parent 43
- f58b30ad545e
- child 46
- a9fc6b002e73
- permissions
- -rw-r--r--
docs: Refactored 'file descriptor' reference
|
43
f58b30ad545e
Added initial shot at documentation using Ikiwiki (only luaevent.core.buffer is really doc'ed yet)
Thomas Harning Jr <harningt@gmail.com>
parents:
diff
changeset
|
1 | LuaEvent API Documentation |
|
f58b30ad545e
Added initial shot at documentation using Ikiwiki (only luaevent.core.buffer is really doc'ed yet)
Thomas Harning Jr <harningt@gmail.com>
parents:
diff
changeset
|
2 | ---- |
|
f58b30ad545e
Added initial shot at documentation using Ikiwiki (only luaevent.core.buffer is really doc'ed yet)
Thomas Harning Jr <harningt@gmail.com>
parents:
diff
changeset
|
3 | |
|
f58b30ad545e
Added initial shot at documentation using Ikiwiki (only luaevent.core.buffer is really doc'ed yet)
Thomas Harning Jr <harningt@gmail.com>
parents:
diff
changeset
|
4 | Modules: |
|
f58b30ad545e
Added initial shot at documentation using Ikiwiki (only luaevent.core.buffer is really doc'ed yet)
Thomas Harning Jr <harningt@gmail.com>
parents:
diff
changeset
|
5 | |
|
f58b30ad545e
Added initial shot at documentation using Ikiwiki (only luaevent.core.buffer is really doc'ed yet)
Thomas Harning Jr <harningt@gmail.com>
parents:
diff
changeset
|
6 | * [[modules/luaevent.core]] - Interface to core libevent functions |
|
f58b30ad545e
Added initial shot at documentation using Ikiwiki (only luaevent.core.buffer is really doc'ed yet)
Thomas Harning Jr <harningt@gmail.com>
parents:
diff
changeset
|
7 | * [[modules/luaevent.core.buffer]] - Interface to libevent's evbuffer |
|
f58b30ad545e
Added initial shot at documentation using Ikiwiki (only luaevent.core.buffer is really doc'ed yet)
Thomas Harning Jr <harningt@gmail.com>
parents:
diff
changeset
|
8 | * [[modules/luaevent.core.bufferevent]] - Interface to libevent's bufferevent |
|
f58b30ad545e
Added initial shot at documentation using Ikiwiki (only luaevent.core.buffer is really doc'ed yet)
Thomas Harning Jr <harningt@gmail.com>
parents:
diff
changeset
|
9 | * [[modules/luaevent]] - Higher level wrapper mimicking [copas](http://www.luaforge.net/projects/copas) |
|
44
e8e83eac4d9a
docs: Refactored 'file descriptor' reference
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
10 | |
|
e8e83eac4d9a
docs: Refactored 'file descriptor' reference
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
11 | Note: Any reference to a "File Descriptor" may in fact be one of the following: |
|
e8e83eac4d9a
docs: Refactored 'file descriptor' reference
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
12 | * Integer value of file descriptor |
|
e8e83eac4d9a
docs: Refactored 'file descriptor' reference
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
13 | * lightuserdata 'handle' (cast to a native integer) |
|
e8e83eac4d9a
docs: Refactored 'file descriptor' reference
Thomas Harning Jr <harningt@gmail.com>
parents:
43
diff
changeset
|
14 | * [LuaSocket](http://www.luaforge.net/projects/luasocket)-based socket handle |
