Servant.Subscriber.Client

Documentation

type ClientMonitors = Map HttpRequest StatusMonitor

data Client api

Constructors

Client

Fields

• subscriber :: !(Subscriber api)
• monitors :: !(TVar ClientMonitors)
• readRequest :: !(IO (Maybe Request))
• writeResponse :: !(Response -> IO ())
• pongCommandRef :: !(IORef (IO ()))
• closeCommandRef :: !(TVar (IO ()))

data StatusMonitor

Constructors

StatusMonitor

Fields

• request :: !HttpRequest
• monitor :: !(TVar (RefCounted ResourceStatus))
• oldStatus :: !(Maybe ResourceStatus)

data Snapshot

Constructors

Snapshot

Fields

• snapshotCurrent :: ResourceStatus
• fullMonitor :: StatusMonitor

snapshotOld :: Snapshot -> Maybe ResourceStatus

monitorPath :: StatusMonitor -> Path

toSnapshot :: StatusMonitor -> STM Snapshot

snapshotRequest :: Snapshot -> HttpRequest

fromWebSocket :: Subscriber api -> IORef (IO ()) -> Connection -> STM (Client api)

run :: (MonadLogger m, MonadBaseControl IO m, MonadIO m, Backend backend) => backend -> Client api -> m ()

addRequest :: HttpRequest -> Client api -> STM ()

removeRequest :: Client api -> HttpRequest -> STM ()

Remove a Request, also unsubscribes from subscriber and deletes our monitor if it was the last Request for the given path.

unsubscribeMonitor :: Subscriber api -> StatusMonitor -> STM ()

Does not remove the monitor - use removeRequest if you want this!

handleRequests :: Backend backend => backend -> Client api -> IO ()

handleSubscribe :: Client api -> HttpRequest -> IO ()

handleUnsubscribe :: Client api -> HttpRequest -> IO ()

runMonitor :: Backend backend => backend -> Client api -> IO ()

handleUpdates :: Backend backend => backend -> Client api -> (HttpRequest, ResourceStatus) -> IO ()

handleModified :: Backend backend => backend -> Client api -> HttpRequest -> IO ()

getServerResponse :: Backend backend => backend -> HttpRequest -> (Response -> IO ()) -> IO ()

monitorChanges :: Client api -> STM [(HttpRequest, ResourceStatus)]

getChanges :: [Snapshot] -> [(HttpRequest, ResourceStatus)]

monitorChanged :: Snapshot -> Bool

toChangeReport :: Snapshot -> (HttpRequest, ResourceStatus)

updateMonitors :: [Snapshot] -> [StatusMonitor]

updateOldStatus :: Snapshot -> StatusMonitor

monitorsFromList :: [StatusMonitor] -> ClientMonitors