Safe Haskell	None
Language	Haskell98

Control.Distributed.Process.Internal.Types

Contents

Node and process identifiers
Local nodes and processes
Typed channels
Messages
Node controller user-visible data types
Node controller internal data types
Accessors
Utilities

Description

Types used throughout the Cloud Haskell framework

We collect all types used internally in a single module because many of these data types are mutually recursive and cannot be split across modules.

Synopsis

Node and process identifiers

newtype NodeId Source #

Node identifier

Constructors

NodeId
Fields nodeAddress :: EndPointAddress

Instances

Eq NodeId Source #
Methods (==) :: NodeId -> NodeId -> Bool # (/=) :: NodeId -> NodeId -> Bool #
Data NodeId Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NodeId -> c NodeId # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c NodeId # toConstr :: NodeId -> Constr # dataTypeOf :: NodeId -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c NodeId) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NodeId) # gmapT :: (forall b. Data b => b -> b) -> NodeId -> NodeId # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NodeId -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NodeId -> r # gmapQ :: (forall d. Data d => d -> u) -> NodeId -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> NodeId -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> NodeId -> m NodeId # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NodeId -> m NodeId # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NodeId -> m NodeId #
Ord NodeId Source #
Methods compare :: NodeId -> NodeId -> Ordering # (<) :: NodeId -> NodeId -> Bool # (<=) :: NodeId -> NodeId -> Bool # (>) :: NodeId -> NodeId -> Bool # (>=) :: NodeId -> NodeId -> Bool # max :: NodeId -> NodeId -> NodeId # min :: NodeId -> NodeId -> NodeId #
Show NodeId Source #
Methods showsPrec :: Int -> NodeId -> ShowS # show :: NodeId -> String # showList :: [NodeId] -> ShowS #
Generic NodeId Source #
Associated Types type Rep NodeId :: * -> * # Methods from :: NodeId -> Rep NodeId x # to :: Rep NodeId x -> NodeId #
Binary NodeId Source #
Methods put :: NodeId -> Put # get :: Get NodeId # putList :: [NodeId] -> Put #
NFData NodeId Source #
Methods rnf :: NodeId -> () #
Hashable NodeId Source #
Methods hashWithSalt :: Int -> NodeId -> Int # hash :: NodeId -> Int #
type Rep NodeId Source #
type Rep NodeId = D1 (MetaData "NodeId" "Control.Distributed.Process.Internal.Types" "distributed-process-0.7.2-G4d8PA3pJUqAxXhFbGtYpj" True) (C1 (MetaCons "NodeId" PrefixI True) (S1 (MetaSel (Just Symbol "nodeAddress") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 EndPointAddress)))

data LocalProcessId Source #

A local process ID consists of a seed which distinguishes processes from different instances of the same local node and a counter

Constructors

LocalProcessId
Fields lpidUnique :: !Int32 lpidCounter :: !Int32

Instances

Eq LocalProcessId Source #
Methods (==) :: LocalProcessId -> LocalProcessId -> Bool # (/=) :: LocalProcessId -> LocalProcessId -> Bool #
Data LocalProcessId Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LocalProcessId -> c LocalProcessId # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LocalProcessId # toConstr :: LocalProcessId -> Constr # dataTypeOf :: LocalProcessId -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c LocalProcessId) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LocalProcessId) # gmapT :: (forall b. Data b => b -> b) -> LocalProcessId -> LocalProcessId # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LocalProcessId -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LocalProcessId -> r # gmapQ :: (forall d. Data d => d -> u) -> LocalProcessId -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> LocalProcessId -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> LocalProcessId -> m LocalProcessId # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LocalProcessId -> m LocalProcessId # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LocalProcessId -> m LocalProcessId #
Ord LocalProcessId Source #
Methods compare :: LocalProcessId -> LocalProcessId -> Ordering # (<) :: LocalProcessId -> LocalProcessId -> Bool # (<=) :: LocalProcessId -> LocalProcessId -> Bool # (>) :: LocalProcessId -> LocalProcessId -> Bool # (>=) :: LocalProcessId -> LocalProcessId -> Bool # max :: LocalProcessId -> LocalProcessId -> LocalProcessId # min :: LocalProcessId -> LocalProcessId -> LocalProcessId #
Show LocalProcessId Source #
Methods showsPrec :: Int -> LocalProcessId -> ShowS # show :: LocalProcessId -> String # showList :: [LocalProcessId] -> ShowS #
Generic LocalProcessId Source #
Associated Types type Rep LocalProcessId :: * -> * # Methods from :: LocalProcessId -> Rep LocalProcessId x # to :: Rep LocalProcessId x -> LocalProcessId #
Binary LocalProcessId Source #
Methods put :: LocalProcessId -> Put # get :: Get LocalProcessId # putList :: [LocalProcessId] -> Put #
Hashable LocalProcessId Source #
Methods hashWithSalt :: Int -> LocalProcessId -> Int # hash :: LocalProcessId -> Int #
type Rep LocalProcessId Source #
type Rep LocalProcessId = D1 (MetaData "LocalProcessId" "Control.Distributed.Process.Internal.Types" "distributed-process-0.7.2-G4d8PA3pJUqAxXhFbGtYpj" False) (C1 (MetaCons "LocalProcessId" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "lpidUnique") SourceUnpack SourceStrict DecidedStrict) (Rec0 Int32)) (S1 (MetaSel (Just Symbol "lpidCounter") SourceUnpack SourceStrict DecidedStrict) (Rec0 Int32))))

