aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorThomas Harning Jr <harningt@gmail.com>2007-11-16 11:26:01 -0500
committerThomas Harning Jr <harningt@gmail.com>2007-11-16 11:26:01 -0500
commite6cd4237c13564492e42b0bcaed8e4307be54e2b (patch)
tree0fd60468307ef9b329cb122790dd40a9fe762bc9 /doc
parent73478948f9950cdca67f6ac57069bdd74ec94762 (diff)
downloadluaevent-prosody-e6cd4237c13564492e42b0bcaed8e4307be54e2b.tar.gz
luaevent-prosody-e6cd4237c13564492e42b0bcaed8e4307be54e2b.zip
docs: Refactored 'file descriptor' reference
Diffstat (limited to 'doc')
-rw-r--r--doc/api.mdwn5
-rw-r--r--doc/modules/luaevent.core.buffer.mdwn9
2 files changed, 9 insertions, 5 deletions
diff --git a/doc/api.mdwn b/doc/api.mdwn
index aa528d4..85d572a 100644
--- a/doc/api.mdwn
+++ b/doc/api.mdwn
@@ -7,3 +7,8 @@ Modules:
* [[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
diff --git a/doc/modules/luaevent.core.buffer.mdwn b/doc/modules/luaevent.core.buffer.mdwn
index 4b2eac4..e2782a7 100644
--- a/doc/modules/luaevent.core.buffer.mdwn
+++ b/doc/modules/luaevent.core.buffer.mdwn
@@ -27,17 +27,16 @@ Functions:
## 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