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

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