data ProcessId Source #

Process identifier

Constructors

ProcessId
Fields processNodeId :: !NodeId The ID of the node the process is running on processLocalId :: !LocalProcessId Node-local identifier for the process

Instances

Eq ProcessId Source #
Methods (==) :: ProcessId -> ProcessId -> Bool # (/=) :: ProcessId -> ProcessId -> Bool #
Data ProcessId Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProcessId -> c ProcessId # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProcessId # toConstr :: ProcessId -> Constr # dataTypeOf :: ProcessId -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c ProcessId) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProcessId) # gmapT :: (forall b. Data b => b -> b) -> ProcessId -> ProcessId # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProcessId -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProcessId -> r # gmapQ :: (forall d. Data d => d -> u) -> ProcessId -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProcessId -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProcessId -> m ProcessId # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProcessId -> m ProcessId # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProcessId -> m ProcessId #
Ord ProcessId Source #
Methods compare :: ProcessId -> ProcessId -> Ordering # (<) :: ProcessId -> ProcessId -> Bool # (<=) :: ProcessId -> ProcessId -> Bool # (>) :: ProcessId -> ProcessId -> Bool # (>=) :: ProcessId -> ProcessId -> Bool # max :: ProcessId -> ProcessId -> ProcessId # min :: ProcessId -> ProcessId -> ProcessId #
Show ProcessId Source #
Methods showsPrec :: Int -> ProcessId -> ShowS # show :: ProcessId -> String # showList :: [ProcessId] -> ShowS #
Generic ProcessId Source #
Associated Types type Rep ProcessId :: * -> * # Methods from :: ProcessId -> Rep ProcessId x # to :: Rep ProcessId x -> ProcessId #
Binary ProcessId Source #
Methods put :: ProcessId -> Put # get :: Get ProcessId # putList :: [ProcessId] -> Put #
NFData ProcessId Source #
Methods rnf :: ProcessId -> () #
Hashable ProcessId Source #
Methods hashWithSalt :: Int -> ProcessId -> Int # hash :: ProcessId -> Int #
type Rep ProcessId Source #
type Rep ProcessId = D1 (MetaData "ProcessId" "Control.Distributed.Process.Internal.Types" "distributed-process-0.7.2-G4d8PA3pJUqAxXhFbGtYpj" False) (C1 (MetaCons "ProcessId" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "processNodeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 NodeId)) (S1 (MetaSel (Just Symbol "processLocalId") SourceUnpack SourceStrict DecidedStrict) (Rec0 LocalProcessId))))

data Identifier Source #

Union of all kinds of identifiers

Constructors

NodeIdentifier !NodeId
ProcessIdentifier !ProcessId
SendPortIdentifier !SendPortId

Instances

Eq Identifier Source #
Methods (==) :: Identifier -> Identifier -> Bool # (/=) :: Identifier -> Identifier -> Bool #
Ord Identifier Source #
Methods compare :: Identifier -> Identifier -> Ordering # (<) :: Identifier -> Identifier -> Bool # (<=) :: Identifier -> Identifier -> Bool # (>) :: Identifier -> Identifier -> Bool # (>=) :: Identifier -> Identifier -> Bool # max :: Identifier -> Identifier -> Identifier # min :: Identifier -> Identifier -> Identifier #
Show Identifier Source #
Methods showsPrec :: Int -> Identifier -> ShowS # show :: Identifier -> String # showList :: [Identifier] -> ShowS #
Generic Identifier Source #
Associated Types type Rep Identifier :: * -> * # Methods from :: Identifier -> Rep Identifier x # to :: Rep Identifier x -> Identifier #
Binary Identifier Source #
Methods put :: Identifier -> Put # get :: Get Identifier # putList :: [Identifier] -> Put #
NFData Identifier Source #
Methods rnf :: Identifier -> () #
Hashable Identifier Source #
Methods hashWithSalt :: Int -> Identifier -> Int # hash :: Identifier -> Int #
type Rep Identifier Source #
type Rep Identifier = D1 (MetaData "Identifier" "Control.Distributed.Process.Internal.Types" "distributed-process-0.7.2-G4d8PA3pJUqAxXhFbGtYpj" False) ((:+:) (C1 (MetaCons "NodeIdentifier" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 NodeId))) ((:+:) (C1 (MetaCons "ProcessIdentifier" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ProcessId))) (C1 (MetaCons "SendPortIdentifier" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SendPortId)))))

