doc/api.mdwn

   1 LuaEvent API Documentation
   2 ----
   3
   4 Modules:
   5
   6 * [[modules/luaevent.core]] - Interface to core libevent functions
   7         * [[modules/luaevent.core.buffer]] - Interface to libevent's evbuffer
   8         * [[modules/luaevent.core.bufferevent]] - Interface to libevent's bufferevent
   9 * [[modules/luaevent]] - Higher level wrapper mimicking [copas](http://www.luaforge.net/projects/copas)
  10
  11 Note: Any reference to a "File Descriptor" may in fact be one of the following:
  12
  13 * Integer value of file descriptor
  14 * lightuserdata 'handle' (cast to a native integer)
  15 * [LuaSocket](http://www.luaforge.net/projects/luasocket)-based socket handle