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

Instances

Eq TCPClientConfig

Defined in Z.IO.Network.TCP

Methods

(==) :: TCPClientConfig -> TCPClientConfig -> Bool

(/=) :: TCPClientConfig -> TCPClientConfig -> Bool

Ord TCPClientConfig

Defined in Z.IO.Network.TCP

Methods

compare :: TCPClientConfig -> TCPClientConfig -> Ordering

(<) :: TCPClientConfig -> TCPClientConfig -> Bool

(<=) :: TCPClientConfig -> TCPClientConfig -> Bool

(>) :: TCPClientConfig -> TCPClientConfig -> Bool

(>=) :: TCPClientConfig -> TCPClientConfig -> Bool

max :: TCPClientConfig -> TCPClientConfig -> TCPClientConfig

min :: TCPClientConfig -> TCPClientConfig -> TCPClientConfig

Show TCPClientConfig

Defined in Z.IO.Network.TCP

Methods

showsPrec :: Int -> TCPClientConfig -> ShowS

show :: TCPClientConfig -> String

showList :: [TCPClientConfig] -> ShowS

Generic TCPClientConfig

Defined in Z.IO.Network.TCP

Associated Types

type Rep TCPClientConfig :: Type -> Type

Methods

from :: TCPClientConfig -> Rep TCPClientConfig x

to :: Rep TCPClientConfig x -> TCPClientConfig

JSON TCPClientConfig

Defined in Z.IO.Network.TCP

Methods

fromValue :: Value -> Converter TCPClientConfig

toValue :: TCPClientConfig -> Value

encodeJSON :: TCPClientConfig -> Builder ()

Print TCPClientConfig

Defined in Z.IO.Network.TCP

Methods

toUTF8BuilderP :: Int -> TCPClientConfig -> Builder ()

type Rep TCPClientConfig

Defined in Z.IO.Network.TCP

type Rep TCPClientConfig = D1 ('MetaData "TCPClientConfig" "Z.IO.Network.TCP" "Z-IO-0.7.1.0-3BBHCJDsYLmIZeJiiaEssI" 'False) (C1 ('MetaCons "TCPClientConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tcpClientAddr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SocketAddr)) :*: S1 ('MetaSel ('Just "tcpRemoteAddr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SocketAddr)) :*: (S1 ('MetaSel ('Just "tcpClientNoDelay") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "tcpClientKeepAlive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CUInt))))

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

Print UVStream

Defined in Z.IO.UV.UVStream

Methods

toUTF8BuilderP :: Int -> UVStream -> Builder ()

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

Instances

Eq TCPServerConfig

Defined in Z.IO.Network.TCP

Methods

(==) :: TCPServerConfig -> TCPServerConfig -> Bool

(/=) :: TCPServerConfig -> TCPServerConfig -> Bool

Ord TCPServerConfig

Defined in Z.IO.Network.TCP

Methods

compare :: TCPServerConfig -> TCPServerConfig -> Ordering

(<) :: TCPServerConfig -> TCPServerConfig -> Bool

(<=) :: TCPServerConfig -> TCPServerConfig -> Bool

(>) :: TCPServerConfig -> TCPServerConfig -> Bool

(>=) :: TCPServerConfig -> TCPServerConfig -> Bool

max :: TCPServerConfig -> TCPServerConfig -> TCPServerConfig

min :: TCPServerConfig -> TCPServerConfig -> TCPServerConfig

Show TCPServerConfig

Defined in Z.IO.Network.TCP

Methods

showsPrec :: Int -> TCPServerConfig -> ShowS

show :: TCPServerConfig -> String

showList :: [TCPServerConfig] -> ShowS

Generic TCPServerConfig

Defined in Z.IO.Network.TCP

Associated Types

type Rep TCPServerConfig :: Type -> Type

Methods

from :: TCPServerConfig -> Rep TCPServerConfig x

to :: Rep TCPServerConfig x -> TCPServerConfig

JSON TCPServerConfig

Defined in Z.IO.Network.TCP

Methods

fromValue :: Value -> Converter TCPServerConfig

toValue :: TCPServerConfig -> Value

encodeJSON :: TCPServerConfig -> Builder ()

Print TCPServerConfig

Defined in Z.IO.Network.TCP

Methods

toUTF8BuilderP :: Int -> TCPServerConfig -> Builder ()

type Rep TCPServerConfig

Defined in Z.IO.Network.TCP

type Rep TCPServerConfig = D1 ('MetaData "TCPServerConfig" "Z.IO.Network.TCP" "Z-IO-0.7.1.0-3BBHCJDsYLmIZeJiiaEssI" 'False) (C1 ('MetaCons "TCPServerConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tcpListenAddr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SocketAddr) :*: S1 ('MetaSel ('Just "tcpListenBacklog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "tcpServerWorkerNoDelay") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "tcpServerWorkerKeepAlive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CUInt))))

defaultTCPServerConfig :: TCPServerConfig

A default hello world server on 0.0.0.0: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 TCP server

Fork new worker threads 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

startServerLoop

Arguments

:: HasCallStack

=> Int

backLog

-> (UVManager -> Resource UVStream)

uv_stream_t initializer

-> (Ptr UVHandle -> IO ())

bind function

-> (FD -> (UVStream -> IO ()) -> IO ())

thread spawner

-> (UVStream -> IO ())

worker

-> IO ()

Start a server loop with different kind of uv_streams, such as tcp or pipe.

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

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

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

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 connection is closed, pending io thread will throw TimeExpired exception.

initTCPStream :: UVManager -> Resource UVStream