nodeOf :: Identifier -> NodeId Source #

firstNonReservedProcessId :: Int32 Source #

nullProcessId :: NodeId -> ProcessId Source #

Local nodes and processes

data LocalNode Source #

Local nodes

Constructors

LocalNode

Fields

localNodeId :: !NodeId
NodeId of the node
localEndPoint :: !EndPoint
The network endpoint associated with this node
localState :: !(StrictMVar LocalNodeState)
Local node state
localCtrlChan :: !(Chan NCMsg)
Channel for the node controller
localEventBus :: !MxEventBus
Internal management event bus
remoteTable :: !RemoteTable
Runtime lookup table for supporting closures TODO: this should be part of the CH state, not the local endpoint state

data LocalNodeState Source #

Local node state

Constructors

LocalNodeValid !ValidLocalNodeState
LocalNodeClosed

data ValidLocalNodeState Source #

Constructors

ValidLocalNodeState
Fields _localProcesses :: !(Map LocalProcessId LocalProcess) Processes running on this node _localPidCounter :: !Int32 Counter to assign PIDs _localPidUnique :: !Int32 The `unique` value used to create PIDs (so that processes on restarted nodes have new PIDs) _localConnections :: !(Map (Identifier, Identifier) (Connection, ImplicitReconnect)) Outgoing connections

data NodeClosedException Source #

Thrown by some primitives when they notice the node has been closed.

Constructors

NodeClosedException NodeId

Instances

Show NodeClosedException Source #
Methods showsPrec :: Int -> NodeClosedException -> ShowS # show :: NodeClosedException -> String # showList :: [NodeClosedException] -> ShowS #
Exception NodeClosedException Source #
Methods toException :: NodeClosedException -> SomeException # fromException :: SomeException -> Maybe NodeClosedException # displayException :: NodeClosedException -> String #

withValidLocalState :: LocalNode -> (ValidLocalNodeState -> IO r) -> IO r Source #

Wrapper around withMVar that checks that the local node is still in a valid state.

modifyValidLocalState :: LocalNode -> (ValidLocalNodeState -> IO (ValidLocalNodeState, a)) -> IO (Maybe a) Source #

Wrapper around modifyMVar that checks that the local node is still in a valid state.

modifyValidLocalState_ :: LocalNode -> (ValidLocalNodeState -> IO ValidLocalNodeState) -> IO () Source #

Wrapper around modifyMVar_ that checks that the local node is still in a valid state.

data Tracer Source #

Provides access to the trace controller

Constructors

Tracer
Fields tracerPid :: !ProcessId Process id for the currently active trace handler weakQ :: !(Weak (CQueue Message)) Weak reference to the tracer controller's mailbox

data MxEventBus Source #

Local system management event bus state

Constructors

MxEventBusInitialising
MxEventBus
Fields agent :: !ProcessId Process id of the management agent controller process tracer :: !Tracer Configuration for the local trace controller evbuss :: !(Weak (CQueue Message)) Weak reference to the management agent controller's mailbox mxNew :: !(((TChan Message, TChan Message) -> Process ()) -> IO ProcessId) API for adding management agents to a running node

data LocalProcess Source #

Processes running on our local node

Constructors

LocalProcess
Fields processQueue :: !(CQueue Message) processWeakQ :: !(Weak (CQueue Message)) processId :: !ProcessId processState :: !(StrictMVar LocalProcessState) processThread :: !ThreadId processNode :: !LocalNode

Instances

MonadReader LocalProcess Process Source #
Methods ask :: Process LocalProcess # local :: (LocalProcess -> LocalProcess) -> Process a -> Process a # reader :: (LocalProcess -> a) -> Process a #

data LocalProcessState Source #

Local process state

Constructors

LocalProcessState
Fields _monitorCounter :: !Int32 _spawnCounter :: !Int32 _channelCounter :: !Int32 _typedChannels :: !(Map LocalSendPortId TypedChannel)

newtype Process a Source #

The Cloud Haskell Process type

Constructors

Process
Fields unProcess :: ReaderT LocalProcess IO a

Instances

