Safe Haskell	None
Language	Haskell2010

Ghci.Websockets

Contents

Configuration

Synopsis

initialise :: Config -> IO ()
initialiseDef :: IO ()
broadcast :: ToJSON a => a -> IO ()
data Config = Config {
- port :: Int
- verbosity :: Verbosity
}
data Verbosity
- = Verbose
- | Silent
defaultConfig :: Config

Documentation

This modules implements a websocket server whose state survives GHCi reloads. To use it, run initialiseDef once per GHCi session, and then call broadcast to send a JSON value to all clients that are currently connected. All messages from clients are ignored.

initialise :: Config -> IO () Source #

Start the websocket server using the port specified in the config. Call once per GHCi session.

initialiseDef :: IO () Source #

Start the websocket server using the default config (port 9160). Call once per GHCi session.

broadcast :: ToJSON a => a -> IO () Source #

Send a JSON object to all clients. Throws an exception if initialise has not been run first.

Configuration

data Config Source #

Server configuration

Constructors

Config
Fields port :: Int What port to start the server on verbosity :: Verbosity What to do with log messages

data Verbosity Source #

What to do with log messages

Constructors

Verbose	Write all log messages to stdout
Silent	Ignore all log messages

Instances

Eq Verbosity Source #
Instance details Defined in Ghci.Websockets Methods (==) :: Verbosity -> Verbosity -> Bool # (/=) :: Verbosity -> Verbosity -> Bool #
Ord Verbosity Source #
Instance details Defined in Ghci.Websockets Methods compare :: Verbosity -> Verbosity -> Ordering # (<) :: Verbosity -> Verbosity -> Bool # (<=) :: Verbosity -> Verbosity -> Bool # (>) :: Verbosity -> Verbosity -> Bool # (>=) :: Verbosity -> Verbosity -> Bool # max :: Verbosity -> Verbosity -> Verbosity # min :: Verbosity -> Verbosity -> Verbosity #
Show Verbosity Source #
Instance details Defined in Ghci.Websockets Methods showsPrec :: Int -> Verbosity -> ShowS # show :: Verbosity -> String # showList :: [Verbosity] -> ShowS #

defaultConfig :: Config Source #

Default config, use port 9160 and ignore all log messages.