Control.Distributed.Process.Extras.Internal.Types

Types used throughout the Extras package

Tagging

type Tag = Int

Tags provide uniqueness for messages, so that they can be matched with their response.

type TagPool = MVar Tag

Generates unique Tag for messages and response pairs. Each process that depends, directly or indirectly, on the call mechanisms in Control.Distributed.Process.Global.Call should have at most one TagPool on which to draw unique message tags.

newTagPool :: Process TagPool

Create a new per-process source of unique message identifiers.

getTag :: TagPool -> Process Tag

Extract a new identifier from a TagPool.

Addressing

class Linkable a where

Class of things to which a Process can link itself.

Methods

linkTo :: Resolvable a => a -> Process ()

Create a link with the supplied object.

class Killable p where

Class of things that can be killed (or instructed to exit).

Methods

killProc :: Resolvable p => p -> String -> Process ()

Kill (instruct to exit) generic process, using kill primitive.

exitProc :: (Resolvable p, Serializable m) => p -> m -> Process ()

Kill (instruct to exit) generic process, using exit primitive.

Instances

Resolvable p => Killable p

Methods

killProc :: p -> String -> Process ()

exitProc :: (Resolvable p, Serializable m) => p -> m -> Process ()

class Resolvable a where

Class of things that can be resolved to a ProcessId.

Minimal complete definition

resolve

Methods

resolve :: a -> Process (Maybe ProcessId)

Resolve the reference to a process id, or Nothing if resolution fails

unresolvableMessage :: Resolvable a => a -> String

Unresolvable Addressable Message

Instances

Resolvable String

Methods

resolve :: String -> Process (Maybe ProcessId)

unresolvableMessage :: String -> String

Resolvable ProcessId

Methods

resolve :: ProcessId -> Process (Maybe ProcessId)

unresolvableMessage :: ProcessId -> String

Resolvable Recipient

Methods

resolve :: Recipient -> Process (Maybe ProcessId)

unresolvableMessage :: Recipient -> String

Resolvable LogClient

Methods

resolve :: LogClient -> Process (Maybe ProcessId)

unresolvableMessage :: LogClient -> String

Resolvable (NodeId, String)

Methods

resolve :: (NodeId, String) -> Process (Maybe ProcessId)

unresolvableMessage :: (NodeId, String) -> String

class Routable a where

Class of things that you can route/send serializable message to

Methods

sendTo :: (Serializable m, Resolvable a) => a -> m -> Process ()

Send a message to the target asynchronously

unsafeSendTo :: (NFSerializable m, Resolvable a) => a -> m -> Process ()

Send some NFData message to the target asynchronously, forcing evaluation (i.e., deepseq) beforehand.

Instances

Routable String

Methods

sendTo :: (Serializable m, Resolvable String) => String -> m -> Process ()

unsafeSendTo :: (NFSerializable m, Resolvable String) => String -> m -> Process ()

Routable ProcessId

Methods

sendTo :: (Serializable m, Resolvable ProcessId) => ProcessId -> m -> Process ()

unsafeSendTo :: (NFSerializable m, Resolvable ProcessId) => ProcessId -> m -> Process ()

Routable Recipient

Methods

sendTo :: (Serializable m, Resolvable Recipient) => Recipient -> m -> Process ()

unsafeSendTo :: (NFSerializable m, Resolvable Recipient) => Recipient -> m -> Process ()

Routable LogClient

Methods

sendTo :: (Serializable m, Resolvable LogClient) => LogClient -> m -> Process ()

unsafeSendTo :: (NFSerializable m, Resolvable LogClient) => LogClient -> m -> Process ()

Routable LogChan

Methods

sendTo :: (Serializable m, Resolvable LogChan) => LogChan -> m -> Process ()

unsafeSendTo :: (NFSerializable m, Resolvable LogChan) => LogChan -> m -> Process ()

Routable (Message -> Process ())

Methods

sendTo :: (Serializable m, Resolvable (Message -> Process ())) => (Message -> Process ()) -> m -> Process ()

unsafeSendTo :: (NFSerializable m, Resolvable (Message -> Process ())) => (Message -> Process ()) -> m -> Process ()

Routable (NodeId, String)

Methods

sendTo :: (Serializable m, Resolvable (NodeId, String)) => (NodeId, String) -> m -> Process ()

