luo980/libuv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: uv_tcp_bind() never returns UV_EADDRINUSE

Browse Source 
It defers the error to uv_listen() or uv_tcp_connect().

PR-URL: https://github.com/libuv/libuv/pull/2218
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Jameson Nash <vtjnash@gmail.com>
This commit is contained in:
Ben Noordhuis 2020-04-28 20:15:14 +02:00 committed by Jameson Nash
parent 726af5ebc3
commit 03185b785b
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/src/tcp.rst
View File

@ -81,10 +81,9 @@ API
initialized ``struct sockaddr_in`` or ``struct sockaddr_in6``. initialized ``struct sockaddr_in`` or ``struct sockaddr_in6``.
When the port is already taken, you can expect to see an ``UV_EADDRINUSE`` When the port is already taken, you can expect to see an ``UV_EADDRINUSE``
error from either :c:func:`uv_tcp_bind`, :c:func:`uv_listen` or error from :c:func:`uv_listen` or :c:func:`uv_tcp_connect`. That is,
:c:func:`uv_tcp_connect`. That is, a successful call to this function does a successful call to this function does not guarantee that the call
not guarantee that the call to :c:func:`uv_listen` or :c:func:`uv_tcp_connect` to :c:func:`uv_listen` or :c:func:`uv_tcp_connect` will succeed as well.
will succeed as well.
`flags` can contain ``UV_TCP_IPV6ONLY``, in which case dual-stack support `flags` can contain ``UV_TCP_IPV6ONLY``, in which case dual-stack support
is disabled and only IPv6 is used. is disabled and only IPv6 is used.