Monad Process Source #
Methods (>>=) :: Process a -> (a -> Process b) -> Process b # (>>) :: Process a -> Process b -> Process b # return :: a -> Process a # fail :: String -> Process a #
Functor Process Source #
Methods fmap :: (a -> b) -> Process a -> Process b # (<$) :: a -> Process b -> Process a #
MonadFix Process Source #
Methods mfix :: (a -> Process a) -> Process a #
Applicative Process Source #
Methods pure :: a -> Process a # (<>) :: Process (a -> b) -> Process a -> Process b # (>) :: Process a -> Process b -> Process b # (<*) :: Process a -> Process b -> Process a #
MonadIO Process Source #
Methods liftIO :: IO a -> Process a #
MonadThrow Process Source #
Methods throwM :: Exception e => e -> Process a #
MonadCatch Process Source #
Methods catch :: Exception e => Process a -> (e -> Process a) -> Process a #
MonadMask Process Source #
Methods mask :: ((forall a. Process a -> Process a) -> Process b) -> Process b # uninterruptibleMask :: ((forall a. Process a -> Process a) -> Process b) -> Process b #
MonadReader LocalProcess Process Source #
Methods ask :: Process LocalProcess # local :: (LocalProcess -> LocalProcess) -> Process a -> Process a # reader :: (LocalProcess -> a) -> Process a #
Serializable b => MkTDict (Process b) Source #
Methods mkTDict :: String -> Process b -> RemoteRegister Source #

runLocalProcess :: LocalProcess -> Process a -> IO a Source #

Deconstructor for Process (not exported to the public API)

data ImplicitReconnect Source #

Constructors

WithImplicitReconnect
NoImplicitReconnect

Instances

Eq ImplicitReconnect Source #
Methods (==) :: ImplicitReconnect -> ImplicitReconnect -> Bool # (/=) :: ImplicitReconnect -> ImplicitReconnect -> Bool #
Show ImplicitReconnect Source #
Methods showsPrec :: Int -> ImplicitReconnect -> ShowS # show :: ImplicitReconnect -> String # showList :: [ImplicitReconnect] -> ShowS #

Typed channels

type LocalSendPortId = Int32 Source #

data SendPortId Source #

A send port is identified by a SendPortId.

You cannot send directly to a SendPortId; instead, use newChan to create a SendPort.

Constructors

SendPortId
Fields sendPortProcessId :: !ProcessId The ID of the process that will receive messages sent on this port sendPortLocalId :: !LocalSendPortId Process-local ID of the channel

Instances

Eq SendPortId Source #
Methods (==) :: SendPortId -> SendPortId -> Bool # (/=) :: SendPortId -> SendPortId -> Bool #
Ord SendPortId Source #
Methods compare :: SendPortId -> SendPortId -> Ordering # (<) :: SendPortId -> SendPortId -> Bool # (<=) :: SendPortId -> SendPortId -> Bool # (>) :: SendPortId -> SendPortId -> Bool # (>=) :: SendPortId -> SendPortId -> Bool # max :: SendPortId -> SendPortId -> SendPortId # min :: SendPortId -> SendPortId -> SendPortId #
Show SendPortId Source #
Methods showsPrec :: Int -> SendPortId -> ShowS # show :: SendPortId -> String # showList :: [SendPortId] -> ShowS #
Generic SendPortId Source #
Associated Types type Rep SendPortId :: * -> * # Methods from :: SendPortId -> Rep SendPortId x # to :: Rep SendPortId x -> SendPortId #
Binary SendPortId Source #
Methods put :: SendPortId -> Put # get :: Get SendPortId # putList :: [SendPortId] -> Put #
NFData SendPortId Source #
Methods rnf :: SendPortId -> () #
Hashable SendPortId Source #
Methods hashWithSalt :: Int -> SendPortId -> Int # hash :: SendPortId -> Int #
type Rep SendPortId Source #
type Rep SendPortId = D1 (MetaData "SendPortId" "Control.Distributed.Process.Internal.Types" "distributed-process-0.7.2-G4d8PA3pJUqAxXhFbGtYpj" False) (C1 (MetaCons "SendPortId" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "sendPortProcessId") SourceUnpack SourceStrict DecidedStrict) (Rec0 ProcessId)) (S1 (MetaSel (Just Symbol "sendPortLocalId") SourceUnpack SourceStrict DecidedStrict) (Rec0 LocalSendPortId))))

data TypedChannel Source #

Constructors

Serializable a => TypedChannel (Weak (TQueue a))

newtype SendPort a Source #

The send send of a typed channel (serializable)

Constructors

SendPort
Fields sendPortId :: SendPortId The (unique) ID of this send port

Instances

