diff options
| author | Saúl Ibarra Corretgé <saghul@gmail.com> | 2015-03-23 10:01:26 +0100 |
|---|---|---|
| committer | Saúl Ibarra Corretgé <saghul@gmail.com> | 2015-03-23 10:55:38 +0100 |
| commit | db39a6ce715f02246efde6dddbdd22bbf37102ab (patch) | |
| tree | c8d92970c18e3ba190e0f23fe56282dee72d5c9a /docs/src | |
| parent | 34da61b3516b0f4700f5293865804a1f174244c3 (diff) | |
| download | libuv-db39a6ce715f02246efde6dddbdd22bbf37102ab.tar.gz libuv-db39a6ce715f02246efde6dddbdd22bbf37102ab.zip | |
doc: clarify what uv_*_open accepts
Fixes: https://github.com/libuv/libuv/issues/281
PR-URL: https://github.com/libuv/libuv/pull/284
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/pipe.rst | 4 | ||||
| -rw-r--r-- | docs/src/tcp.rst | 4 | ||||
| -rw-r--r-- | docs/src/udp.rst | 4 |
3 files changed, 12 insertions, 0 deletions
diff --git a/docs/src/pipe.rst b/docs/src/pipe.rst index 8f8402c2..df896a05 100644 --- a/docs/src/pipe.rst +++ b/docs/src/pipe.rst @@ -40,6 +40,10 @@ API .. versionchanged:: 1.2.1 the file descriptor is set to non-blocking mode. + .. note:: + The passed file descriptor or HANDLE is not checked for its type, but + it's required that it represents a valid pipe. + .. c:function:: int uv_pipe_bind(uv_pipe_t* handle, const char* name) Bind the pipe to a file path (Unix) or a name (Windows). diff --git a/docs/src/tcp.rst b/docs/src/tcp.rst index 8baedde8..2b5d268d 100644 --- a/docs/src/tcp.rst +++ b/docs/src/tcp.rst @@ -38,6 +38,10 @@ API .. versionchanged:: 1.2.1 the file descriptor is set to non-blocking mode. + .. note:: + The passed file descriptor or SOCKET is not checked for its type, but + it's required that it represents a valid stream socket. + .. c:function:: int uv_tcp_nodelay(uv_tcp_t* handle, int enable) Enable / disable Nagle's algorithm. diff --git a/docs/src/udp.rst b/docs/src/udp.rst index 9c4aa210..ec7ce56d 100644 --- a/docs/src/udp.rst +++ b/docs/src/udp.rst @@ -122,6 +122,10 @@ API .. versionchanged:: 1.2.1 the file descriptor is set to non-blocking mode. + .. note:: + The passed file descriptor or SOCKET is not checked for its type, but + it's required that it represents a valid datagram socket. + .. c:function:: int uv_udp_bind(uv_udp_t* handle, const struct sockaddr* addr, unsigned int flags) Bind the UDP handle to an IP address and port. |