Box.TCP

TCP Boxes.

Documentation

data TCPConfig

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

Generic TCPConfig

Defined in Box.TCP

Associated Types

type Rep TCPConfig :: Type -> Type

Methods

from :: TCPConfig -> Rep TCPConfig x

to :: Rep TCPConfig x -> TCPConfig

Show TCPConfig

Defined in Box.TCP

Methods

showsPrec :: Int -> TCPConfig -> ShowS

show :: TCPConfig -> String

showList :: [TCPConfig] -> ShowS

Eq TCPConfig

Defined in Box.TCP

Methods

(==) :: TCPConfig -> TCPConfig -> Bool

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

type Rep TCPConfig

Defined in Box.TCP

type Rep TCPConfig = D1 ('MetaData "TCPConfig" "Box.TCP" "box-socket-0.5.1.0-HZSvScoEvBQ2CZcs9ZHRQi" '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

default

data TCPEnv

An active TCP environment

Constructors

TCPEnv

Fields

• socket :: Socket
• sockaddr :: SockAddr

data Socket

Basic type for a socket.

Instances

Show Socket

Defined in Network.Socket.Types

Methods

showsPrec :: Int -> Socket -> ShowS

show :: Socket -> String

showList :: [Socket] -> ShowS

Eq Socket

Defined in Network.Socket.Types

Methods

(==) :: Socket -> Socket -> Bool

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

connect :: TCPConfig -> Codensity IO TCPEnv

connect an action (ie a client)

serve :: TCPConfig -> Codensity IO TCPEnv

serve an action (ie a server)

receiver :: TCPConfig -> Committer IO ByteString -> Socket -> IO ()

Commit received ByteStrings.

sender :: Emitter IO ByteString -> Socket -> IO SocketStatus

Send emitted ByteStrings.

duplex :: TCPConfig -> PostSend -> Box IO ByteString ByteString -> Socket -> IO ()

A two-way connection.

clientBox :: TCPConfig -> PostSend -> Box IO ByteString ByteString -> IO ()

A Box action for a client.

clientCoBox :: TCPConfig -> PostSend -> CoBox IO ByteString ByteString

A client CoBox.

serverBox :: TCPConfig -> PostSend -> Box IO ByteString ByteString -> IO ()

A Box action for a server.

serverCoBox :: TCPConfig -> PostSend -> CoBox IO ByteString ByteString

A server CoBox.

responseServer :: TCPConfig -> (ByteString -> Maybe ByteString) -> IO ()

A receiver that applies a response function to received ByteStrings.