Control.Distributed.Process.ManagedProcess.Server.Priority

The Prioritised Server portion of the Managed Process API.

Prioritising API Handlers

prioritiseCall :: forall s a b. (Serializable a, Serializable b) => (s -> a -> Priority b) -> DispatchPriority s

Prioritise a call handler

prioritiseCall_ :: forall s a b. (Serializable a, Serializable b) => (a -> Priority b) -> DispatchPriority s

Prioritise a call handler, ignoring the server's state

prioritiseCast :: forall s a. Serializable a => (s -> a -> Priority ()) -> DispatchPriority s

Prioritise a cast handler

prioritiseCast_ :: forall s a. Serializable a => (a -> Priority ()) -> DispatchPriority s

Prioritise a cast handler, ignoring the server's state

prioritiseInfo :: forall s a. Serializable a => (s -> a -> Priority ()) -> DispatchPriority s

Prioritise an info handler

prioritiseInfo_ :: forall s a. Serializable a => (a -> Priority ()) -> DispatchPriority s

Prioritise an info handler, ignoring the server's state

setPriority :: Int -> Priority m

Sets an explicit priority from 1..100. Values > 100 are rounded to 100, and values < 1 are set to 0.

Creating Filters

check :: forall s. FilterHandler s -> DispatchFilter s

Create a filter from a FilterHandler.

raw :: forall s. (s -> Message -> Process Bool) -> (s -> Message -> Process (Maybe (Filter s))) -> FilterHandler s

A raw filter (targetting raw messages).

raw_ :: forall s. (Message -> Process Bool) -> (s -> Message -> Process (Maybe (Filter s))) -> FilterHandler s

A raw filter that ignores the server state in its condition expression.

api :: forall s m b. (Serializable m, Serializable b) => (s -> m -> Process Bool) -> (s -> Message m b -> Process (Filter s)) -> FilterHandler s

An API filter (targetting call, cast, and chan messages).

api_ :: forall m b s. (Serializable m, Serializable b) => (m -> Process Bool) -> (s -> Message m b -> Process (Filter s)) -> FilterHandler s

An API filter that ignores the server state in its condition expression.

info :: forall s m. Serializable m => (s -> m -> Process Bool) -> (s -> m -> Process (Filter s)) -> FilterHandler s

An info filter (targetting info messages of a specific type)

info_ :: forall s m. Serializable m => (m -> Process Bool) -> (s -> m -> Process (Filter s)) -> FilterHandler s

An info filter that ignores the server state in its condition expression.

refuse :: forall s m. Serializable m => (m -> Bool) -> DispatchFilter s

Refuse messages for which the given expression evaluates to True.

reject :: forall s m r. Show r => r -> s -> m -> Process (Filter s)

Create a filter expression that will reject all messages of a specific type.

rejectApi :: forall s m b r. (Show r, Serializable m, Serializable b) => r -> s -> Message m b -> Process (Filter s)

A version of reject that deals with API messages (i.e. call, cast, etc) and in the case of a call interaction, will reject the messages and reply to the sender accordingly (with CallRejected).

store :: (s -> s) -> DispatchFilter s

Modify the server state every time a message is recieved.

storeM :: forall s m. Serializable m => (s -> m -> Process s) -> DispatchFilter s

Motify the server state when messages of a certain type arrive...

crash :: forall s. s -> ExitReason -> Process (Filter s)

Create a filter expression that will crash (i.e. stop) the server.

ensure :: forall s. (s -> Bool) -> DispatchFilter s

Ensure that the server state is consistent with the given expression each time a message arrives/is processed. If the expression evaluates to True then the filter will evaluate to FilterOk, otherwise FilterStop (which will cause the server loop to stop with ExitOther filterFail).

ensureM :: forall s m. Serializable m => (s -> m -> Process Bool) -> DispatchFilter s

As ensure but runs in the Process monad, and matches only inputs of type m.

