From c1eacfa6d24dc15476f5f9befa8370e2244931d4 Mon Sep 17 00:00:00 2001 From: Thijs Schreijer Date: Tue, 22 Mar 2022 19:24:38 +0100 Subject: fix(docs) references to some constants added (#359) --- doc/socket.html | 6 ++++-- doc/tcp.html | 8 ++++++-- 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.

Note: select can monitor a limited number -of sockets, as defined by the constant socket._SETSIZE. This +of sockets, as defined by the constant +socket._SETSIZE. This number may be as high as 1024 or as low as 64 by default, depending on the system. It is usually possible to change this at compile time. Invoking select with a larger @@ -410,7 +411,8 @@ socket._SOCKETINVALID

-The OS value for an invalid socket. +The OS value for an invalid socket. This can be used with +tcp:getfd and tcp:setfd methods.

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.

-The descriptor or handle. In case the object has been closed, the return will be -1. +The descriptor or handle. In case the object has been closed, the return value +will be -1. For an invalid socket it will be +_SOCKETINVALID.

@@ -611,7 +613,9 @@ server:setfd(fd)

-Sets 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. +Sets 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. +To set it as invalid use _SOCKETINVALID.

-- cgit v1.2.3-55-g6feb