doc/api.mdwn

Wed, 03 Mar 2010 18:19:20 -0600

author
James Snyder <jbsnyder@fanplastic.org>
date
Wed, 03 Mar 2010 18:19:20 -0600
changeset 101
f5369fe8f107
parent 49
f4d2c9dea3cc
permissions
-rw-r--r--

Changes to compile on OS X.

- BSD version of install doesn't have -D flag
- stdlib.h should include malloc defs (malloc.h is obsolete)

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