diff options
| author | Diego Nehab <diego@tecgraf.puc-rio.br> | 2004-01-24 02:47:24 +0000 |
|---|---|---|
| committer | Diego Nehab <diego@tecgraf.puc-rio.br> | 2004-01-24 02:47:24 +0000 |
| commit | 62a4c505e488c714e8795ea85564504562d30301 (patch) | |
| tree | f270f53f26905b7275cea172e52ebc269a41c695 /doc/tcp.html | |
| parent | 0c9f420a3549df3fb331bb24157b65a3301641d4 (diff) | |
| download | luasocket-62a4c505e488c714e8795ea85564504562d30301.tar.gz luasocket-62a4c505e488c714e8795ea85564504562d30301.tar.bz2 luasocket-62a4c505e488c714e8795ea85564504562d30301.zip | |
Working on the manual...
Making better tests for error messages.
Changed a few names.
Moved gethostname to inet.c.
Diffstat (limited to 'doc/tcp.html')
| -rw-r--r-- | doc/tcp.html | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/tcp.html b/doc/tcp.html index 0be535a..eb4cdfa 100644 --- a/doc/tcp.html +++ b/doc/tcp.html | |||
| @@ -51,7 +51,7 @@ method.</p> | |||
| 51 | 51 | ||
| 52 | <p class=return> | 52 | <p class=return> |
| 53 | In case of success, a new master object is returned. In case of error, | 53 | In case of success, a new master object is returned. In case of error, |
| 54 | <tt>nil</tt> is returned, followed by an error message. | 54 | <b><tt>nil</tt></b> is returned, followed by an error message. |
| 55 | </p> | 55 | </p> |
| 56 | 56 | ||
| 57 | <!-- accept +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 57 | <!-- accept +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| @@ -67,7 +67,7 @@ object and returns a client object representing that connection. | |||
| 67 | 67 | ||
| 68 | <p class=return> | 68 | <p class=return> |
| 69 | If a connection is successfully initiated, a client object is returned. | 69 | If a connection is successfully initiated, a client object is returned. |
| 70 | If a timeout condition is met, the method returns <tt>nil</tt> followed | 70 | If a timeout condition is met, the method returns <b><tt>nil</tt></b> followed |
| 71 | by the error string '<tt>timeout</tt>'. | 71 | by the error string '<tt>timeout</tt>'. |
| 72 | </p> | 72 | </p> |
| 73 | 73 | ||
| @@ -111,7 +111,7 @@ attempts connection, the connection is refused. | |||
| 111 | 111 | ||
| 112 | <p class=return> | 112 | <p class=return> |
| 113 | In case of success, the method returns 1. In case of error, the | 113 | In case of success, the method returns 1. In case of error, the |
| 114 | method returns <tt>nil</tt> followed by an error message. | 114 | method returns <b><tt>nil</tt></b> followed by an error message. |
| 115 | </p> | 115 | </p> |
| 116 | 116 | ||
| 117 | <p class=note> | 117 | <p class=note> |
| @@ -165,7 +165,7 @@ and <a href=#close><tt>close</tt></a>. | |||
| 165 | </p> | 165 | </p> |
| 166 | 166 | ||
| 167 | <p class=return> | 167 | <p class=return> |
| 168 | In case of error, the method returns <tt>nil</tt> followed by a string | 168 | In case of error, the method returns <b><tt>nil</tt></b> followed by a string |
| 169 | describing the error. In case of success, the method returns 1. | 169 | describing the error. In case of success, the method returns 1. |
| 170 | </p> | 170 | </p> |
| 171 | 171 | ||
| @@ -187,7 +187,7 @@ Returns information about the remote side of a connected client object. | |||
| 187 | <p class=return> | 187 | <p class=return> |
| 188 | Returns a string with the IP address of the peer, followed by the | 188 | Returns a string with the IP address of the peer, followed by the |
| 189 | port number that peer is using for the connection. | 189 | port number that peer is using for the connection. |
| 190 | In case of error, the method returns <tt>nil</tt>. | 190 | In case of error, the method returns <b><tt>nil</tt></b>. |
| 191 | </p> | 191 | </p> |
| 192 | 192 | ||
| 193 | <p class=note> | 193 | <p class=note> |
| @@ -207,7 +207,7 @@ Returns the local address information associated to the object. | |||
| 207 | 207 | ||
| 208 | <p class=return> | 208 | <p class=return> |
| 209 | The method returns a string with local IP address and a number with | 209 | The method returns a string with local IP address and a number with |
| 210 | the port. In case of error, the method returns <tt>nil</tt>. | 210 | the port. In case of error, the method returns <b><tt>nil</tt></b>. |
| 211 | </p> | 211 | </p> |
| 212 | 212 | ||
| 213 | <p class=note> | 213 | <p class=note> |
| @@ -248,7 +248,7 @@ bytes from the socket. | |||
| 248 | 248 | ||
| 249 | <p class=return> | 249 | <p class=return> |
| 250 | The method returns one value for each pattern, followed by a single | 250 | The method returns one value for each pattern, followed by a single |
| 251 | error code that can be <tt>nil</tt> in case of success, the string | 251 | error code that can be <b><tt>nil</tt></b> in case of success, the string |
| 252 | '<tt>closed</tt>' in case the connection was closed before the | 252 | '<tt>closed</tt>' in case the connection was closed before the |
| 253 | transmission was completed or the string '<tt>timeout</tt>' in case | 253 | transmission was completed or the string '<tt>timeout</tt>' in case |
| 254 | there was a timeout during the operation. | 254 | there was a timeout during the operation. |
| @@ -278,7 +278,7 @@ result to LuaSocket instead of passing several independent strings. | |||
| 278 | 278 | ||
| 279 | <p class=return> | 279 | <p class=return> |
| 280 | The method returns the number of bytes accepted by the transport layer, | 280 | The method returns the number of bytes accepted by the transport layer, |
| 281 | followed by an error code. The error code is <tt>nil</tt> if the operation | 281 | followed by an error code. The error code is <b><tt>nil</tt></b> if the operation |
| 282 | completed with no errors, the string '<tt>closed</tt>' in case | 282 | completed with no errors, the string '<tt>closed</tt>' in case |
| 283 | the connection was closed before the transmission was completed or the | 283 | the connection was closed before the transmission was completed or the |
| 284 | string '<tt>timeout</tt>' in case there was a timeout during the | 284 | string '<tt>timeout</tt>' in case there was a timeout during the |
| @@ -288,7 +288,7 @@ operation. | |||
| 288 | <p class=note> | 288 | <p class=note> |
| 289 | Note: The return values for the <tt>send</tt> method have been changed in | 289 | Note: The return values for the <tt>send</tt> method have been changed in |
| 290 | LuaSocket 2.0! In previous versions, the method returned only the | 290 | LuaSocket 2.0! In previous versions, the method returned only the |
| 291 | error message. Since returning <tt>nil</tt> in case of success goes | 291 | error message. Since returning <b><tt>nil</tt></b> in case of success goes |
| 292 | against all other LuaSocket methods and functions, the | 292 | against all other LuaSocket methods and functions, the |
| 293 | <tt>send</tt> method been changed for the sake of uniformity. | 293 | <tt>send</tt> method been changed for the sake of uniformity. |
| 294 | </p> | 294 | </p> |
| @@ -330,7 +330,7 @@ considered broken and processes using the socket are notified. | |||
| 330 | </ul> | 330 | </ul> |
| 331 | 331 | ||
| 332 | <p class=return> | 332 | <p class=return> |
| 333 | The method returns 1 in case of success, or <tt>nil</tt> otherwise. | 333 | The method returns 1 in case of success, or <b><tt>nil</tt></b> otherwise. |
| 334 | </p> | 334 | </p> |
| 335 | 335 | ||
| 336 | <p class=note> | 336 | <p class=note> |
| @@ -374,7 +374,7 @@ a call.</li> | |||
| 374 | </ul> | 374 | </ul> |
| 375 | 375 | ||
| 376 | <p class=parameters> | 376 | <p class=parameters> |
| 377 | The <tt>nil</tt> timeout <tt>value</tt> allows operations to block | 377 | The <b><tt>nil</tt></b> timeout <tt>value</tt> allows operations to block |
| 378 | indefinitely. Negative timeout values have the same effect. | 378 | indefinitely. Negative timeout values have the same effect. |
| 379 | </p> | 379 | </p> |
| 380 | 380 | ||