unsafeSendTo :: (NFSerializable m, Resolvable (NodeId, String)) => (NodeId, String) -> m -> Process ()

class (Resolvable a, Routable a) => Addressable a

Instances

Addressable ProcessId

data Recipient

A simple means of mapping to a receiver.

Constructors

Pid !ProcessId

Registered !String

RemoteRegistered !String !NodeId

Instances

Eq Recipient

Methods

(==) :: Recipient -> Recipient -> Bool

(/=) :: Recipient -> Recipient -> Bool

Show Recipient

Methods

showsPrec :: Int -> Recipient -> ShowS

show :: Recipient -> String

showList :: [Recipient] -> ShowS

Generic Recipient

Associated Types

type Rep Recipient :: * -> *

Methods

from :: Recipient -> Rep Recipient x

to :: Rep Recipient x -> Recipient

Binary Recipient

Methods

put :: Recipient -> Put

get :: Get Recipient

putList :: [Recipient] -> Put

NFData Recipient

Methods

rnf :: Recipient -> ()

Routable Recipient

Methods

sendTo :: (Serializable m, Resolvable Recipient) => Recipient -> m -> Process ()

unsafeSendTo :: (NFSerializable m, Resolvable Recipient) => Recipient -> m -> Process ()

Resolvable Recipient

Methods

resolve :: Recipient -> Process (Maybe ProcessId)

unresolvableMessage :: Recipient -> String

type Rep Recipient

type Rep Recipient = D1 (MetaData "Recipient" "Control.Distributed.Process.Extras.Internal.Types" "distributed-process-extras-0.3.2-8M2JPG0xSQwTSM074rUzv" False) ((:+:) (C1 (MetaCons "Pid" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ProcessId))) ((:+:) (C1 (MetaCons "Registered" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String))) (C1 (MetaCons "RemoteRegistered" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 NodeId))))))

data RegisterSelf

Used internally in whereisOrStart. Sent as (RegisterSelf,ProcessId).

Constructors

RegisterSelf

Instances

Generic RegisterSelf

Associated Types

type Rep RegisterSelf :: * -> *

Methods

from :: RegisterSelf -> Rep RegisterSelf x

to :: Rep RegisterSelf x -> RegisterSelf

Binary RegisterSelf

Methods

put :: RegisterSelf -> Put

get :: Get RegisterSelf

putList :: [RegisterSelf] -> Put

NFData RegisterSelf

Methods

rnf :: RegisterSelf -> ()

type Rep RegisterSelf

type Rep RegisterSelf = D1 (MetaData "RegisterSelf" "Control.Distributed.Process.Extras.Internal.Types" "distributed-process-extras-0.3.2-8M2JPG0xSQwTSM074rUzv" False) (C1 (MetaCons "RegisterSelf" PrefixI False) U1)

Interactions

whereisRemote :: NodeId -> String -> Process (Maybe ProcessId)

