Mercurial > luaevent-prosody / changeset

--- a/doc/api.mdwn	Fri Nov 16 11:22:01 2007 -0500
+++ b/doc/api.mdwn	Fri Nov 16 11:26:01 2007 -0500
@@ -7,3 +7,8 @@
 	* [[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
\ No newline at end of file

--- a/doc/modules/luaevent.core.buffer.mdwn	Fri Nov 16 11:22:01 2007 -0500
+++ b/doc/modules/luaevent.core.buffer.mdwn	Fri Nov 16 11:26:01 2007 -0500
@@ -27,17 +27,16 @@
 
 ## buffer:read
 * Reads data from a file-descriptor/socket into the buffer directly
-* Input: `(integer/lightuserdata fd OR socket, length)`
-	* `fd` - File descriptor as integer or lightuserdata 'handle' (cast to a native integer)
-	* `socket` - [LuaSocket](http://www.luaforge.net/projects/luasocket)-based socket handle
+* Input: `(fd, length)`
+	* `fd` - File descriptor to read from
 	* `length` - Amount of data to attempt to read into the buffer
 * Output: Length of data actually read into the buffer
 * Side Effects: fd/socket 'drain'ed of data
 
 ## buffer:write
 * Attempts to write out all buffer's data to a file-descriptor/socket
-* Input: `(integer/lightuserdata fd OR socket, length)`
-	* `fd` - File descriptor as integer or lightuserdata 'handle' (cast to a native integer)
+* Input: `(fd, length)`
+	* `fd` - File descriptor to write to
 	* `socket` - [LuaSocket](http://www.luaforge.net/projects/luasocket)-based socket handle
 * Output: Amount of data written
 * Side Effects: buffer 'drain'ed of written data