aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThijs Schreijer <thijs@thijsschreijer.nl>2022-03-22 19:24:38 +0100
committerGitHub <noreply@github.com>2022-03-22 21:24:38 +0300
commitc1eacfa6d24dc15476f5f9befa8370e2244931d4 (patch)
tree38424b6a6002f0e1ec5b7776232226575e66b6ce
parentf97dc8489d58aef2d038288f9a8bc69f907e17bb (diff)
downloadluasocket-c1eacfa6d24dc15476f5f9befa8370e2244931d4.tar.gz
luasocket-c1eacfa6d24dc15476f5f9befa8370e2244931d4.tar.bz2
luasocket-c1eacfa6d24dc15476f5f9befa8370e2244931d4.zip
fix(docs) references to some constants added (#359)
-rw-r--r--doc/socket.html6
-rw-r--r--doc/tcp.html8
2 files changed, 10 insertions, 4 deletions
diff --git a/doc/socket.html b/doc/socket.html
index 68db7cc..c148114 100644
--- a/doc/socket.html
+++ b/doc/socket.html
@@ -255,7 +255,8 @@ changed status.
255 255
256<p class="note"> 256<p class="note">
257<b>Note:</b> <tt>select</tt> can monitor a limited number 257<b>Note:</b> <tt>select</tt> can monitor a limited number
258of sockets, as defined by the constant <tt>socket._SETSIZE</tt>. This 258of sockets, as defined by the constant <a href="#setsize">
259<tt>socket._SETSIZE</tt></a>. This
259number may be as high as 1024 or as low as 64 by default, 260number may be as high as 1024 or as low as 64 by default,
260depending on the system. It is usually possible to change this 261depending on the system. It is usually possible to change this
261at compile time. Invoking <tt>select</tt> with a larger 262at compile time. Invoking <tt>select</tt> with a larger
@@ -410,7 +411,8 @@ socket.<b>_SOCKETINVALID</b>
410</p> 411</p>
411 412
412<p class="description"> 413<p class="description">
413The OS value for an invalid socket. 414The OS value for an invalid socket. This can be used with <a href="tcp.html#getfd">
415<tt>tcp:getfd</tt></a> and <a href="tcp.html#setfd"><tt>tcp:setfd</tt></a> methods.
414</p> 416</p>
415 417
416<!-- try ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 418<!-- try ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
diff --git a/doc/tcp.html b/doc/tcp.html
index 2d6e327..9cc173e 100644
--- a/doc/tcp.html
+++ b/doc/tcp.html
@@ -209,7 +209,9 @@ Returns the underling socket descriptor or handle associated to the object.
209</p> 209</p>
210 210
211<p class="return"> 211<p class="return">
212The descriptor or handle. In case the object has been closed, the return will be -1. 212The descriptor or handle. In case the object has been closed, the return value
213will be -1. For an invalid socket it will be <a href="socket.html#socketinvalid">
214<tt>_SOCKETINVALID</tt></a>.
213</p> 215</p>
214 216
215<p class="note"> 217<p class="note">
@@ -611,7 +613,9 @@ server:<b>setfd(</b>fd<b>)</b>
611</p> 613</p>
612 614
613<p class="description"> 615<p class="description">
614Sets the underling socket descriptor or handle associated to the object. The current one is simply replaced, not closed, and no other change to the object state is made. 616Sets the underling socket descriptor or handle associated to the object. The current one
617is simply replaced, not closed, and no other change to the object state is made.
618To set it as invalid use <a href="socket.html#socketinvalid"><tt>_SOCKETINVALID</tt></a>.
615</p> 619</p>
616 620
617<p class="return"> 621<p class="return">