doc/api.mdwn

Sat, 15 Jan 2011 20:21:54 -0500

author
Thomas Harning Jr <harningt@gmail.com>
date
Sat, 15 Jan 2011 20:21:54 -0500
changeset 100
41a6f9a64b9e
parent 49
f4d2c9dea3cc
permissions
-rw-r--r--

base: noted in CHANGELOG pending 0.3.0 release

LuaEvent API Documentation
----

Modules:

* [[modules/luaevent.core]] - Interface to core libevent functions
	* [[modules/luaevent.core.buffer]] - Interface to libevent's evbuffer
	* [[modules/luaevent.core.bufferevent]] - Interface to libevent's bufferevent
* [[modules/luaevent]] - Higher level wrapper mimicking [copas](http://www.luaforge.net/projects/copas)

Note: Any reference to a "File Descriptor" may in fact be one of the following:

* Integer value of file descriptor
* lightuserdata 'handle' (cast to a native integer)
* [LuaSocket](http://www.luaforge.net/projects/luasocket)-based socket handle

mercurial