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

data UVStream

A haskell data type wrap an uv_stream_t inside

UVStream DO NOT provide thread safety! Use UVStream concurrently in multiple threads will lead to undefined behavior.

Instances

Show UVStream

Defined in Z.IO.UV.UVStream

Methods

showsPrec :: Int -> UVStream -> ShowS

show :: UVStream -> String

showList :: [UVStream] -> ShowS

Output UVStream

Defined in Z.IO.UV.UVStream

Methods

writeOutput :: UVStream -> Ptr Word8 -> Int -> IO ()

Input UVStream

Defined in Z.IO.UV.UVStream

Methods

readInput :: UVStream -> Ptr Word8 -> Int -> IO Int

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

defaultTCPServerConfig :: TCPServerConfig

A default hello world server on localhost:8888

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

startTCPServer

Arguments

:: HasCallStack

=> TCPServerConfig

-> (UVStream -> IO ())

worker which will get an accepted TCP stream and run in a seperated haskell thread, will be closed upon exception or worker finishes.

-> 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.

For test

helloWorld :: UVStream -> IO ()

Write "hello world" to a UVStream.

echo :: UVStream -> IO ()

Echo whatever received bytes.

Internal helper

setTCPNoDelay :: HasCallStack => UVStream -> Bool -> IO ()

Enable or disable TCP_NODELAY, which disables Nagle’s algorithm.

setTCPKeepAlive :: HasCallStack => UVStream -> CUInt -> IO ()

initTCPStream :: HasCallStack => UVManager -> Resource UVStream