From 8bb542baaf30874479b83d37af2fea5fa84d0a8e Mon Sep 17 00:00:00 2001
From: Sam Roberts <vieuxtech@gmail.com>
Date: Mon, 27 Feb 2012 13:26:23 -0800
Subject: Support getoption method for tcp objects.

---
 doc/reference.html |  1 +
 doc/tcp.html       | 35 ++++++++++++++++++++++++++++++++++-
 2 files changed, 35 insertions(+), 1 deletion(-)

(limited to 'doc')

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">
 <a href="tcp.html#connect">connect</a>,
 <a href="tcp.html#dirty">dirty</a>,
 <a href="tcp.html#getfd">getfd</a>,
+<a href="tcp.html#getoption">getoption</a>,
 <a href="tcp.html#getpeername">getpeername</a>,
 <a href="tcp.html#getsockname">getsockname</a>,
 <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.
 </ul>
 
 <p class=return>
-The method returns 1 in case of success, or <b><tt>nil</tt></b> otherwise.
+The method returns 1 in case of success, or <b><tt>nil</tt></b>
+followed by an error message otherwise.
+</p>
+
+<p class=note>
+Note: The descriptions above come from the man pages.
+</p>
+
+<!-- getoption ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
+
+<p class=name id=getoption>
+client:<b>getoption(</b>option)</b><br>
+server:<b>getoption(</b>option)</b>
+</p>
+
+<p class=description>
+Gets options for the TCP object.
+See <a href=#setoption><tt>setoption</tt></a> for description of the
+option names and values.
+</p>
+
+<p class=parameters>
+<tt>Option</tt> is a string with the option name.
+<ul>
+
+<li> '<tt>keepalive</tt>'
+<li> '<tt>linger</tt>'
+<li> '<tt>reuseaddr</tt>'
+<li> '<tt>tcp-nodelay</tt>'
+</ul>
+
+<p class=return>
+The method returns the option <tt>value</tt> in case of success, or
+<b><tt>nil</tt></b> followed by an error message otherwise.
 </p>
 
 <p class=note>
-- 
cgit v1.2.3-55-g6feb