A synchronous version of whereis, this monitors the remote node and returns Nothing if the node goes down (since a remote node failing or being non-contactible has the same effect as a process not being registered from the caller's point of view).

resolveOrDie :: Resolvable a => a -> String -> Process ProcessId

resolve the Resolvable or die with specified msg plus details of what didn't resolve

data CancelWait

Wait cancellation message.

Constructors

CancelWait

Instances

Eq CancelWait

Methods

(==) :: CancelWait -> CancelWait -> Bool

(/=) :: CancelWait -> CancelWait -> Bool

Show CancelWait

Methods

showsPrec :: Int -> CancelWait -> ShowS

show :: CancelWait -> String

showList :: [CancelWait] -> ShowS

Generic CancelWait

Associated Types

type Rep CancelWait :: * -> *

Methods

from :: CancelWait -> Rep CancelWait x

to :: Rep CancelWait x -> CancelWait

Binary CancelWait

Methods

put :: CancelWait -> Put

get :: Get CancelWait

putList :: [CancelWait] -> Put

NFData CancelWait

Methods

rnf :: CancelWait -> ()

type Rep CancelWait

type Rep CancelWait = D1 (MetaData "CancelWait" "Control.Distributed.Process.Extras.Internal.Types" "distributed-process-extras-0.3.2-8M2JPG0xSQwTSM074rUzv" False) (C1 (MetaCons "CancelWait" PrefixI False) U1)

type Channel a = (SendPort a, ReceivePort a)

Simple representation of a channel.

data Shutdown

A ubiquitous shutdown signal that can be used to maintain a consistent shutdown/stop protocol for any process that wishes to handle it.

Constructors

Shutdown

Instances

Eq Shutdown

Methods

(==) :: Shutdown -> Shutdown -> Bool

(/=) :: Shutdown -> Shutdown -> Bool

Show Shutdown

Methods

showsPrec :: Int -> Shutdown -> ShowS

show :: Shutdown -> String

showList :: [Shutdown] -> ShowS

Generic Shutdown

Associated Types

type Rep Shutdown :: * -> *

Methods

from :: Shutdown -> Rep Shutdown x

to :: Rep Shutdown x -> Shutdown

Binary Shutdown

Methods

put :: Shutdown -> Put

get :: Get Shutdown

putList :: [Shutdown] -> Put

NFData Shutdown

Methods

rnf :: Shutdown -> ()

type Rep Shutdown

type Rep Shutdown = D1 (MetaData "Shutdown" "Control.Distributed.Process.Extras.Internal.Types" "distributed-process-extras-0.3.2-8M2JPG0xSQwTSM074rUzv" False) (C1 (MetaCons "Shutdown" PrefixI False) U1)

data ExitReason

Provides a reason for process termination.

Constructors

ExitNormal

indicates normal exit

ExitShutdown

normal response to a Shutdown

ExitOther !String

abnormal (error) shutdown

Instances

Eq ExitReason

Methods

(==) :: ExitReason -> ExitReason -> Bool

(/=) :: ExitReason -> ExitReason -> Bool

Show ExitReason

Methods

showsPrec :: Int -> ExitReason -> ShowS

show :: ExitReason -> String

showList :: [ExitReason] -> ShowS

Generic ExitReason

Associated Types

type Rep ExitReason :: * -> *

Methods

from :: ExitReason -> Rep ExitReason x

to :: Rep ExitReason x -> ExitReason

Binary ExitReason

Methods

put :: ExitReason -> Put

get :: Get ExitReason

putList :: [ExitReason] -> Put

NFData ExitReason

Methods

rnf :: ExitReason -> ()

type Rep ExitReason

type Rep ExitReason = D1 (MetaData "ExitReason" "Control.Distributed.Process.Extras.Internal.Types" "distributed-process-extras-0.3.2-8M2JPG0xSQwTSM074rUzv" False) ((:+:) (C1 (MetaCons "ExitNormal" PrefixI False) U1) ((:+:) (C1 (MetaCons "ExitShutdown" PrefixI False) U1) (C1 (MetaCons "ExitOther" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String)))))

newtype ServerDisconnected

Given when a server is unobtainable.

Constructors

ServerDisconnected DiedReason

Instances

Generic ServerDisconnected

Associated Types

type Rep ServerDisconnected :: * -> *

Methods

from :: ServerDisconnected -> Rep ServerDisconnected x

to :: Rep ServerDisconnected x -> ServerDisconnected

Binary ServerDisconnected

Methods

put :: ServerDisconnected -> Put

get :: Get ServerDisconnected

putList :: [ServerDisconnected] -> Put

NFData ServerDisconnected

Methods

rnf :: ServerDisconnected -> ()

type Rep ServerDisconnected

type Rep ServerDisconnected = D1 (MetaData "ServerDisconnected" "Control.Distributed.Process.Extras.Internal.Types" "distributed-process-extras-0.3.2-8M2JPG0xSQwTSM074rUzv" True) (C1 (MetaCons "ServerDisconnected" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 DiedReason)))

class (NFData a, Serializable a) => NFSerializable a

Introduces a class that brings NFData into scope along with Serializable, such that we can force evaluation. Intended for use with the UnsafePrimitives module (which wraps Control.Distributed.Process.UnsafePrimitives), and guarantees evaluatedness in terms of NFData. Please note that we cannot guarantee that an NFData instance will behave the same way as a Binary one with regards evaluation, so it is still possible to introduce unexpected behaviour by using unsafe primitives in this way.

Instances

(NFData a, Serializable a) => NFSerializable a

NFSerializable a => NFSerializable (SendPort a)