Copyright	(c) digitally induced GmbH 2020
Safe Haskell	None

IHP.WebSocket

Contents

Description

Documentation

class WSApp state where Source #

Minimal complete definition

Methods

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 #

Instances details

WSApp AutoRefreshWSApp Source #
Instance details Defined in IHP.AutoRefresh Methods initialState :: AutoRefreshWSApp Source # run :: IO () Source # onPing :: IO () Source # onClose :: IO () 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 #
(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 #

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 #

Orphan instances

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