Copyright	(c) Dong Han 2018
License	BSD
Maintainer	winterland1989@gmail.com
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Z.IO.Network.TCP

Contents

TCP Client
TCP Server
For test
Internal helper

Description

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

Synopsis

data TCPClientConfig = TCPClientConfig {
- tcpClientAddr :: Maybe SocketAddr
- tcpRemoteAddr :: SocketAddr
- tcpClientNoDelay :: Bool
- tcpClientKeepAlive :: CUInt
}
data UVStream
defaultTCPClientConfig :: TCPClientConfig
initTCPClient :: HasCallStack => TCPClientConfig -> Resource UVStream
getTCPSockName :: HasCallStack => UVStream -> IO SocketAddr
data TCPServerConfig = TCPServerConfig {
- tcpListenAddr :: SocketAddr
- tcpListenBacklog :: Int
- tcpServerWorkerNoDelay :: Bool
- tcpServerWorkerKeepAlive :: CUInt
}
defaultTCPServerConfig :: TCPServerConfig
startTCPServer :: HasCallStack => TCPServerConfig -> (UVStream -> IO ()) -> IO ()
getTCPPeerName :: HasCallStack => UVStream -> IO SocketAddr
helloWorld :: UVStream -> IO ()
echo :: UVStream -> IO ()
setTCPNoDelay :: HasCallStack => UVStream -> Bool -> IO ()
setTCPKeepAlive :: HasCallStack => UVStream -> CUInt -> IO ()
initTCPStream :: UVManager -> Resource UVStream

TCP Client

data TCPClientConfig Source #

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

Instances details

Eq TCPClientConfig Source #
Instance details Defined in Z.IO.Network.TCP Methods (==) :: TCPClientConfig -> TCPClientConfig -> Bool # (/=) :: TCPClientConfig -> TCPClientConfig -> Bool #
Ord TCPClientConfig Source #
Instance details 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 Source #
Instance details Defined in Z.IO.Network.TCP Methods showsPrec :: Int -> TCPClientConfig -> ShowS # show :: TCPClientConfig -> String # showList :: [TCPClientConfig] -> ShowS #
Generic TCPClientConfig Source #
Instance details Defined in Z.IO.Network.TCP Associated Types type Rep TCPClientConfig :: Type -> Type # Methods from :: TCPClientConfig -> Rep TCPClientConfig x # to :: Rep TCPClientConfig x -> TCPClientConfig #
ToValue TCPClientConfig Source #
Instance details Defined in Z.IO.Network.TCP Methods toValue :: TCPClientConfig -> Value #
EncodeJSON TCPClientConfig Source #
Instance details Defined in Z.IO.Network.TCP Methods encodeJSON :: TCPClientConfig -> Builder () #
FromValue TCPClientConfig Source #
Instance details Defined in Z.IO.Network.TCP Methods fromValue :: Value -> Converter TCPClientConfig #
ShowT TCPClientConfig Source #
Instance details Defined in Z.IO.Network.TCP Methods toUTF8BuilderP :: Int -> TCPClientConfig -> Builder () #
type Rep TCPClientConfig Source #
Instance details Defined in Z.IO.Network.TCP type Rep TCPClientConfig = D1 ('MetaData "TCPClientConfig" "Z.IO.Network.TCP" "Z-IO-0.2.0.0-9WozHvkV8CCkBNKN4MqC3" '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 Source #

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

Instances details

Show UVStream Source #
Instance details Defined in Z.IO.UV.UVStream Methods showsPrec :: Int -> UVStream -> ShowS # show :: UVStream -> String # showList :: [UVStream] -> ShowS #
ShowT UVStream Source #
Instance details Defined in Z.IO.UV.UVStream Methods toUTF8BuilderP :: Int -> UVStream -> Builder () #
Output UVStream Source #
Instance details Defined in Z.IO.UV.UVStream Methods writeOutput :: UVStream -> Ptr Word8 -> Int -> IO () Source #
Input UVStream Source #
Instance details Defined in Z.IO.UV.UVStream Methods readInput :: UVStream -> Ptr Word8 -> Int -> IO Int Source #

defaultTCPClientConfig :: TCPClientConfig Source #

Default config, connect to localhost:8888.

initTCPClient :: HasCallStack => TCPClientConfig -> Resource UVStream Source #

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

getTCPSockName :: HasCallStack => UVStream -> IO SocketAddr Source #

Get the current address to which the handle is bound.

TCP Server

data TCPServerConfig Source #

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

Instances details

Eq TCPServerConfig Source #
Instance details Defined in Z.IO.Network.TCP Methods (==) :: TCPServerConfig -> TCPServerConfig -> Bool # (/=) :: TCPServerConfig -> TCPServerConfig -> Bool #
Ord TCPServerConfig Source #
Instance details 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 Source #
Instance details Defined in Z.IO.Network.TCP Methods showsPrec :: Int -> TCPServerConfig -> ShowS # show :: TCPServerConfig -> String # showList :: [TCPServerConfig] -> ShowS #
Generic TCPServerConfig Source #
Instance details Defined in Z.IO.Network.TCP Associated Types type Rep TCPServerConfig :: Type -> Type # Methods from :: TCPServerConfig -> Rep TCPServerConfig x # to :: Rep TCPServerConfig x -> TCPServerConfig #
ToValue TCPServerConfig Source #
Instance details Defined in Z.IO.Network.TCP Methods toValue :: TCPServerConfig -> Value #
EncodeJSON TCPServerConfig Source #
Instance details Defined in Z.IO.Network.TCP Methods encodeJSON :: TCPServerConfig -> Builder () #
FromValue TCPServerConfig Source #
Instance details Defined in Z.IO.Network.TCP Methods fromValue :: Value -> Converter TCPServerConfig #
ShowT TCPServerConfig Source #
Instance details Defined in Z.IO.Network.TCP Methods toUTF8BuilderP :: Int -> TCPServerConfig -> Builder () #
type Rep TCPServerConfig Source #
Instance details Defined in Z.IO.Network.TCP type Rep TCPServerConfig = D1 ('MetaData "TCPServerConfig" "Z.IO.Network.TCP" "Z-IO-0.2.0.0-9WozHvkV8CCkBNKN4MqC3" '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 Source #

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 Source #

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 Source #

Get the address of the peer connected to the handle.

For test

helloWorld :: UVStream -> IO () Source #

Write "hello world" to a UVStream.

echo :: UVStream -> IO () Source #

Echo whatever received bytes.

Internal helper

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

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

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

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 Source #