Servant.API.WebSocket

Documentation

data WebSocket

Endpoint for defining a route to provide a web socket. The handler function gets an already negotiated websocket Connection to send and receive data.

Example:

type WebSocketApi = "stream" :> WebSocket

server :: Server WebSocketApi
server = streamData
 where
  streamData :: MonadIO m => Connection -> m ()
  streamData c = liftIO . forM_ [1..] $ \i -> do
    forkPingThread c 10
    sendTextData c (pack $ show (i :: Int)) >> threadDelay 1000000

Instances

HasServer * WebSocket ctx

Associated Types

type ServerT WebSocket (ctx :: WebSocket) (m :: * -> *) :: *

Methods

route :: Proxy WebSocket ctx -> Context context -> Delayed env (Server WebSocket ctx) -> Router env

type ServerT * WebSocket m

type ServerT * WebSocket m = Connection -> m ()