Safe Haskell	Safe-Inferred
Language	GHC2021

Butler.Display.WebSocket

Synopsis

type WebSocketAPI = RemoteHost :> ClientAPI
type OnWSConnect session = SockAddr -> OnConnect session
websocketServer :: GetSession session -> OnWSConnect session -> ServerT WebSocketAPI ProcessIO
splashHtml :: Monad m => HtmlT m () -> HtmlT m ()
newtype ChannelName = ChannelName Text
newtype Workspace = Workspace Text

Documentation

type WebSocketAPI = RemoteHost :> ClientAPI #

type OnWSConnect session = SockAddr -> OnConnect session #

websocketServer :: GetSession session -> OnWSConnect session -> ServerT WebSocketAPI ProcessIO #

splashHtml :: Monad m => HtmlT m () -> HtmlT m () #

Display the content in a splash screen

newtype ChannelName #

Constructors

ChannelName Text

Instances

Instances details

ToJSON ChannelName #
Instance details Defined in Butler.Display.WebSocket Methods toJSON :: ChannelName -> Value # toEncoding :: ChannelName -> Encoding # toJSONList :: [ChannelName] -> Value # toEncodingList :: [ChannelName] -> Encoding #
IsString ChannelName #
Instance details Defined in Butler.Display.WebSocket Methods fromString :: String -> ChannelName #
Show ChannelName #
Instance details Defined in Butler.Display.WebSocket Methods showsPrec :: Int -> ChannelName -> ShowS # show :: ChannelName -> String # showList :: [ChannelName] -> ShowS #
Eq ChannelName #
Instance details Defined in Butler.Display.WebSocket Methods (==) :: ChannelName -> ChannelName -> Bool # (/=) :: ChannelName -> ChannelName -> Bool #
Ord ChannelName #
Instance details Defined in Butler.Display.WebSocket Methods compare :: ChannelName -> ChannelName -> Ordering # (<) :: ChannelName -> ChannelName -> Bool # (<=) :: ChannelName -> ChannelName -> Bool # (>) :: ChannelName -> ChannelName -> Bool # (>=) :: ChannelName -> ChannelName -> Bool # max :: ChannelName -> ChannelName -> ChannelName # min :: ChannelName -> ChannelName -> ChannelName #
FromHttpApiData ChannelName #
Instance details Defined in Butler.Display.WebSocket Methods parseUrlPiece :: Text -> Either Text ChannelName # parseHeader :: ByteString -> Either Text ChannelName # parseQueryParam :: Text -> Either Text ChannelName #

newtype Workspace #

Constructors

Workspace Text

Instances

Instances details

FromJSON Workspace #
Instance details Defined in Butler.Display.WebSocket Methods parseJSON :: Value -> Parser Workspace # parseJSONList :: Value -> Parser [Workspace] #
ToJSON Workspace #
Instance details Defined in Butler.Display.WebSocket Methods toJSON :: Workspace -> Value # toEncoding :: Workspace -> Encoding # toJSONList :: [Workspace] -> Value # toEncodingList :: [Workspace] -> Encoding #
IsString Workspace #
Instance details Defined in Butler.Display.WebSocket Methods fromString :: String -> Workspace #
Show Workspace #
Instance details Defined in Butler.Display.WebSocket Methods showsPrec :: Int -> Workspace -> ShowS # show :: Workspace -> String # showList :: [Workspace] -> ShowS #
Eq Workspace #
Instance details Defined in Butler.Display.WebSocket Methods (==) :: Workspace -> Workspace -> Bool # (/=) :: Workspace -> Workspace -> Bool #
Ord Workspace #
Instance details Defined in Butler.Display.WebSocket Methods compare :: Workspace -> Workspace -> Ordering # (<) :: Workspace -> Workspace -> Bool # (<=) :: Workspace -> Workspace -> Bool # (>) :: Workspace -> Workspace -> Bool # (>=) :: Workspace -> Workspace -> Bool # max :: Workspace -> Workspace -> Workspace # min :: Workspace -> Workspace -> Workspace #
FromHttpApiData Workspace #
Instance details Defined in Butler.Display.WebSocket Methods parseUrlPiece :: Text -> Either Text Workspace # parseHeader :: ByteString -> Either Text Workspace # parseQueryParam :: Text -> Either Text Workspace #
ToHtml Workspace #
Instance details Defined in Butler.Display.WebSocket Methods toHtml :: forall (m :: Type -> Type). Monad m => Workspace -> HtmlT m () # toHtmlRaw :: forall (m :: Type -> Type). Monad m => Workspace -> HtmlT m () #
Serialise Workspace #
Instance details Defined in Butler.Display.WebSocket Methods encode :: Workspace -> Encoding # decode :: Decoder s Workspace # encodeList :: [Workspace] -> Encoding # decodeList :: Decoder s [Workspace] #
From Workspace StorageAddress #
Instance details Defined in Butler.Display.WebSocket Methods from :: Workspace -> StorageAddress #
From Workspace Text #
Instance details Defined in Butler.Display.WebSocket Methods from :: Workspace -> Text #