data Filter s

Given as the result of evaluating a DispatchFilter. This type is intended for internal use. For an API for working with filters, see Control.Distributed.Process.ManagedProcess.Priority.

data DispatchFilter s

Provides dispatch from a variety of inputs to a typed filter handler.

safe :: forall s m. Serializable m => (s -> m -> Bool) -> DispatchFilter s

Given a check expression, if it evaluates to True for some input, then do not dequeue the message until after any matching handlers have successfully run, or the the unhandled message policy is chosen if none match. Thus, if an exit signal (async exception) terminates execution of a handler, and we have an installed exit handler which allows the process to continue running, we will retry the input in question since it has not been fully dequeued prior to the exit signal arriving.

apiSafe :: forall s m b. (Serializable m, Serializable b) => (s -> m -> Maybe b -> Bool) -> DispatchFilter s

As safe, but as applied to api messages (i.e. those originating from call as cast client interactions).

safely :: forall s. (s -> Message -> Bool) -> DispatchFilter s

As safe, but matches on a raw message.

data Message a b

Message type used internally by the call, cast, and rpcChan APIs.

Instances

Generic (Message a b)

Defined in Control.Distributed.Process.ManagedProcess.Internal.Types

Associated Types

type Rep (Message a b) :: Type -> Type

Methods

from :: Message a b -> Rep (Message a b) x

to :: Rep (Message a b) x -> Message a b

(Show a, Show b) => Show (Message a b)

Defined in Control.Distributed.Process.ManagedProcess.Internal.Types

Methods

showsPrec :: Int -> Message a b -> ShowS

show :: Message a b -> String

showList :: [Message a b] -> ShowS

(Serializable a, Serializable b) => Binary (Message a b)

Defined in Control.Distributed.Process.ManagedProcess.Internal.Types

Methods

put :: Message a b -> Put

get :: Get (Message a b)

putList :: [Message a b] -> Put

(NFSerializable a, NFSerializable b) => NFData (Message a b)

Defined in Control.Distributed.Process.ManagedProcess.Internal.Types

Methods

rnf :: Message a b -> ()

(Eq a, Eq b) => Eq (Message a b)

Defined in Control.Distributed.Process.ManagedProcess.Internal.Types

Methods

(==) :: Message a b -> Message a b -> Bool

(/=) :: Message a b -> Message a b -> Bool

type Rep (Message a b)

Defined in Control.Distributed.Process.ManagedProcess.Internal.Types

type Rep (Message a b) = D1 ('MetaData "Message" "Control.Distributed.Process.ManagedProcess.Internal.Types" "distributed-process-client-server-0.2.7.0-J8jFpPKNrsjKtWieo0rAq3" 'False) (C1 ('MetaCons "CastMessage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: (C1 ('MetaCons "CallMessage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (CallRef b))) :+: C1 ('MetaCons "ChanMessage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SendPort b)))))

evalAfter :: forall s m. Serializable m => TimeInterval -> m -> s -> Action s

Evaluate any matching info handler with the supplied datum after waiting for at least TimeInterval. The process state (for the resulting Action s) is also given and the process loop will go on as per Server.continue.

Informally, evaluating this expression (such that the Action is given as the result of a handler or filter) will ensure that the supplied message (datum) is availble for processing no sooner than TimeInterval.

Currently, this expression creates an Action that triggers immediate evaluation in the process loop before continuing with the given state. The process loop stores a user timeout for the given time interval, which is trigerred like a wait/drain timeout. This implementation is subject to change.

currentTimeout :: GenProcess s Delay

The current (user supplied) timeout.

processState :: GenProcess s s

Evaluates to the user defined state for the currently executing server loop.

processDefinition :: GenProcess s (ProcessDefinition s)

The ProcessDefinition for the current loop.

processFilters :: GenProcess s [DispatchFilter s]

The list of filters for the current loop.

