Idris2Doc : System.UV.Raw.TCP

System.UV.Raw.TCP

(source)

Definitions

uv_tcp_init : HasIOio=>PtrLoop->PtrTcp->ioInt32
  Initialize the handle. No socket is created as of yet.

Totality: total
Visibility: export
uv_tcp_keepalive : HasIOio=>PtrTcp->Bool->Bits32->ioInt32
  Enable / disable TCP keep-alive. delay is the initial
delay in seconds, ignored when enable is zero.
After delay has been reached, 10 successive probes,
each spaced 1 second from the previous one, will still happen.
If the connection is still lost at the end of this procedure,
then the handle is destroyed with a
UV_ETIMEDOUT error passed to the corresponding callback.

Totality: total
Visibility: export
uv_tcp_simultaneous_accepts : HasIOio=>PtrTcp->Bool->ioInt32
  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 un‐
even load distribution in multi-process setups.

Totality: total
Visibility: export
uv_tcp_bind : HasIOio=> {auto0_ : PCasttSockAddr} ->PtrTcp->Ptrt->Bits32->ioInt32
  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 uv_listen() or uv_tcp_connect(). That is, a successful call
to this function does not guarantee that the call to uv_listen() or
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.

Totality: total
Visibility: export
uv_tcp_connect : HasIOio=> {auto0_ : PCasttSockAddr} ->PtrTcp->Ptrt-> (PtrConnect->Int32->IO ()) ->ioInt32
  Establish an IPv4 or IPv6 TCP connection. Provide an initialized
TCP handle and an uninitialized uv_connect_t. addr should
point to an initialized struct sockaddr_in or struct sockaddr_in6.

On Windows if the addr is initialized to point to an
unspecified address (0.0.0.0 or ::) it will be changed to
point to localhost. This is done to match the behavior of Linux systems.

The callback is made when the connection has been established
or when a connection error happened.

Totality: total
Visibility: export
uv_ip4_addr : HasIOio=>String->Bits16->PtrSockAddrIn->ioInt32
  Convert a string containing an IPv4 address to a binary structure.

Totality: total
Visibility: export
uv_ip6_addr : HasIOio=>String->Bits16->PtrSockAddrIn6->ioInt32
  Convert a string containing an IPv6 address to a binary structure.

Totality: total
Visibility: export
uv_ip4_name : HasIOio=>PtrSockAddrIn->PtrChar->Bits32->ioInt32
  Convert a binary structure containing an IPv4 address to a string.

Totality: total
Visibility: export
uv_ip6_name : HasIOio=>PtrSockAddrIn6->PtrChar->Bits32->ioInt32
  Convert a binary structure containing an IPv6 address to a string.

Totality: total
Visibility: export
uv_ip_name : HasIOio=>PtrSockAddr->PtrChar->Bits32->ioInt32
  Convert a binary structure containing an IPv4 address or an
IPv6 address to a string.

Totality: total
Visibility: export