Web.Dependencies.Sparrow.Server.Types

Context

data SparrowServerT http f m a

Instances

MonadWriter w m => MonadWriter w (SparrowServerT http f m)

Methods

writer :: (a, w) -> SparrowServerT http f m a

tell :: w -> SparrowServerT http f m ()

listen :: SparrowServerT http f m a -> SparrowServerT http f m (a, w)

pass :: SparrowServerT http f m (a, w -> w) -> SparrowServerT http f m a

MonadState s m => MonadState s (SparrowServerT http f m)

Methods

get :: SparrowServerT http f m s

put :: s -> SparrowServerT http f m ()

state :: (s -> (a, s)) -> SparrowServerT http f m a

MonadReader r m => MonadReader r (SparrowServerT http f m)

Methods

ask :: SparrowServerT http f m r

local :: (r -> r) -> SparrowServerT http f m a -> SparrowServerT http f m a

reader :: (r -> a) -> SparrowServerT http f m a

MonadTrans (SparrowServerT http f)

Methods

lift :: Monad m => m a -> SparrowServerT http f m a

Monad m => Monad (SparrowServerT http f m)

Methods

(>>=) :: SparrowServerT http f m a -> (a -> SparrowServerT http f m b) -> SparrowServerT http f m b

(>>) :: SparrowServerT http f m a -> SparrowServerT http f m b -> SparrowServerT http f m b

return :: a -> SparrowServerT http f m a

fail :: String -> SparrowServerT http f m a

Functor m => Functor (SparrowServerT http f m)

Methods

fmap :: (a -> b) -> SparrowServerT http f m a -> SparrowServerT http f m b

(<$) :: a -> SparrowServerT http f m b -> SparrowServerT http f m a

Monad m => Applicative (SparrowServerT http f m)

Methods

pure :: a -> SparrowServerT http f m a

(<*>) :: SparrowServerT http f m (a -> b) -> SparrowServerT http f m a -> SparrowServerT http f m b

liftA2 :: (a -> b -> c) -> SparrowServerT http f m a -> SparrowServerT http f m b -> SparrowServerT http f m c

(*>) :: SparrowServerT http f m a -> SparrowServerT http f m b -> SparrowServerT http f m b

(<*) :: SparrowServerT http f m a -> SparrowServerT http f m b -> SparrowServerT http f m a

MonadIO m => MonadIO (SparrowServerT http f m)

Methods

liftIO :: IO a -> SparrowServerT http f m a

MonadThrow m => MonadThrow (SparrowServerT http f m)

Methods

throwM :: Exception e => e -> SparrowServerT http f m a

MonadCatch m => MonadCatch (SparrowServerT http f m)

Methods

catch :: Exception e => SparrowServerT http f m a -> (e -> SparrowServerT http f m a) -> SparrowServerT http f m a

MonadMask m => MonadMask (SparrowServerT http f m)

Methods

mask :: ((forall a. SparrowServerT http f m a -> SparrowServerT http f m a) -> SparrowServerT http f m b) -> SparrowServerT http f m b

uninterruptibleMask :: ((forall a. SparrowServerT http f m a -> SparrowServerT http f m a) -> SparrowServerT http f m b) -> SparrowServerT http f m b

generalBracket :: SparrowServerT http f m a -> (a -> ExitCase b -> SparrowServerT http f m c) -> (a -> SparrowServerT http f m b) -> SparrowServerT http f m (b, c)

data Env f m

Constructors

Env

Fields

• envSessionsOutgoing :: !SessionsOutgoing
• envRegisteredReceive :: !(RegisteredReceive m)
• envRegisteredTopicInvalidators :: !RegisteredTopicInvalidators
• envRegisteredTopicSubscribers :: !RegisteredTopicSubscribers
• envRegisteredOnUnsubscribe :: !(RegisteredOnUnsubscribe m)
• envRegisteredOnOpenThreads :: !(RegisteredOnOpenThreads f)

newEnv :: IO (Env f m)

execSparrowServerT :: MonadIO m => SparrowServerT http f m a -> m (Paper http, Env f m)

execSparrowServerT' :: Monad m => Env f m -> SparrowServerT http f m a -> m (Paper http)

tell' :: Monad m => Paper http -> SparrowServerT http f m ()

ask' :: Monad m => SparrowServerT http f m (Env f m)

Internal Machinery

Outgoing Per-Session

unsafeBroadcastTopic :: MonadIO m => Env f m -> Topic -> Value -> m ()

unsafeRegisterReceive :: MonadIO m => Env f m -> SessionID -> Topic -> (Value -> Maybe (m ())) -> STM ()

sendTo :: Env f m -> SessionID -> WSOutgoing (WithTopic Value) -> STM ()

Continuation Registration

registerOnUnsubscribe :: Env f m -> SessionID -> Topic -> m () -> STM ()

registerInvalidator :: forall deltaIn f m. FromJSON deltaIn => Env f m -> Topic -> Proxy deltaIn -> STM ()

broadcaster :: MonadIO m => Env f m -> Broadcast m

getCurrentRegisteredTopics :: Env f m -> SessionID -> STM [Topic]

getCallReceive :: MonadIO m => Env f m -> SessionID -> Topic -> Value -> STM (Maybe (m ()))

callOnUnsubscribe :: MonadIO m => Env f m -> SessionID -> Topic -> m ()

callAllOnUnsubscribe :: MonadIO m => Env f m -> SessionID -> m ()

Thread Management

registerOnOpenThreads :: Env f m -> SessionID -> Topic -> TVar (f (Async ())) -> STM ()

killOnOpenThreads :: Foldable f => MonadIO m => Env f m -> SessionID -> Topic -> IO ()

killAllOnOpenThreads :: Foldable f => Alternative f => MonadIO m => Env f m -> SessionID -> IO ()

Bookkeeping

unregisterReceive :: Env f m -> SessionID -> Topic -> STM ()

unregisterSession :: Env f m -> SessionID -> STM ()

addSubscriber :: Env f m -> Topic -> SessionID -> STM ()

delSubscriber :: Env f m -> Topic -> SessionID -> STM ()

delSubscriberFromAllTopics :: Env f m -> SessionID -> STM ()

Exceptions

data SparrowServerException

Constructors

NoHandlerForTopic Topic

Instances

Show SparrowServerException

Methods

showsPrec :: Int -> SparrowServerException -> ShowS

show :: SparrowServerException -> String

showList :: [SparrowServerException] -> ShowS

Generic SparrowServerException

Associated Types

type Rep SparrowServerException :: * -> *

Methods

from :: SparrowServerException -> Rep SparrowServerException x

to :: Rep SparrowServerException x -> SparrowServerException

Exception SparrowServerException

Methods

toException :: SparrowServerException -> SomeException

fromException :: SomeException -> Maybe SparrowServerException

displayException :: SparrowServerException -> String

type Rep SparrowServerException

type Rep SparrowServerException = D1 * (MetaData "SparrowServerException" "Web.Dependencies.Sparrow.Server.Types" "sparrow-0.0.2.1-EDuzhDlDkcsFyZg7mPmE7y" False) (C1 * (MetaCons "NoHandlerForTopic" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Topic)))