Box.Socket

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.Socket

Associated Types

type Rep SocketConfig :: Type -> Type

Methods

from :: SocketConfig -> Rep SocketConfig x

to :: Rep SocketConfig x -> SocketConfig

Show SocketConfig

Defined in Box.Socket

Methods

showsPrec :: Int -> SocketConfig -> ShowS

show :: SocketConfig -> String

showList :: [SocketConfig] -> ShowS

Eq SocketConfig

Defined in Box.Socket

Methods

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

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

type Rep SocketConfig

Defined in Box.Socket

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

defaultSocketConfig :: SocketConfig

official default

runClient :: SocketConfig -> ClientApp () -> IO ()

Run a client app.

runServer :: SocketConfig -> ServerApp -> IO ()

Run a server app.

connect :: PendingConnection -> Codensity IO Connection

Connection continuation.

clientApp :: Box IO (Either Text Text) Text -> Connection -> IO ()

A simple client app for a box with Left debug messages.

responderApp :: (Text -> Either Text Text) -> PendingConnection -> IO ()

Canned response function.

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

Standard server app for a box.

receiver' :: Committer IO (Either Text Text) -> Connection -> IO Bool

default websocket receiver with messages Lefts are info/debug

receiver :: Committer IO Text -> Connection -> IO ()

Receiver that only commits.

sender :: (WebSocketsData a, Show a) => Box IO Text a -> Connection -> IO ()

Sender that only emits.

responder :: (Text -> Either Text Text) -> Committer IO Text -> Connection -> IO ()

A receiver that responds based on received Text. lefts are quit signals. Rights are response text.