Safe Haskell	Safe-Inferred
Language	GHC2021

Butler.Display.Client

Contents

Display client
Html output
Binary output
Inputs
Management thread
Collection of clients
Internal

Description

This module contains the DisplayClient logic.

Synopsis

data DisplayClient = DisplayClient {
- conn :: Connection
- endpoint :: Endpoint
- process :: Process
- session :: Session
- recv :: TVar Word64
- send :: TVar Word64
- sendChannel :: TChan DataMessage
}
sendHtml :: DisplayClient -> HtmlT STM () -> STM ()
sendsHtml :: DisplayClients -> HtmlT STM () -> ProcessIO ()
sendsHtmlButSelf :: DisplayClient -> DisplayClients -> HtmlT STM () -> ProcessIO ()
clientsDraw :: DisplayClients -> (DisplayClient -> ProcessIO (HtmlT STM ())) -> ProcessIO ()
sendBinary :: DisplayClient -> LByteString -> STM ()
sendsBinary :: DisplayClients -> LByteString -> ProcessIO ()
sendsBinaryButSelf :: DisplayClient -> DisplayClients -> LByteString -> ProcessIO ()
recvData :: MonadIO m => DisplayClient -> m DataMessage
recvBinary :: MonadIO m => DisplayClient -> m ByteString
pingThread :: DisplayClient -> ProcessIO Void
sendThread :: DisplayClient -> ProcessIO Void
data DisplayClients
newDisplayClients :: STM DisplayClients
getClients :: DisplayClients -> STM [DisplayClient]
addClient :: DisplayClients -> DisplayClient -> STM ()
delClient :: DisplayClients -> DisplayClient -> STM ()
newClient :: Connection -> Endpoint -> Process -> Session -> STM DisplayClient
newtype Endpoint = Endpoint Text

Display client

data DisplayClient #

A network client. Note that the sendThread must be running for the send* function to work.

Constructors

DisplayClient
Fields conn :: Connection endpoint :: Endpoint process :: Process session :: Session recv :: TVar Word64 send :: TVar Word64 sendChannel :: TChan DataMessage

Instances

Instances details

ToJSON DisplayClient #
Instance details Defined in Butler.Display.Client Methods toJSON :: DisplayClient -> Value # toEncoding :: DisplayClient -> Encoding # toJSONList :: [DisplayClient] -> Value # toEncodingList :: [DisplayClient] -> Encoding #

Html output

sendHtml :: DisplayClient -> HtmlT STM () -> STM () #

Send Html to a client.

sendsHtml :: DisplayClients -> HtmlT STM () -> ProcessIO () #

Send Html to all clients.

sendsHtmlButSelf :: DisplayClient -> DisplayClients -> HtmlT STM () -> ProcessIO () #

Send Html to all clients except the provided one (self).

clientsDraw :: DisplayClients -> (DisplayClient -> ProcessIO (HtmlT STM ())) -> ProcessIO () #

Send html using a draw action.

Binary output

sendBinary :: DisplayClient -> LByteString -> STM () #

Send binary to a client.

sendsBinary :: DisplayClients -> LByteString -> ProcessIO () #

Send binary to all clients.

sendsBinaryButSelf :: DisplayClient -> DisplayClients -> LByteString -> ProcessIO () #

Send binary to all clients except the provided one (self).

Inputs

recvData :: MonadIO m => DisplayClient -> m DataMessage #

Low-level helper to read a DataMessage.

recvBinary :: MonadIO m => DisplayClient -> m ByteString #

Low-level helper to read a binary buffer.

Management thread

pingThread :: DisplayClient -> ProcessIO Void #

An action to keep a client alive.

sendThread :: DisplayClient -> ProcessIO Void #

An action to send data message.

Collection of clients

data DisplayClients #

A collection of clients.

newDisplayClients :: STM DisplayClients #

getClients :: DisplayClients -> STM [DisplayClient] #

addClient :: DisplayClients -> DisplayClient -> STM () #

delClient :: DisplayClients -> DisplayClient -> STM () #

Internal

newClient :: Connection -> Endpoint -> Process -> Session -> STM DisplayClient #

newtype Endpoint #

Constructors

Endpoint Text

Instances

Instances details

FromJSON Endpoint #
Instance details Defined in Butler.Display.Client Methods parseJSON :: Value -> Parser Endpoint # parseJSONList :: Value -> Parser [Endpoint] #
ToJSON Endpoint #
Instance details Defined in Butler.Display.Client Methods toJSON :: Endpoint -> Value # toEncoding :: Endpoint -> Encoding # toJSONList :: [Endpoint] -> Value # toEncodingList :: [Endpoint] -> Encoding #
IsString Endpoint #
Instance details Defined in Butler.Display.Client Methods fromString :: String -> Endpoint #
Show Endpoint #
Instance details Defined in Butler.Display.Client Methods showsPrec :: Int -> Endpoint -> ShowS # show :: Endpoint -> String # showList :: [Endpoint] -> ShowS #
Eq Endpoint #
Instance details Defined in Butler.Display.Client Methods (==) :: Endpoint -> Endpoint -> Bool # (/=) :: Endpoint -> Endpoint -> Bool #
Ord Endpoint #
Instance details Defined in Butler.Display.Client Methods compare :: Endpoint -> Endpoint -> Ordering # (<) :: Endpoint -> Endpoint -> Bool # (<=) :: Endpoint -> Endpoint -> Bool # (>) :: Endpoint -> Endpoint -> Bool # (>=) :: Endpoint -> Endpoint -> Bool # max :: Endpoint -> Endpoint -> Endpoint # min :: Endpoint -> Endpoint -> Endpoint #
ToHtml Endpoint #
Instance details Defined in Butler.Display.Client Methods toHtml :: forall (m :: Type -> Type). Monad m => Endpoint -> HtmlT m () # toHtmlRaw :: forall (m :: Type -> Type). Monad m => Endpoint -> HtmlT m () #