Ghci.Server

Documentation

This modules implements a websocket server whose state survives GHCi reloads. To use it, run start once per GHCi session, and then use sendText, sendHtml and sendPlot to show the values on all clients that are currently connected.

start :: IO ()

Start the server with default settings (HTTP on port 3000, websockets on port 9160)

startConfig :: Config -> IO ()

Start the websocket and HTTP servers using the config

Sending messages

sendText :: Text -> IO ()

Show a string.

>>> sendText "hello"

sendHtml :: Text -> IO ()

Insert some HTML into the DOM.

>>> sendHtml "<h1>Hello</h1>"

sendPlot :: [(Double, Double)] -> IO ()

Show a Plotly 2D line plot of the given points.

>>> sendPlot [(1, 2), (2, 5), (3, 4), (4, 3)]

>>> sendPlot $ fmap (\i -> let i' = (fromIntegral i / 10) in (i', sin i')) [1..100]

Configuration

data Config

Server configuration

data Verbosity

What to do with log messages

Constructors

Verbose

Write all log messages to stdout

Silent

Ignore all log messages

Instances

Eq Verbosity

Defined in Ghci.Server.Config

Methods

(==) :: Verbosity -> Verbosity -> Bool

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

Ord Verbosity

Defined in Ghci.Server.Config

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

Defined in Ghci.Server.Config

Methods

showsPrec :: Int -> Verbosity -> ShowS

show :: Verbosity -> String

showList :: [Verbosity] -> ShowS

defaultConfig :: Config

Default config, use ports 9160 (websockets) and 3000 (http) and ignore all log messages.

cfHTTPPort :: Config -> Int

HTTP port

cfVerbosity :: Config -> Verbosity

What to do with log messages

cfWSPort :: Config -> Int

Websocket port