Z.IO.Network.TCP

This module provides an API for creating TCP servers and clients.

TCP Client

data TCPClientConfig

A TCP client configuration

Constructors

TCPClientConfig

Fields

• tcpClientAddr :: Maybe SocketAddr

  assign a local address, or let OS pick one

• tcpRemoteAddr :: SocketAddr

  remote target address

• tcpClientNoDelay :: Bool

  if we want to use TCP_NODELAY

• tcpClientKeepAlive :: CUInt

  set keepalive delay for client socket, see setTCPKeepAlive

defaultTCPClientConfig :: TCPClientConfig

Default config, connect to localhost:8888.

initTCPClient :: HasCallStack => TCPClientConfig -> Resource UVStream

init a TCP client Resource, which open a new connect when used.

getTCPSockName :: HasCallStack => UVStream -> IO SocketAddr

Get the current address to which the handle is bound.

TCP Server

data TCPServerConfig

A TCP server configuration

Constructors

TCPServerConfig

Fields

• tcpListenAddr :: SocketAddr

  listening address

• tcpListenBacklog :: Int

  listening socket's backlog size, should be large enough(>128)

• tcpServerWorkerNoDelay :: Bool

  if we want to use TCP_NODELAY

• tcpServerWorkerKeepAlive :: CUInt

  set keepalive delay for worker socket, see setTCPKeepAlive

• tcpServerWorker :: UVStream -> IO ()

  worker which get an accepted TCP stream, the socket will be closed upon exception or worker finishes.

defaultTCPServerConfig :: TCPServerConfig

A default hello world server on localhost:8888

Test it with main = startTCPServer defaultTCPServerConfig, now try nc -v 127.0.0.1 8888

startTCPServer :: HasCallStack => TCPServerConfig -> IO ()

Start a server

Fork new worker thread upon a new connection.

getTCPPeerName :: HasCallStack => UVStream -> IO SocketAddr

Get the address of the peer connected to the handle.