Safe Haskell	None
Language	GHC2021

Box.TCP

Description

TCP Boxes.

Synopsis

data TCPConfig = TCPConfig {
- hostPreference :: HostPreference
- host :: Text
- port :: Text
- chunk :: Int
- endLine :: Text
}
defaultTCPConfig :: TCPConfig
data TCPEnv = TCPEnv {
- socket :: Socket
- sockaddr :: SockAddr
}
data Socket
connect :: TCPConfig -> Codensity IO TCPEnv
serve :: TCPConfig -> Codensity IO TCPEnv
receiver :: TCPConfig -> Committer IO ByteString -> Socket -> IO ()
sender :: Emitter IO ByteString -> Socket -> IO SocketStatus
duplex :: TCPConfig -> PostSend -> Box IO ByteString ByteString -> Socket -> IO ()
clientBox :: TCPConfig -> PostSend -> Box IO ByteString ByteString -> IO ()
clientCoBox :: TCPConfig -> PostSend -> CoBox IO ByteString ByteString
serverBox :: TCPConfig -> PostSend -> Box IO ByteString ByteString -> IO ()
serverCoBox :: TCPConfig -> PostSend -> CoBox IO ByteString ByteString
responseServer :: TCPConfig -> (ByteString -> Maybe ByteString) -> IO ()

Documentation

data TCPConfig Source #

TCP configuration

>>> defaultTCPConfig
TCPConfig {hostPreference = HostAny, host = "127.0.0.1", port = "3566", chunk = 2048, endLine = "\n"}

Constructors

TCPConfig
Fields hostPreference :: HostPreference host :: Text port :: Text chunk :: Int endLine :: Text

Instances

Instances details

Generic TCPConfig Source #

Instance details

Defined in Box.TCP

Associated Types

type Rep TCPConfig

Instance details

Defined in Box.TCP

type Rep TCPConfig = D1 ('MetaData "TCPConfig" "Box.TCP" "box-socket-0.5.2.0-CEfqd3FEkh6BGAByozsM9U" 'False) (C1 ('MetaCons "TCPConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "hostPreference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HostPreference) :*: S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "chunk") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "endLine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))

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.5.2.0-CEfqd3FEkh6BGAByozsM9U" 'False) (C1 ('MetaCons "TCPConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "hostPreference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HostPreference) :*: S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "chunk") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "endLine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))

defaultTCPConfig :: TCPConfig Source #

default

data TCPEnv Source #

An active TCP environment

Constructors

TCPEnv
Fields socket :: Socket sockaddr :: SockAddr

data Socket #

Basic type for a socket.

Instances

Instances details

Show Socket
Instance details Defined in Network.Socket.Types Methods showsPrec :: Int -> Socket -> ShowS # show :: Socket -> String # showList :: [Socket] -> ShowS #
Eq Socket
Instance details Defined in Network.Socket.Types Methods (==) :: Socket -> Socket -> Bool # (/=) :: Socket -> Socket -> Bool #