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
Data NodeId Source
Ord NodeId Source
Show NodeId Source
Generic NodeId Source
Hashable NodeId Source
NFData NodeId Source
Binary NodeId Source
type Rep NodeId Source

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
Data LocalProcessId Source
Ord LocalProcessId Source
Show LocalProcessId Source
Generic LocalProcessId Source
Hashable LocalProcessId Source
Binary LocalProcessId Source
type Rep LocalProcessId Source

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
Data ProcessId Source
Ord ProcessId Source
Show ProcessId Source
Generic ProcessId Source
Hashable ProcessId Source
NFData ProcessId Source
Binary ProcessId Source
type Rep ProcessId Source

data Identifier Source

Union of all kinds of identifiers

Constructors

NodeIdentifier !NodeId
ProcessIdentifier !ProcessId
SendPortIdentifier !SendPortId

Instances

Eq Identifier Source
Ord Identifier Source
Show Identifier Source
Generic Identifier Source
Hashable Identifier Source
NFData Identifier Source
Binary Identifier Source
type Rep Identifier Source

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
Exception NodeClosedException Source

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

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
Functor Process Source
MonadFix Process Source
Applicative Process Source
MonadIO Process Source
MonadReader LocalProcess Process Source
Serializable b => MkTDict (Process b) 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
Show ImplicitReconnect Source

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
Ord SendPortId Source
Show SendPortId Source
Generic SendPortId Source
Hashable SendPortId Source
NFData SendPortId Source
Binary SendPortId Source
type Rep SendPortId Source

data TypedChannel Source

Constructors

forall a . 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
Ord (SendPort a) Source
Show (SendPort a) Source
Generic (SendPort a) Source
Hashable a => Hashable (SendPort a) Source
NFData a => NFData (SendPort a) Source
Serializable a => Binary (SendPort a) Source
type Rep (SendPort a) Source

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
Functor ReceivePort Source
Applicative ReceivePort Source
Alternative ReceivePort Source

Messages

data Message Source

Messages consist of their typeRep fingerprint and their encoding

Constructors

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

Instances

Show Message Source
NFData Message Source
Binary Message Source

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
Ord MonitorRef Source
Show MonitorRef Source
Generic MonitorRef Source
Hashable MonitorRef Source
NFData MonitorRef Source
Binary MonitorRef Source
type Rep MonitorRef Source

data ProcessMonitorNotification Source

Message sent by process monitors

Constructors

ProcessMonitorNotification !MonitorRef !ProcessId !DiedReason

Instances

Show ProcessMonitorNotification Source
Binary ProcessMonitorNotification Source

data NodeMonitorNotification Source

Message sent by node monitors

Constructors

NodeMonitorNotification !MonitorRef !NodeId !DiedReason

Instances

Show NodeMonitorNotification Source
Binary NodeMonitorNotification Source

data PortMonitorNotification Source

Message sent by channel (port) monitors

Constructors

PortMonitorNotification !MonitorRef !SendPortId !DiedReason

Instances

Show PortMonitorNotification Source
Binary PortMonitorNotification Source

data ProcessExitException Source

Internal exception thrown indirectly by exit

Constructors

ProcessExitException !ProcessId !Message

Instances

Show ProcessExitException Source
Exception ProcessExitException Source

data ProcessLinkException Source

Exceptions thrown when a linked process dies

Constructors

ProcessLinkException !ProcessId !DiedReason

Instances

Show ProcessLinkException Source
Exception ProcessLinkException Source

data NodeLinkException Source

Exception thrown when a linked node dies

Constructors

NodeLinkException !NodeId !DiedReason

Instances

Show NodeLinkException Source
Exception NodeLinkException Source

data PortLinkException Source

Exception thrown when a linked channel (port) dies

Constructors

PortLinkException !SendPortId !DiedReason

Instances

Show PortLinkException Source
Exception PortLinkException Source

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

Show ProcessRegistrationException Source
Exception ProcessRegistrationException Source

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
Show DiedReason Source
NFData DiedReason Source
Binary DiedReason Source

newtype DidUnmonitor Source

(Asynchronous) reply from unmonitor

Constructors

DidUnmonitor MonitorRef

Instances

Binary DidUnmonitor Source

newtype DidUnlinkProcess Source

(Asynchronous) reply from unlink

Constructors

DidUnlinkProcess ProcessId

Instances

Binary DidUnlinkProcess Source

newtype DidUnlinkNode Source

(Asynchronous) reply from unlinkNode

Constructors

DidUnlinkNode NodeId

Instances

Binary DidUnlinkNode Source

newtype DidUnlinkPort Source

(Asynchronous) reply from unlinkPort

Constructors

DidUnlinkPort SendPortId

Instances

Binary DidUnlinkPort Source

newtype SpawnRef Source

SpawnRef are used to return pids of spawned processes

Constructors

SpawnRef Int32

Instances

Eq SpawnRef Source
Show SpawnRef Source
Binary SpawnRef Source

data DidSpawn Source

(Asynchronius) reply from spawn

Constructors

DidSpawn SpawnRef ProcessId

Instances

Show DidSpawn Source
Binary DidSpawn Source

data WhereIsReply Source

(Asynchronous) reply from whereis

Constructors

WhereIsReply String (Maybe ProcessId)

Instances

Show WhereIsReply Source
Binary WhereIsReply Source

data RegisterReply Source

(Asynchronous) reply from register and unregister

Constructors

RegisterReply String Bool (Maybe ProcessId)

Instances

Show RegisterReply Source
Binary RegisterReply Source

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
Show ProcessInfo Source
Binary ProcessInfo Source

data ProcessInfoNone Source

Constructors

ProcessInfoNone DiedReason

Instances

Show ProcessInfoNone Source
Binary ProcessInfoNone Source

data NodeStats Source

Constructors

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

Instances

Eq NodeStats Source
Show NodeStats Source
Binary NodeStats Source

Node controller internal data types

data NCMsg Source

Messages to the node controller

Constructors

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

Instances

Show NCMsg Source
Binary NCMsg Source

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
Binary ProcessSignal Source

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