diff options
author | Diego Nehab <diego@tecgraf.puc-rio.br> | 2005-08-12 05:56:32 +0000 |
---|---|---|
committer | Diego Nehab <diego@tecgraf.puc-rio.br> | 2005-08-12 05:56:32 +0000 |
commit | 0c3cdd5ef2485a79d6fec9261f2850c41577d5b3 (patch) | |
tree | d69164c9f815e2d0308ba3f0d15b18e67163d879 /doc/tcp.html | |
parent | 37f7af4b9f1250e3c3439df03d43cf291a4d6f37 (diff) | |
download | luasocket-0c3cdd5ef2485a79d6fec9261f2850c41577d5b3.tar.gz luasocket-0c3cdd5ef2485a79d6fec9261f2850c41577d5b3.tar.bz2 luasocket-0c3cdd5ef2485a79d6fec9261f2850c41577d5b3.zip |
Final push for release...
Diffstat (limited to 'doc/tcp.html')
-rw-r--r-- | doc/tcp.html | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/doc/tcp.html b/doc/tcp.html index ae8efd5..5c810de 100644 --- a/doc/tcp.html +++ b/doc/tcp.html | |||
@@ -79,7 +79,7 @@ reported by <b><tt>nil</tt></b> followed by a message describing the error. | |||
79 | <p class=note> | 79 | <p class=note> |
80 | Note: calling <a href=socket.html#select><tt>socket.select</tt></a> | 80 | Note: calling <a href=socket.html#select><tt>socket.select</tt></a> |
81 | with a server object in | 81 | with a server object in |
82 | the <tt>receive</tt> parameter before a call to <tt>accept</tt> does | 82 | the <tt>recvt</tt> parameter before a call to <tt>accept</tt> does |
83 | <em>not</em> guarantee <tt>accept</tt> will return immediately. Use the <a | 83 | <em>not</em> guarantee <tt>accept</tt> will return immediately. Use the <a |
84 | href=#settimeout><tt>settimeout</tt></a> method or <tt>accept</tt> | 84 | href=#settimeout><tt>settimeout</tt></a> method or <tt>accept</tt> |
85 | might block until <em>another</em> client shows up. | 85 | might block until <em>another</em> client shows up. |
@@ -111,7 +111,7 @@ method returns <b><tt>nil</tt></b> followed by an error message. | |||
111 | 111 | ||
112 | <p class=note> | 112 | <p class=note> |
113 | Note: The function <a href=socket.html#bind><tt>socket.bind</tt></a> | 113 | Note: The function <a href=socket.html#bind><tt>socket.bind</tt></a> |
114 | is available and is a shortcut for the creation server sockets. | 114 | is available and is a shortcut for the creation of server sockets. |
115 | </p> | 115 | </p> |
116 | 116 | ||
117 | <!-- close ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 117 | <!-- close ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
@@ -173,8 +173,11 @@ is available and is a shortcut for the creation of client sockets. | |||
173 | <p class=note> | 173 | <p class=note> |
174 | Note: Starting with LuaSocket 2.0, | 174 | Note: Starting with LuaSocket 2.0, |
175 | the <a href=#settimeout><tt>settimeout</tt></a> | 175 | the <a href=#settimeout><tt>settimeout</tt></a> |
176 | method affects the behavior of connect, causing it to return in case of | 176 | method affects the behavior of <tt>connect</tt>, causing it to return |
177 | a timeout. | 177 | with an error in case of a timeout. If that happens, you can still call <a |
178 | href=socket.html#select><tt>socket.select</tt></a> with the socket in the | ||
179 | <tt>sendt</tt> table. The socket will be writable when the connection is | ||
180 | stablished. | ||
178 | </p> | 181 | </p> |
179 | 182 | ||
180 | <!-- getpeername ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 183 | <!-- getpeername ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
@@ -328,11 +331,11 @@ substring to be sent. | |||
328 | </p> | 331 | </p> |
329 | 332 | ||
330 | <p class=return> | 333 | <p class=return> |
331 | If successful, the method returns the number of bytes accepted by | 334 | If successful, the method returns the number of bytes sent. |
332 | the transport layer. In case of error, the method returns | 335 | In case of error, the method returns |
333 | <b><tt>nil</tt></b>, followed by an error message, followed by the | 336 | <b><tt>nil</tt></b>, followed by an error message, followed by the |
334 | partial number of bytes accepted by the transport layer. | 337 | index of the first character within <tt>[i, j]</tt> that has not been sent yet |
335 | The error message can be '<tt>closed</tt>' in case | 338 | (you might want to try again from then on). The error message can be '<tt>closed</tt>' in case |
336 | the connection was closed before the transmission was completed or the | 339 | the connection was closed before the transmission was completed or the |
337 | string '<tt>timeout</tt>' in case there was a timeout during the | 340 | string '<tt>timeout</tt>' in case there was a timeout during the |
338 | operation. | 341 | operation. |
@@ -433,7 +436,7 @@ of bandwidth. | |||
433 | <p class=parameters> | 436 | <p class=parameters> |
434 | <tt>Received</tt> is a number with the new number of bytes received. | 437 | <tt>Received</tt> is a number with the new number of bytes received. |
435 | <tt>Sent</tt> is a number with the new number of bytes sent. | 438 | <tt>Sent</tt> is a number with the new number of bytes sent. |
436 | <tt>Age</tt> is the new age in seconds</tt> | 439 | <tt>Age</tt> is the new age in seconds. |
437 | </p> | 440 | </p> |
438 | 441 | ||
439 | <p class=return> | 442 | <p class=return> |