jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix docs for nativesocket read/write selects (#15010)

Browse source 
The sockets which *cannot* be _[read from or written to]_ will also be removed from ``readfds``.
This commit is contained in:
Andy Davidoff 2020-07-18 10:39:41 -04:00 • committed by GitHub
commit ae358a0c7a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lib/pure/nativesockets.nim
View file

@ -656,7 +656,7 @@ proc pruneSocketSet(s: var seq[SocketHandle], fd: var TFdSet) =
proc selectRead*(readfds: var seq[SocketHandle], timeout = 500): int = proc selectRead*(readfds: var seq[SocketHandle], timeout = 500): int =
## When a socket in ``readfds`` is ready to be read from then a non-zero ## When a socket in ``readfds`` is ready to be read from then a non-zero
## value will be returned specifying the count of the sockets which can be ## value will be returned specifying the count of the sockets which can be
## read from. The sockets which can be read from will also be removed ## read from. The sockets which cannot be read from will also be removed
## from ``readfds``. ## from ``readfds``.
## ##
## ``timeout`` is specified in milliseconds and ``-1`` can be specified for ## ``timeout`` is specified in milliseconds and ``-1`` can be specified for
@ -678,7 +678,7 @@ proc selectWrite*(writefds: var seq[SocketHandle],
timeout = 500): int {.tags: [ReadIOEffect].} = timeout = 500): int {.tags: [ReadIOEffect].} =
## When a socket in ``writefds`` is ready to be written to then a non-zero ## When a socket in ``writefds`` is ready to be written to then a non-zero
## value will be returned specifying the count of the sockets which can be ## value will be returned specifying the count of the sockets which can be
## written to. The sockets which can be written to will also be removed ## written to. The sockets which cannot be written to will also be removed
## from ``writefds``. ## from ``writefds``.
## ##
## ``timeout`` is specified in milliseconds and ``-1`` can be specified for ## ``timeout`` is specified in milliseconds and ``-1`` can be specified for