Web.Dependencies.Sparrow.Server.Types

Context

data SparrowServerT http m a

Instances

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

Methods

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

tell :: w -> SparrowServerT http m ()

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

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

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

Methods

get :: SparrowServerT http m s

put :: s -> SparrowServerT http m ()

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

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

Methods

ask :: SparrowServerT http m r

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

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

MonadTrans (SparrowServerT http)

Methods

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

Monad m => Monad (SparrowServerT http m)

Methods

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

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

return :: a -> SparrowServerT http m a

fail :: String -> SparrowServerT http m a

Functor m => Functor (SparrowServerT http m)

Methods

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

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

Monad m => Applicative (SparrowServerT http m)

Methods

pure :: a -> SparrowServerT http m a

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

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

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

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

MonadIO m => MonadIO (SparrowServerT http m)

Methods

liftIO :: IO a -> SparrowServerT http m a

MonadThrow m => MonadThrow (SparrowServerT http m)

Methods

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

MonadCatch m => MonadCatch (SparrowServerT http m)

Methods

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

MonadMask m => MonadMask (SparrowServerT http m)

Methods

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

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

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

data Env m

Constructors

Env

Fields

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

newEnv :: IO (Env m)

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

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

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

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

Internal Machinery

Outgoing Per-Session

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

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

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

Continuation Registration

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

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

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

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

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

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

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

Thread Management

registerOnOpenThread :: Env m -> SessionID -> Topic -> Async () -> STM ()

killOnOpenThread :: MonadIO m => Env m -> SessionID -> Topic -> IO ()

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

Bookkeeping

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

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

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

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

delSubscriberFromAllTopics :: Env 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.1.2-E3S88fH87X7KfYDlvxyZIs" False) (C1 * (MetaCons "NoHandlerForTopic" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Topic)))