f8f59824c4
Introduce two new APIs:
int uv_tcp_init_ex(uv_loop_t*, uv_tcp_t* handle, int flags)
int uv_udp_init_ex(uv_loop_t*, uv_udp_t* handle, int flags)
The lower 8 bits of the flags field are used for the socket domain.
AF_INET, AF_INET6 and AF_UNSPEC are supported. If AF_UNSPEC is specified
the socket is created lazily, just like uv_{tcp,udp}_init.
Some Windows notes:
getsockname fails with WSAEINVAL if the socket is not bound. This could
potentially be improved by detecting the socket family and filling
the sockaddr_in/6 struct manually.
bind returns WSAEFAULT if we try to bind a socket to the wrong family.
Unix returns EINVAL.
PR-URL: https://github.com/libuv/libuv/pull/400
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
109 lines
3.8 KiB
ReStructuredText
109 lines
3.8 KiB
ReStructuredText
|
|
.. _tcp:
|
|
|
|
:c:type:`uv_tcp_t` --- TCP handle
|
|
=================================
|
|
|
|
TCP handles are used to represent both TCP streams and servers.
|
|
|
|
:c:type:`uv_tcp_t` is a 'subclass' of :c:type:`uv_stream_t`.
|
|
|
|
|
|
Data types
|
|
----------
|
|
|
|
.. c:type:: uv_tcp_t
|
|
|
|
TCP handle type.
|
|
|
|
|
|
Public members
|
|
^^^^^^^^^^^^^^
|
|
|
|
N/A
|
|
|
|
.. seealso:: The :c:type:`uv_stream_t` members also apply.
|
|
|
|
|
|
API
|
|
---
|
|
|
|
.. c:function:: int uv_tcp_init(uv_loop_t*, uv_tcp_t* handle)
|
|
|
|
Initialize the handle. No socket is created as of yet.
|
|
|
|
.. c:function:: int uv_tcp_init_ex(uv_loop_t*, uv_tcp_t* handle, unsigned int flags)
|
|
|
|
Initialize the handle with the specified flags. At the moment the lower 8 bits
|
|
of the `flags` parameter are used as the socket domain. A socket will be created
|
|
for the given domain. If the specified domain is ``AF_UNSPEC`` no socket is created,
|
|
just like :c:func:`uv_tcp_init`.
|
|
|
|
.. versionadded:: 1.7.0
|
|
|
|
.. c:function:: int uv_tcp_open(uv_tcp_t* handle, uv_os_sock_t sock)
|
|
|
|
Open an existing file descriptor or SOCKET as a TCP handle.
|
|
|
|
.. 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.
|
|
|
|
.. c:function:: int uv_tcp_keepalive(uv_tcp_t* handle, int enable, unsigned int delay)
|
|
|
|
Enable / disable TCP keep-alive. `delay` is the initial delay in seconds,
|
|
ignored when `enable` is zero.
|
|
|
|
.. c:function:: int uv_tcp_simultaneous_accepts(uv_tcp_t* handle, int enable)
|
|
|
|
Enable / disable simultaneous asynchronous accept requests that are
|
|
queued by the operating system when listening for new TCP connections.
|
|
|
|
This setting is used to tune a TCP server for the desired performance.
|
|
Having simultaneous accepts can significantly improve the rate of accepting
|
|
connections (which is why it is enabled by default) but may lead to uneven
|
|
load distribution in multi-process setups.
|
|
|
|
.. c:function:: int uv_tcp_bind(uv_tcp_t* handle, const struct sockaddr* addr, unsigned int flags)
|
|
|
|
Bind the handle to an address and port. `addr` should point to an
|
|
initialized ``struct sockaddr_in`` or ``struct sockaddr_in6``.
|
|
|
|
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
|
|
:c:func:`uv_tcp_connect`. That is, a successful call to this function does
|
|
not guarantee that the call to :c:func:`uv_listen` or :c:func:`uv_tcp_connect`
|
|
will succeed as well.
|
|
|
|
`flags` can contain ``UV_TCP_IPV6ONLY``, in which case dual-stack support
|
|
is disabled and only IPv6 is used.
|
|
|
|
.. c:function:: int uv_tcp_getsockname(const uv_tcp_t* handle, struct sockaddr* name, int* namelen)
|
|
|
|
Get the current address to which the handle is bound. `addr` must point to
|
|
a valid and big enough chunk of memory, ``struct sockaddr_storage`` is
|
|
recommended for IPv4 and IPv6 support.
|
|
|
|
.. c:function:: int uv_tcp_getpeername(const uv_tcp_t* handle, struct sockaddr* name, int* namelen)
|
|
|
|
Get the address of the peer connected to the handle. `addr` must point to
|
|
a valid and big enough chunk of memory, ``struct sockaddr_storage`` is
|
|
recommended for IPv4 and IPv6 support.
|
|
|
|
.. c:function:: int uv_tcp_connect(uv_connect_t* req, uv_tcp_t* handle, const struct sockaddr* addr, uv_connect_cb cb)
|
|
|
|
Establish an IPv4 or IPv6 TCP connection. Provide an initialized TCP handle
|
|
and an uninitialized :c:type:`uv_connect_t`. `addr` should point to an
|
|
initialized ``struct sockaddr_in`` or ``struct sockaddr_in6``.
|
|
|
|
The callback is made when the connection has been established or when a
|
|
connection error happened.
|
|
|
|
.. seealso:: The :c:type:`uv_stream_t` API functions also apply.
|