Mercurial > luaevent-prosody / annotate

doc/api.mdwn@dd47dbe85bec (annotated)

doc/api.mdwn

Wed, 15 Jul 2009 10:39:10 -0400

author
Thomas Harning Jr <harningt@gmail.com>
date
Wed, 15 Jul 2009 10:39:10 -0400
changeset 64
dd47dbe85bec
parent 49
f4d2c9dea3cc
permissions
-rw-r--r--

Merge branch 'v0.2'

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:
46
a9fc6b002e73 docs: Fixed formatting glitches
Thomas Harning Jr <harningt@gmail.com>
parents: 44
diff changeset
12
44
e8e83eac4d9a docs: Refactored 'file descriptor' reference
Thomas Harning Jr <harningt@gmail.com>
parents: 43
diff changeset
13 * Integer value of file descriptor
e8e83eac4d9a docs: Refactored 'file descriptor' reference
Thomas Harning Jr <harningt@gmail.com>
parents: 43
diff changeset
14 * lightuserdata 'handle' (cast to a native integer)
49
f4d2c9dea3cc Added newline at end-of-file for API doc page
Thomas Harning Jr <harningt@gmail.com>
parents: 46
diff changeset
15 * [LuaSocket](http://www.luaforge.net/projects/luasocket)-based socket handle

Mercurial Repository: luaevent-prosody

mercurial