Copyright(c) digitally induced GmbH 2020
Safe HaskellNone

IHP.AutoRefresh

Description

 
Synopsis

Documentation

initAutoRefresh :: (?applicationContext :: ApplicationContext) => TMap -> IO TMap Source #

autoRefresh :: (?theAction :: action, Controller action, ?controllerContext :: ControllerContext, ?modelContext :: ModelContext, ?requestContext :: RequestContext) => ((?modelContext :: ModelContext) => IO ()) -> IO () Source #

data AutoRefreshWSApp Source #

Instances

Instances details
WSApp AutoRefreshWSApp Source # 
Instance details

Defined in IHP.AutoRefresh

getAvailableSessions :: (?requestContext :: RequestContext) => IORef AutoRefreshServer -> IO [UUID] Source #

Returns the ids of all sessions available to the client based on what sessions are found in the session cookie

getSessionById :: (?applicationContext :: ApplicationContext) => UUID -> IO AutoRefreshSession Source #

Returns a session for a given session id. Errors in case the session does not exist.

updateSession :: (?applicationContext :: ApplicationContext) => UUID -> (AutoRefreshSession -> AutoRefreshSession) -> IO () Source #

Applies a update function to a session specified by its session id

gcSessions :: IORef AutoRefreshServer -> IO () Source #

Removes all expired sessions

This is useful to avoid dead sessions hanging around. This can happen when a websocket connection was never established after the inital request. Then the onClose of the websocket app is never called and thus the session will not be removed automatically.

isSessionExpired :: UTCTime -> AutoRefreshSession -> Bool Source #

A session is expired if it wasn't pinged in the last 60 seconds