aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorSaúl Ibarra Corretgé <saghul@gmail.com>2015-01-14 09:24:46 +0100
committerSaúl Ibarra Corretgé <saghul@gmail.com>2015-01-16 10:41:00 +0100
commitb30a3e677b144afa19143490e9ffc9f882cb4722 (patch)
tree5bc5eb79011d3a93578bf7218ff59f735fb18fd3 /docs/src
parent9a53014388b9321b7c71dbb3f86a264f54e41210 (diff)
downloadlibuv-b30a3e677b144afa19143490e9ffc9f882cb4722.tar.gz
libuv-b30a3e677b144afa19143490e9ffc9f882cb4722.zip
unix, windows: set non-block mode in uv_poll_init
libuv requires that the socket/fd is in non-blocking mode, so do it internally so the user doesn't need to write platform specific code to do so. This also makes the API consistent with uv_{tcp,udp,pipe}_open, since it's not required to pass the fd in non-blocking mode there either. PR-URL: https://github.com/libuv/libuv/pull/136 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/poll.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/src/poll.rst b/docs/src/poll.rst
index f3484225..907cb1a6 100644
--- a/docs/src/poll.rst
+++ b/docs/src/poll.rst
@@ -70,11 +70,15 @@ API
Initialize the handle using a file descriptor.
+ .. versionchanged:: 1.2.2 the file descriptor is set to non-blocking mode.
+
.. c:function:: int uv_poll_init_socket(uv_loop_t* loop, uv_poll_t* handle, uv_os_sock_t socket)
Initialize the handle using a socket descriptor. On Unix this is identical
to :c:func:`uv_poll_init`. On windows it takes a SOCKET handle.
+ .. versionchanged:: 1.2.2 the socket is set to non-blocking mode.
+
.. c:function:: int uv_poll_start(uv_poll_t* handle, int events, uv_poll_cb cb)
Starts polling the file descriptor. `events` is a bitmask consisting made up