Moduleservant-websockets-2.0.0Haskell2010

Servant.API.WebSocket

2 types

Packageservant-websockets-2.0.0
Exports2
LanguageHaskell2010
LicenceBSD-3-Clause
SourceWebSocket.hs

datadata 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 = do
    liftIO $ forkPingThread c 10
    liftIO . forM_ [1..] $ \i -> do
       sendTextData c (pack $ show (i :: Int)) >> threadDelay 1000000

Instances2HasServer, ServerT

HasServer WebSocket ctxDefined in servant-websockets-2.0.0 · Servant.API.WebSocket
type ServerT WebSocket m = Connection -> m ()Defined in servant-websockets-2.0.0 · Servant.API.WebSocket

datadata WebSocketPending

Endpoint for defining a route to provide a web socket. The handler function gets a PendingConnection. It can either rejectRequest or acceptRequest. This function is provided for greater flexibility to reject connections.

Example:

type WebSocketApi = "stream" :> WebSocketPending

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

Instances2HasServer, ServerT

HasServer WebSocketPending ctxDefined in servant-websockets-2.0.0 · Servant.API.WebSocket
type ServerT WebSocketPending m = PendingConnection -> m ()Defined in servant-websockets-2.0.0 · Servant.API.WebSocket