Box.Websocket

Websocket components built with Boxes.

Documentation

data SocketConfig

Socket configuration

>>> defaultSocketConfig
SocketConfig {host = "127.0.0.1", port = 9160, path = "/"}

Constructors

SocketConfig

Fields

• host :: Text
• port :: Int
• path :: Text

Instances

Generic SocketConfig

Defined in Box.Websocket

Associated Types

type Rep SocketConfig :: Type -> Type

Methods

from :: SocketConfig -> Rep SocketConfig x

to :: Rep SocketConfig x -> SocketConfig

Show SocketConfig

Defined in Box.Websocket

Methods

showsPrec :: Int -> SocketConfig -> ShowS

show :: SocketConfig -> String

showList :: [SocketConfig] -> ShowS

Eq SocketConfig

Defined in Box.Websocket

Methods

(==) :: SocketConfig -> SocketConfig -> Bool

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

type Rep SocketConfig

Defined in Box.Websocket

type Rep SocketConfig = D1 ('MetaData "SocketConfig" "Box.Websocket" "box-socket-0.5.1.0-HZSvScoEvBQ2CZcs9ZHRQi" 'False) (C1 ('MetaCons "SocketConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

defaultSocketConfig :: SocketConfig

official default

connect :: SocketConfig -> Codensity IO Connection

connect an action (ie a client)

serve :: SocketConfig -> Codensity IO Connection

serve an action (ie a server)

pending :: PendingConnection -> Codensity IO Connection

Given a PendingConnection, provide a Connection continuation.

serverApp :: Box IO Text Text -> PendingConnection -> IO ()

Attach a box to a PendingConnection in wai-style.

receiver :: WebSocketsData a => Committer IO a -> Connection -> IO ()

Commit received messages, finalising on receiving a CloseRequest

receiver_ :: (WebSocketsData a, Show a) => Committer IO a -> Committer IO Text -> Connection -> IO ()

Commit received messages, finalising on receiving a CloseRequest, with event logging.

sender :: WebSocketsData a => Emitter IO a -> Connection -> IO SocketStatus

Send emitted messages, returning whether the socket remained open (the Emitter ran out of emits) or closed (a CloseRequest was received).

sender_ :: (WebSocketsData a, Show a) => Emitter IO a -> Committer IO Text -> Connection -> IO SocketStatus

Send emitted messages, returning whether the socket remained open (the Emitter ran out of emits) or closed (a CloseRequest was received). With event logging.

duplex :: WebSocketsData a => PostSend -> Box IO a a -> Connection -> IO ()

A two-way connection. Closes if it receives a CloseRequest exception, or if PostSend is CloseAfter.

duplex_ :: (WebSocketsData a, Show a) => PostSend -> Committer IO Text -> Box IO a a -> Connection -> IO ()

A two-way connection. Closes if it receives a CloseRequest exception, or if PostSend is CloseAfter. With event logging.

clientBox :: WebSocketsData a => SocketConfig -> PostSend -> Box IO a a -> IO ()

A Box action for a client.

clientCoBox :: WebSocketsData a => SocketConfig -> PostSend -> CoBox IO a a

A client CoBox.

serverBox :: WebSocketsData a => SocketConfig -> PostSend -> Box IO a a -> IO ()

A Box action for a server.

serverCoBox :: WebSocketsData a => SocketConfig -> PostSend -> CoBox IO a a

A server CoBox.

responseServer :: WebSocketsData a => SocketConfig -> (a -> Maybe a) -> IO ()

A receiver that applies a response function to received messages.