diff --git a/doc/reference.html b/doc/reference.html index f13a6bd..edffc40 100644 --- a/doc/reference.html +++ b/doc/reference.html @@ -170,12 +170,15 @@ Support, Manual"> bind, close, connect, +dirty, +getfd, getpeername, getsockname, getstats, listen, receive, send, +setfd, setoption, setstats, settimeout, diff --git a/doc/socket.html b/doc/socket.html index f096e4b..4d44f01 100644 --- a/doc/socket.html +++ b/doc/socket.html @@ -217,6 +217,10 @@ method or accept might block forever. it to select, it will be ignored.

+

+Using select with non-socket objects: Any object that implements getfd and dirty can be used with select, allowing objects from other libraries to be used within a socket.select driven loop. +

+

diff --git a/doc/tcp.html b/doc/tcp.html index 602c73c..ab70f04 100644 --- a/doc/tcp.html +++ b/doc/tcp.html @@ -507,6 +507,66 @@ This is the default mode; This function returns 1.

+ + +

+master:dirty()
+client:dirty()
+server:dirty() +

+ +

+Check the read buffer status. +

+ +

+Returns true if there is any data in the read buffer, false otherwise. +

+ +

+Note: This is an internal method, any use is unlikely to be portable. +

+ + + +

+master:getfd()
+client:getfd()
+server:getfd() +

+ +

+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. +

+ +

+Note: This is an internal method, any use is unlikely to be portable. +

+ + + +

+master:setfd(fd)
+client:setfd(fd)
+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. +

+ +

+No return value. +

+ +

+Note: This is an internal method, any use is unlikely to be portable. +

+