Eq (SendPort a) Source #
Methods (==) :: SendPort a -> SendPort a -> Bool # (/=) :: SendPort a -> SendPort a -> Bool #
Ord (SendPort a) Source #
Methods compare :: SendPort a -> SendPort a -> Ordering # (<) :: SendPort a -> SendPort a -> Bool # (<=) :: SendPort a -> SendPort a -> Bool # (>) :: SendPort a -> SendPort a -> Bool # (>=) :: SendPort a -> SendPort a -> Bool # max :: SendPort a -> SendPort a -> SendPort a # min :: SendPort a -> SendPort a -> SendPort a #
Show (SendPort a) Source #
Methods showsPrec :: Int -> SendPort a -> ShowS # show :: SendPort a -> String # showList :: [SendPort a] -> ShowS #
Generic (SendPort a) Source #
Associated Types type Rep (SendPort a) :: * -> * # Methods from :: SendPort a -> Rep (SendPort a) x # to :: Rep (SendPort a) x -> SendPort a #
Serializable a => Binary (SendPort a) Source #
Methods put :: SendPort a -> Put # get :: Get (SendPort a) # putList :: [SendPort a] -> Put #
NFData a => NFData (SendPort a) Source #
Methods rnf :: SendPort a -> () #
Hashable a => Hashable (SendPort a) Source #
Methods hashWithSalt :: Int -> SendPort a -> Int # hash :: SendPort a -> Int #
type Rep (SendPort a) Source #
type Rep (SendPort a) = D1 (MetaData "SendPort" "Control.Distributed.Process.Internal.Types" "distributed-process-0.7.2-G4d8PA3pJUqAxXhFbGtYpj" True) (C1 (MetaCons "SendPort" PrefixI True) (S1 (MetaSel (Just Symbol "sendPortId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SendPortId)))

newtype ReceivePort a Source #

The receive end of a typed channel (not serializable)

Note that ReceivePort implements Functor, Applicative, Alternative and Monad. This is especially useful when merging receive ports.

Constructors

ReceivePort
Fields receiveSTM :: STM a

Instances

Monad ReceivePort Source #
Methods (>>=) :: ReceivePort a -> (a -> ReceivePort b) -> ReceivePort b # (>>) :: ReceivePort a -> ReceivePort b -> ReceivePort b # return :: a -> ReceivePort a # fail :: String -> ReceivePort a #
Functor ReceivePort Source #
Methods fmap :: (a -> b) -> ReceivePort a -> ReceivePort b # (<$) :: a -> ReceivePort b -> ReceivePort a #
Applicative ReceivePort Source #
Methods pure :: a -> ReceivePort a # (<>) :: ReceivePort (a -> b) -> ReceivePort a -> ReceivePort b # (>) :: ReceivePort a -> ReceivePort b -> ReceivePort b # (<*) :: ReceivePort a -> ReceivePort b -> ReceivePort a #
Alternative ReceivePort Source #
Methods empty :: ReceivePort a # (<\|>) :: ReceivePort a -> ReceivePort a -> ReceivePort a # some :: ReceivePort a -> ReceivePort [a] # many :: ReceivePort a -> ReceivePort [a] #

Messages

data Message Source #

Messages consist of their typeRep fingerprint and their encoding

Constructors

EncodedMessage
Fields messageFingerprint :: !Fingerprint messageEncoding :: !ByteString
Serializable a => UnencodedMessage
Fields messageFingerprint :: !Fingerprint messagePayload :: !a

Instances

Show Message Source #
Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Binary Message Source #
Methods put :: Message -> Put # get :: Get Message # putList :: [Message] -> Put #
NFData Message Source #
Methods rnf :: Message -> () #

isEncoded :: Message -> Bool Source #

internal use only.

createMessage :: Serializable a => a -> Message Source #

Turn any serialiable term into a message

createUnencodedMessage :: Serializable a => a -> Message Source #

Turn any serializable term into an unencoded/local message

unsafeCreateUnencodedMessage :: Serializable a => a -> Message Source #

Turn any serializable term into an unencodede/local message, without evalutaing it! This is a dangerous business.

messageToPayload :: Message -> [ByteString] Source #

Serialize a message

payloadToMessage :: [ByteString] -> Message Source #

Deserialize a message

Node controller user-visible data types

data MonitorRef Source #

MonitorRef is opaque for regular Cloud Haskell processes

Constructors

MonitorRef
Fields monitorRefIdent :: !Identifier ID of the entity to be monitored monitorRefCounter :: !Int32 Unique to distinguish multiple monitor requests by the same process

Instances

Eq MonitorRef Source #
Methods (==) :: MonitorRef -> MonitorRef -> Bool # (/=) :: MonitorRef -> MonitorRef -> Bool #
Ord MonitorRef Source #
Methods compare :: MonitorRef -> MonitorRef -> Ordering # (<) :: MonitorRef -> MonitorRef -> Bool # (<=) :: MonitorRef -> MonitorRef -> Bool # (>) :: MonitorRef -> MonitorRef -> Bool # (>=) :: MonitorRef -> MonitorRef -> Bool # max :: MonitorRef -> MonitorRef -> MonitorRef # min :: MonitorRef -> MonitorRef -> MonitorRef #
Show MonitorRef Source #
Methods showsPrec :: Int -> MonitorRef -> ShowS # show :: MonitorRef -> String # showList :: [MonitorRef] -> ShowS #
Generic MonitorRef Source #
Associated Types type Rep MonitorRef :: * -> * # Methods from :: MonitorRef -> Rep MonitorRef x # to :: Rep MonitorRef x -> MonitorRef #
Binary MonitorRef Source #
Methods put :: MonitorRef -> Put # get :: Get MonitorRef # putList :: [MonitorRef] -> Put #
NFData MonitorRef Source #
Methods rnf :: MonitorRef -> () #
Hashable MonitorRef Source #
Methods hashWithSalt :: Int -> MonitorRef -> Int # hash :: MonitorRef -> Int #
type Rep MonitorRef Source #
type Rep MonitorRef = D1 (MetaData "MonitorRef" "Control.Distributed.Process.Internal.Types" "distributed-process-0.7.2-G4d8PA3pJUqAxXhFbGtYpj" False) (C1 (MetaCons "MonitorRef" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "monitorRefIdent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Identifier)) (S1 (MetaSel (Just Symbol "monitorRefCounter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int32))))

data ProcessMonitorNotification Source #

Message sent by process monitors

Constructors

ProcessMonitorNotification !MonitorRef !ProcessId !DiedReason

Instances

Show ProcessMonitorNotification Source #
Methods showsPrec :: Int -> ProcessMonitorNotification -> ShowS # show :: ProcessMonitorNotification -> String # showList :: [ProcessMonitorNotification] -> ShowS #
Binary ProcessMonitorNotification Source #
Methods put :: ProcessMonitorNotification -> Put # get :: Get ProcessMonitorNotification # putList :: [ProcessMonitorNotification] -> Put #

data NodeMonitorNotification Source #

Message sent by node monitors

Constructors

NodeMonitorNotification !MonitorRef !NodeId !DiedReason

Instances

Show NodeMonitorNotification Source #
Methods showsPrec :: Int -> NodeMonitorNotification -> ShowS # show :: NodeMonitorNotification -> String # showList :: [NodeMonitorNotification] -> ShowS #
Binary NodeMonitorNotification Source #
Methods put :: NodeMonitorNotification -> Put # get :: Get NodeMonitorNotification # putList :: [NodeMonitorNotification] -> Put #

data PortMonitorNotification Source #

Message sent by channel (port) monitors

Constructors

PortMonitorNotification !MonitorRef !SendPortId !DiedReason

Instances

Show PortMonitorNotification Source #
Methods showsPrec :: Int -> PortMonitorNotification -> ShowS # show :: PortMonitorNotification -> String # showList :: [PortMonitorNotification] -> ShowS #
Binary PortMonitorNotification Source #
Methods put :: PortMonitorNotification -> Put # get :: Get PortMonitorNotification # putList :: [PortMonitorNotification] -> Put #

data ProcessExitException Source #

Internal exception thrown indirectly by exit

Constructors

ProcessExitException !ProcessId !Message

Instances

Show ProcessExitException Source #
Methods showsPrec :: Int -> ProcessExitException -> ShowS # show :: ProcessExitException -> String # showList :: [ProcessExitException] -> ShowS #
Exception ProcessExitException Source #
Methods toException :: ProcessExitException -> SomeException # fromException :: SomeException -> Maybe ProcessExitException # displayException :: ProcessExitException -> String #

data ProcessLinkException Source #

Exceptions thrown when a linked process dies

Constructors

ProcessLinkException !ProcessId !DiedReason

Instances

Show ProcessLinkException Source #
Methods showsPrec :: Int -> ProcessLinkException -> ShowS # show :: ProcessLinkException -> String # showList :: [ProcessLinkException] -> ShowS #
Exception ProcessLinkException Source #
Methods toException :: ProcessLinkException -> SomeException # fromException :: SomeException -> Maybe ProcessLinkException # displayException :: ProcessLinkException -> String #

data NodeLinkException Source #

Exception thrown when a linked node dies

Constructors

NodeLinkException !NodeId !DiedReason

Instances

Show NodeLinkException Source #
Methods showsPrec :: Int -> NodeLinkException -> ShowS # show :: NodeLinkException -> String # showList :: [NodeLinkException] -> ShowS #
Exception NodeLinkException Source #
Methods toException :: NodeLinkException -> SomeException # fromException :: SomeException -> Maybe NodeLinkException # displayException :: NodeLinkException -> String #

data PortLinkException Source #

Exception thrown when a linked channel (port) dies

Constructors

PortLinkException !SendPortId !DiedReason

Instances

Show PortLinkException Source #
Methods showsPrec :: Int -> PortLinkException -> ShowS # show :: PortLinkException -> String # showList :: [PortLinkException] -> ShowS #
Exception PortLinkException Source #
Methods toException :: PortLinkException -> SomeException # fromException :: SomeException -> Maybe PortLinkException # displayException :: PortLinkException -> String #

data ProcessRegistrationException Source #

Exception thrown when a process attempts to register a process under an already-registered name or to unregister a name that hasn't been registered. Returns the name and the identifier of the process that owns it, if any.

Constructors

ProcessRegistrationException !String !(Maybe ProcessId)

Instances

data DiedReason Source #

Why did a process die?

Constructors

DiedNormal	Normal termination
DiedException !String	The process exited with an exception (provided as `String` because `Exception` does not implement `Binary`)
DiedDisconnect	We got disconnected from the process node
DiedNodeDown	The process node died
DiedUnknownId	Invalid (processnodechannel) identifier

Instances

Eq DiedReason Source #
Methods (==) :: DiedReason -> DiedReason -> Bool # (/=) :: DiedReason -> DiedReason -> Bool #
Show DiedReason Source #
Methods showsPrec :: Int -> DiedReason -> ShowS # show :: DiedReason -> String # showList :: [DiedReason] -> ShowS #
Binary DiedReason Source #
Methods put :: DiedReason -> Put # get :: Get DiedReason # putList :: [DiedReason] -> Put #
NFData DiedReason Source #
Methods rnf :: DiedReason -> () #

newtype DidUnmonitor Source #

(Asynchronous) reply from unmonitor

Constructors

DidUnmonitor MonitorRef

Instances

Binary DidUnmonitor Source #
Methods put :: DidUnmonitor -> Put # get :: Get DidUnmonitor # putList :: [DidUnmonitor] -> Put #

newtype DidUnlinkProcess Source #

(Asynchronous) reply from unlink

Constructors

DidUnlinkProcess ProcessId

Instances

Binary DidUnlinkProcess Source #
Methods put :: DidUnlinkProcess -> Put # get :: Get DidUnlinkProcess # putList :: [DidUnlinkProcess] -> Put #

newtype DidUnlinkNode Source #

(Asynchronous) reply from unlinkNode

Constructors

DidUnlinkNode NodeId

Instances

Binary DidUnlinkNode Source #
Methods put :: DidUnlinkNode -> Put # get :: Get DidUnlinkNode # putList :: [DidUnlinkNode] -> Put #

newtype DidUnlinkPort Source #

(Asynchronous) reply from unlinkPort

Constructors

DidUnlinkPort SendPortId

Instances

Binary DidUnlinkPort Source #
Methods put :: DidUnlinkPort -> Put # get :: Get DidUnlinkPort # putList :: [DidUnlinkPort] -> Put #

newtype SpawnRef Source #

SpawnRef are used to return pids of spawned processes

Constructors

SpawnRef Int32

Instances

Eq SpawnRef Source #
Methods (==) :: SpawnRef -> SpawnRef -> Bool # (/=) :: SpawnRef -> SpawnRef -> Bool #
Ord SpawnRef Source #
Methods compare :: SpawnRef -> SpawnRef -> Ordering # (<) :: SpawnRef -> SpawnRef -> Bool # (<=) :: SpawnRef -> SpawnRef -> Bool # (>) :: SpawnRef -> SpawnRef -> Bool # (>=) :: SpawnRef -> SpawnRef -> Bool # max :: SpawnRef -> SpawnRef -> SpawnRef # min :: SpawnRef -> SpawnRef -> SpawnRef #
Show SpawnRef Source #
Methods showsPrec :: Int -> SpawnRef -> ShowS # show :: SpawnRef -> String # showList :: [SpawnRef] -> ShowS #
Binary SpawnRef Source #
Methods put :: SpawnRef -> Put # get :: Get SpawnRef # putList :: [SpawnRef] -> Put #

data DidSpawn Source #

(Asynchronius) reply from spawn

Constructors

DidSpawn SpawnRef ProcessId

Instances

Show DidSpawn Source #
Methods showsPrec :: Int -> DidSpawn -> ShowS # show :: DidSpawn -> String # showList :: [DidSpawn] -> ShowS #
Binary DidSpawn Source #
Methods put :: DidSpawn -> Put # get :: Get DidSpawn # putList :: [DidSpawn] -> Put #

data WhereIsReply Source #

(Asynchronous) reply from whereis

Constructors

WhereIsReply String (Maybe ProcessId)

Instances

Show WhereIsReply Source #
Methods showsPrec :: Int -> WhereIsReply -> ShowS # show :: WhereIsReply -> String # showList :: [WhereIsReply] -> ShowS #
Binary WhereIsReply Source #
Methods put :: WhereIsReply -> Put # get :: Get WhereIsReply # putList :: [WhereIsReply] -> Put #

data RegisterReply Source #

(Asynchronous) reply from register and unregister

Constructors

RegisterReply String Bool (Maybe ProcessId)

Instances

Show RegisterReply Source #
Methods showsPrec :: Int -> RegisterReply -> ShowS # show :: RegisterReply -> String # showList :: [RegisterReply] -> ShowS #
Binary RegisterReply Source #
Methods put :: RegisterReply -> Put # get :: Get RegisterReply # putList :: [RegisterReply] -> Put #

data ProcessInfo Source #

Provide information about a running process

Constructors

ProcessInfo
Fields infoNode :: NodeId infoRegisteredNames :: [String] infoMessageQueueLength :: Int infoMonitors :: [(ProcessId, MonitorRef)] infoLinks :: [ProcessId]

Instances

Eq ProcessInfo Source #
Methods (==) :: ProcessInfo -> ProcessInfo -> Bool # (/=) :: ProcessInfo -> ProcessInfo -> Bool #
Show ProcessInfo Source #
Methods showsPrec :: Int -> ProcessInfo -> ShowS # show :: ProcessInfo -> String # showList :: [ProcessInfo] -> ShowS #
Binary ProcessInfo Source #
Methods put :: ProcessInfo -> Put # get :: Get ProcessInfo # putList :: [ProcessInfo] -> Put #

data ProcessInfoNone Source #

Constructors

ProcessInfoNone DiedReason

Instances

Show ProcessInfoNone Source #
Methods showsPrec :: Int -> ProcessInfoNone -> ShowS # show :: ProcessInfoNone -> String # showList :: [ProcessInfoNone] -> ShowS #
Binary ProcessInfoNone Source #
Methods put :: ProcessInfoNone -> Put # get :: Get ProcessInfoNone # putList :: [ProcessInfoNone] -> Put #

data NodeStats Source #

Constructors

NodeStats
Fields nodeStatsNode :: NodeId nodeStatsRegisteredNames :: Int nodeStatsMonitors :: Int nodeStatsLinks :: Int nodeStatsProcesses :: Int

Instances

Eq NodeStats Source #
Methods (==) :: NodeStats -> NodeStats -> Bool # (/=) :: NodeStats -> NodeStats -> Bool #
Show NodeStats Source #
Methods showsPrec :: Int -> NodeStats -> ShowS # show :: NodeStats -> String # showList :: [NodeStats] -> ShowS #
Binary NodeStats Source #
Methods put :: NodeStats -> Put # get :: Get NodeStats # putList :: [NodeStats] -> Put #

Node controller internal data types

data NCMsg Source #

Messages to the node controller

Constructors

NCMsg
Fields ctrlMsgSender :: !Identifier ctrlMsgSignal :: !ProcessSignal

Instances

Show NCMsg Source #
Methods showsPrec :: Int -> NCMsg -> ShowS # show :: NCMsg -> String # showList :: [NCMsg] -> ShowS #
Binary NCMsg Source #
Methods put :: NCMsg -> Put # get :: Get NCMsg # putList :: [NCMsg] -> Put #

data ProcessSignal Source #

Signals to the node controller (see NCMsg)

Constructors

Link !Identifier
Unlink !Identifier
Monitor !MonitorRef
Unmonitor !MonitorRef
Died Identifier !DiedReason
Spawn !(Closure (Process ())) !SpawnRef
WhereIs !String
Register !String !NodeId !(Maybe ProcessId) !Bool
NamedSend !String !Message
UnreliableSend !LocalProcessId !Message
LocalSend !ProcessId !Message
LocalPortSend !SendPortId !Message
Kill !ProcessId !String
Exit !ProcessId !Message
GetInfo !ProcessId
SigShutdown
GetNodeStats !NodeId

Instances

Show ProcessSignal Source #
Methods showsPrec :: Int -> ProcessSignal -> ShowS # show :: ProcessSignal -> String # showList :: [ProcessSignal] -> ShowS #
Binary ProcessSignal Source #
Methods put :: ProcessSignal -> Put # get :: Get ProcessSignal # putList :: [ProcessSignal] -> Put #

Accessors

localProcesses :: Accessor ValidLocalNodeState (Map LocalProcessId LocalProcess) Source #

localPidCounter :: Accessor ValidLocalNodeState Int32 Source #

localPidUnique :: Accessor ValidLocalNodeState Int32 Source #

localConnections :: Accessor ValidLocalNodeState (Map (Identifier, Identifier) (Connection, ImplicitReconnect)) Source #

localProcessWithId :: LocalProcessId -> Accessor ValidLocalNodeState (Maybe LocalProcess) Source #

localConnectionBetween :: Identifier -> Identifier -> Accessor ValidLocalNodeState (Maybe (Connection, ImplicitReconnect)) Source #

monitorCounter :: Accessor LocalProcessState Int32 Source #

spawnCounter :: Accessor LocalProcessState Int32 Source #

channelCounter :: Accessor LocalProcessState LocalSendPortId Source #

typedChannels :: Accessor LocalProcessState (Map LocalSendPortId TypedChannel) Source #

typedChannelWithId :: LocalSendPortId -> Accessor LocalProcessState (Maybe TypedChannel) Source #

Utilities

forever' :: Monad m => m a -> m b Source #

Show ProcessRegistrationException Source #
Methods showsPrec :: Int -> ProcessRegistrationException -> ShowS # show :: ProcessRegistrationException -> String # showList :: [ProcessRegistrationException] -> ShowS #
Exception ProcessRegistrationException Source #
Methods toException :: ProcessRegistrationException -> SomeException # fromException :: SomeException -> Maybe ProcessRegistrationException # displayException :: ProcessRegistrationException -> String #