processUnhandledMsgPolicy :: GenProcess s UnhandledMessagePolicy

Evaluates to the UnhandledMessagePolicy for the current loop.

setUserTimeout :: Delay -> GenProcess s ()

Set the user timeout applied whilst a prioritised process loop is in a blocking receive.

setProcessState :: s -> GenProcess s ()

Set the current process state.

data GenProcess s a

StateT based monad for prioritised process loops.

Instances

MonadFix (GenProcess s)

Defined in Control.Distributed.Process.ManagedProcess.Internal.Types

Methods

mfix :: (a -> GenProcess s a) -> GenProcess s a

MonadIO (GenProcess s)

Defined in Control.Distributed.Process.ManagedProcess.Internal.Types

Methods

liftIO :: IO a -> GenProcess s a

Applicative (GenProcess s)

Defined in Control.Distributed.Process.ManagedProcess.Internal.Types

Methods

pure :: a -> GenProcess s a

(<*>) :: GenProcess s (a -> b) -> GenProcess s a -> GenProcess s b

liftA2 :: (a -> b -> c) -> GenProcess s a -> GenProcess s b -> GenProcess s c

(*>) :: GenProcess s a -> GenProcess s b -> GenProcess s b

(<*) :: GenProcess s a -> GenProcess s b -> GenProcess s a

Functor (GenProcess s)

Defined in Control.Distributed.Process.ManagedProcess.Internal.Types

Methods

fmap :: (a -> b) -> GenProcess s a -> GenProcess s b

(<$) :: a -> GenProcess s b -> GenProcess s a

Monad (GenProcess s)

Defined in Control.Distributed.Process.ManagedProcess.Internal.Types

Methods

(>>=) :: GenProcess s a -> (a -> GenProcess s b) -> GenProcess s b

(>>) :: GenProcess s a -> GenProcess s b -> GenProcess s b

return :: a -> GenProcess s a

MonadCatch (GenProcess s)

Defined in Control.Distributed.Process.ManagedProcess.Internal.Types

Methods

catch :: (HasCallStack, Exception e) => GenProcess s a -> (e -> GenProcess s a) -> GenProcess s a

MonadMask (GenProcess s)

Defined in Control.Distributed.Process.ManagedProcess.Internal.Types

Methods

mask :: HasCallStack => ((forall a. GenProcess s a -> GenProcess s a) -> GenProcess s b) -> GenProcess s b

uninterruptibleMask :: HasCallStack => ((forall a. GenProcess s a -> GenProcess s a) -> GenProcess s b) -> GenProcess s b

generalBracket :: HasCallStack => GenProcess s a -> (a -> ExitCase b -> GenProcess s c) -> (a -> GenProcess s b) -> GenProcess s (b, c)

MonadThrow (GenProcess s)

Defined in Control.Distributed.Process.ManagedProcess.Internal.Types

Methods

throwM :: (HasCallStack, Exception e) => e -> GenProcess s a

MonadState (State s) (GenProcess s)

Defined in Control.Distributed.Process.ManagedProcess.Internal.Types

Methods

get :: GenProcess s (State s)

put :: State s -> GenProcess s ()

state :: (State s -> (a, State s)) -> GenProcess s a

peek :: GenProcess s (Maybe Message)

Peek at the next available message in the internal priority queue, without removing it.

push :: forall s. Message -> GenProcess s ()

Push a message to the head of the internal priority queue.

addUserTimer :: Timer -> Message -> GenProcess s TimerKey

Add a user timer, bound to the given datum.

act :: forall s. GenProcess s () -> Action s

Warning: This interface is intended for internal use only

Produce an Action s that, if it is the result of a handler, will cause the server loop to evaluate the supplied expression. This is given in the GenProcess monad, which is intended for internal use only.

runAfter :: forall s m. Serializable m => TimeInterval -> m -> GenProcess s ()

Warning: This interface is intended for internal use only

Starts a timer and adds it as a user timeout.