diff options
author | Sam Roberts <vieuxtech@gmail.com> | 2012-02-27 13:26:23 -0800 |
---|---|---|
committer | Sam Roberts <vieuxtech@gmail.com> | 2012-04-11 13:54:01 -0700 |
commit | 8bb542baaf30874479b83d37af2fea5fa84d0a8e (patch) | |
tree | 117d706140ee622565fa1c671c5469cb7f30fdac /doc | |
parent | 0716cb868e847bb9f66c659f8662d905ba012de8 (diff) | |
download | luasocket-8bb542baaf30874479b83d37af2fea5fa84d0a8e.tar.gz luasocket-8bb542baaf30874479b83d37af2fea5fa84d0a8e.tar.bz2 luasocket-8bb542baaf30874479b83d37af2fea5fa84d0a8e.zip |
Support getoption method for tcp objects.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/reference.html | 1 | ||||
-rw-r--r-- | doc/tcp.html | 35 |
2 files changed, 35 insertions, 1 deletions
diff --git a/doc/reference.html b/doc/reference.html index 078d40c..d7e0923 100644 --- a/doc/reference.html +++ b/doc/reference.html | |||
@@ -172,6 +172,7 @@ Support, Manual"> | |||
172 | <a href="tcp.html#connect">connect</a>, | 172 | <a href="tcp.html#connect">connect</a>, |
173 | <a href="tcp.html#dirty">dirty</a>, | 173 | <a href="tcp.html#dirty">dirty</a>, |
174 | <a href="tcp.html#getfd">getfd</a>, | 174 | <a href="tcp.html#getfd">getfd</a>, |
175 | <a href="tcp.html#getoption">getoption</a>, | ||
175 | <a href="tcp.html#getpeername">getpeername</a>, | 176 | <a href="tcp.html#getpeername">getpeername</a>, |
176 | <a href="tcp.html#getsockname">getsockname</a>, | 177 | <a href="tcp.html#getsockname">getsockname</a>, |
177 | <a href="tcp.html#getstats">getstats</a>, | 178 | <a href="tcp.html#getstats">getstats</a>, |
diff --git a/doc/tcp.html b/doc/tcp.html index 9583b1f..11a0428 100644 --- a/doc/tcp.html +++ b/doc/tcp.html | |||
@@ -396,7 +396,40 @@ disables the Nagle's algorithm for the connection. | |||
396 | </ul> | 396 | </ul> |
397 | 397 | ||
398 | <p class=return> | 398 | <p class=return> |
399 | The method returns 1 in case of success, or <b><tt>nil</tt></b> otherwise. | 399 | The method returns 1 in case of success, or <b><tt>nil</tt></b> |
400 | followed by an error message otherwise. | ||
401 | </p> | ||
402 | |||
403 | <p class=note> | ||
404 | Note: The descriptions above come from the man pages. | ||
405 | </p> | ||
406 | |||
407 | <!-- getoption ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
408 | |||
409 | <p class=name id=getoption> | ||
410 | client:<b>getoption(</b>option)</b><br> | ||
411 | server:<b>getoption(</b>option)</b> | ||
412 | </p> | ||
413 | |||
414 | <p class=description> | ||
415 | Gets options for the TCP object. | ||
416 | See <a href=#setoption><tt>setoption</tt></a> for description of the | ||
417 | option names and values. | ||
418 | </p> | ||
419 | |||
420 | <p class=parameters> | ||
421 | <tt>Option</tt> is a string with the option name. | ||
422 | <ul> | ||
423 | |||
424 | <li> '<tt>keepalive</tt>' | ||
425 | <li> '<tt>linger</tt>' | ||
426 | <li> '<tt>reuseaddr</tt>' | ||
427 | <li> '<tt>tcp-nodelay</tt>' | ||
428 | </ul> | ||
429 | |||
430 | <p class=return> | ||
431 | The method returns the option <tt>value</tt> in case of success, or | ||
432 | <b><tt>nil</tt></b> followed by an error message otherwise. | ||
400 | </p> | 433 | </p> |
401 | 434 | ||
402 | <p class=note> | 435 | <p class=note> |