box-socket-0.4.1: Box websockets

Safe Haskell	Safe-Inferred
Language	Haskell2010

Box.TCP

Description

TCP Boxes.

Synopsis

data TCPConfig = TCPConfig {
- host :: Text
- port :: Text
}
defaultTCPConfig :: TCPConfig
data Env = Env {
- socket :: Socket
- sockaddr :: SockAddr
- ascreendump :: Maybe (Async ())
- afiledump :: Maybe (Async ())
}
new :: TCPConfig -> IO Env
close :: Env -> IO ()
tcpEmitter :: Socket -> Emitter IO ByteString
tcpCommitter :: Socket -> Committer IO ByteString
tcpBox :: Socket -> Box IO ByteString ByteString
tcpServer :: TCPConfig -> Box IO ByteString ByteString -> IO ()
tcpResponder :: TCPConfig -> (ByteString -> IO ByteString) -> IO ()
tcpSender :: TCPConfig -> Emitter IO ByteString -> IO ()
tcpStdClient :: TCPConfig -> IO ()
testHarness :: IO () -> IO ()
testResponder :: IO ()
testServerSender :: IO ()

Documentation

data TCPConfig Source #

TCP configuration

>>> defaultTCPConfig
TCPConfig {host = "127.0.0.1", port = "3566"}

Constructors

TCPConfig
Fields host :: Text port :: Text

Instances

Instances details

Generic TCPConfig Source #
Instance details Defined in Box.TCP Associated Types type Rep TCPConfig :: Type -> Type # Methods from :: TCPConfig -> Rep TCPConfig x # to :: Rep TCPConfig x -> TCPConfig #
Show TCPConfig Source #
Instance details Defined in Box.TCP Methods showsPrec :: Int -> TCPConfig -> ShowS # show :: TCPConfig -> String # showList :: [TCPConfig] -> ShowS #
Eq TCPConfig Source #
Instance details Defined in Box.TCP Methods (==) :: TCPConfig -> TCPConfig -> Bool # (/=) :: TCPConfig -> TCPConfig -> Bool #
type Rep TCPConfig Source #
Instance details Defined in Box.TCP type Rep TCPConfig = D1 ('MetaData "TCPConfig" "Box.TCP" "box-socket-0.4.1-LWqRyRmzNmq1mf13crzbPE" 'False) (C1 ('MetaCons "TCPConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

defaultTCPConfig :: TCPConfig Source #

default

data Env Source #

An active TCP environment

Constructors

Env
Fields socket :: Socket sockaddr :: SockAddr ascreendump :: Maybe (Async ()) A screen dump thread afiledump :: Maybe (Async ()) A file dump thread

Arguments

:: TCPConfig	Configuration
-> IO Env

Connects to a server with no screen or file dump.

close :: Env -> IO () Source #

close an Env

tcpEmitter :: Socket -> Emitter IO ByteString Source #

Emits from a Socket

tcpCommitter :: Socket -> Committer IO ByteString Source #

Commits to a Socket

tcpBox :: Socket -> Box IO ByteString ByteString Source #

Box connection for a Socket

tcpServer :: TCPConfig -> Box IO ByteString ByteString -> IO () Source #

TCP server Box

tcpResponder :: TCPConfig -> (ByteString -> IO ByteString) -> IO () Source #

A server that explicitly responds to client messages.

tcpSender :: TCPConfig -> Emitter IO ByteString -> IO () Source #

A server independent of incoming messages.

tcpStdClient :: TCPConfig -> IO () Source #

A TCP client connected to stdin

testHarness :: IO () -> IO () Source #

test harness wrapping an action with a "q" escape.

testResponder :: IO () Source #

"echo: " <> Responder

testServerSender :: IO () Source #

Test server.