Copyright	(c) digitally induced GmbH 2020
Safe Haskell	Safe-Inferred

IHP.WebSocket

Contents

Orphan instances

Description

Synopsis

class WSApp state where
- initialState :: state
- run :: (?state :: IORef state, ?context :: ControllerContext, ?applicationContext :: ApplicationContext, ?modelContext :: ModelContext, ?connection :: Connection) => IO ()
- onPing :: (?state :: IORef state, ?context :: ControllerContext, ?applicationContext :: ApplicationContext, ?modelContext :: ModelContext, ?connection :: Connection) => IO ()
- onClose :: (?state :: IORef state, ?context :: ControllerContext, ?applicationContext :: ApplicationContext, ?modelContext :: ModelContext, ?connection :: Connection) => IO ()
- connectionOptions :: ConnectionOptions
startWSApp :: forall state. (WSApp state, ?applicationContext :: ApplicationContext, ?requestContext :: RequestContext, ?context :: ControllerContext, ?modelContext :: ModelContext) => Connection -> IO ()
setState :: (?state :: IORef state) => state -> IO ()
getState :: (?state :: IORef state) => IO state
receiveData :: (?connection :: Connection, WebSocketsData a) => IO a
receiveDataMessage :: (?connection :: Connection) => IO DataMessage
sendTextData :: (?connection :: Connection, WebSocketsData text) => text -> IO ()
sendJSON :: (?connection :: Connection, ToJSON value) => value -> IO ()

Documentation

class WSApp state where Source #

Minimal complete definition

initialState

Methods

initialState :: state Source #

run :: (?state :: IORef state, ?context :: ControllerContext, ?applicationContext :: ApplicationContext, ?modelContext :: ModelContext, ?connection :: Connection) => IO () Source #

onPing :: (?state :: IORef state, ?context :: ControllerContext, ?applicationContext :: ApplicationContext, ?modelContext :: ModelContext, ?connection :: Connection) => IO () Source #

onClose :: (?state :: IORef state, ?context :: ControllerContext, ?applicationContext :: ApplicationContext, ?modelContext :: ModelContext, ?connection :: Connection) => IO () Source #

connectionOptions :: ConnectionOptions Source #

Provide WebSocket Connection Options

See All Config Options Here https://hackage.haskell.org/package/websockets/docs/Network-WebSockets-Connection.html#t:ConnectionOptions

Example: Enable default permessage-deflate compression

connectionOptions =
    WebSocket.defaultConnectionOptions {
        WebSocket.connectionCompressionOptions =
            WebSocket.PermessageDeflateCompression WebSocket.defaultPermessageDeflate
    }

Instances

Instances details

WSApp AutoRefreshWSApp Source #
Instance details Defined in IHP.AutoRefresh Methods initialState :: AutoRefreshWSApp Source # run :: IO () Source # onPing :: IO () Source # onClose :: IO () Source # connectionOptions :: ConnectionOptions Source #
(ToField (PrimaryKey (GetTableName CurrentUserRecord)), Show (PrimaryKey (GetTableName CurrentUserRecord)), HasNewSessionUrl CurrentUserRecord, Typeable CurrentUserRecord, HasField "id" CurrentUserRecord (Id' (GetTableName CurrentUserRecord))) => WSApp DataSyncController Source #
Instance details Defined in IHP.DataSync.Controller Methods initialState :: DataSyncController Source # run :: IO () Source # onPing :: IO () Source # onClose :: IO () Source # connectionOptions :: ConnectionOptions Source #
(Component component controller, FromJSON controller) => WSApp (ComponentsController component) Source #
Instance details Defined in IHP.ServerSideComponent.Controller.ComponentsController Methods initialState :: ComponentsController component Source # run :: IO () Source # onPing :: IO () Source # onClose :: IO () Source # connectionOptions :: ConnectionOptions Source #

startWSApp :: forall state. (WSApp state, ?applicationContext :: ApplicationContext, ?requestContext :: RequestContext, ?context :: ControllerContext, ?modelContext :: ModelContext) => Connection -> IO () Source #

setState :: (?state :: IORef state) => state -> IO () Source #

getState :: (?state :: IORef state) => IO state Source #

receiveData :: (?connection :: Connection, WebSocketsData a) => IO a Source #

receiveDataMessage :: (?connection :: Connection) => IO DataMessage Source #

sendTextData :: (?connection :: Connection, WebSocketsData text) => text -> IO () Source #

sendJSON :: (?connection :: Connection, ToJSON value) => value -> IO () Source #

Json encode a payload and send it over the websocket wire

Example:

message <- Aeson.decode <$> receiveData @LByteString

case message of
    Just decodedMessage -> handleMessage decodedMessage
    Nothing -> sendJSON FailedToDecodeMessageError

Orphan instances

WebSocketsData UUID Source #
Instance details Methods fromDataMessage :: DataMessage -> UUID fromLazyByteString :: ByteString -> UUID toLazyByteString :: UUID -> ByteString