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

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

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

data Identifier Source

Union of all kinds of identifiers

Constructors

NodeIdentifier !NodeId
ProcessIdentifier !ProcessId
SendPortIdentifier !SendPortId

Instances

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

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 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 LocalNodeState Source

Local node state

Constructors

LocalNodeState
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 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

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
Functor Process
Applicative Process
MonadIO Process
MonadReader LocalProcess Process
Serializable b => MkTDict (Process b)
Typeable (* -> *) Process

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
Show ImplicitReconnect

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

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

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

Alternative ReceivePort
Monad ReceivePort
Functor ReceivePort
Applicative ReceivePort
Typeable (* -> *) ReceivePort

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
Binary Message
Typeable * 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
Ord MonitorRef
Show MonitorRef
Generic MonitorRef
Binary MonitorRef
Hashable MonitorRef
Typeable * MonitorRef
type Rep MonitorRef

data ProcessMonitorNotification Source

Message sent by process monitors

Constructors

ProcessMonitorNotification !MonitorRef !ProcessId !DiedReason

Instances

Show ProcessMonitorNotification
Binary ProcessMonitorNotification
Typeable * ProcessMonitorNotification

data NodeMonitorNotification Source

Message sent by node monitors

Constructors

NodeMonitorNotification !MonitorRef !NodeId !DiedReason

Instances

Show NodeMonitorNotification
Binary NodeMonitorNotification
Typeable * NodeMonitorNotification

data PortMonitorNotification Source

Message sent by channel (port) monitors

Constructors

PortMonitorNotification !MonitorRef !SendPortId !DiedReason

Instances

Show PortMonitorNotification
Binary PortMonitorNotification
Typeable * PortMonitorNotification

data ProcessExitException Source

Internal exception thrown indirectly by exit

Constructors

ProcessExitException !ProcessId !Message

Instances

Show ProcessExitException
Exception ProcessExitException
Typeable * ProcessExitException

data ProcessLinkException Source

Exceptions thrown when a linked process dies

Constructors

ProcessLinkException !ProcessId !DiedReason

Instances

Show ProcessLinkException
Exception ProcessLinkException
Typeable * ProcessLinkException

data NodeLinkException Source

Exception thrown when a linked node dies

Constructors

NodeLinkException !NodeId !DiedReason

Instances

Show NodeLinkException
Exception NodeLinkException
Typeable * NodeLinkException

data PortLinkException Source

Exception thrown when a linked channel (port) dies

Constructors

PortLinkException !SendPortId !DiedReason

Instances

Show PortLinkException
Exception PortLinkException
Typeable * PortLinkException

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

Constructors

ProcessRegistrationException !String

Instances

Show ProcessRegistrationException
Exception ProcessRegistrationException
Typeable * ProcessRegistrationException

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

newtype DidUnmonitor Source

(Asynchronous) reply from unmonitor

Constructors

DidUnmonitor MonitorRef

Instances

Binary DidUnmonitor
Typeable * DidUnmonitor

newtype DidUnlinkProcess Source

(Asynchronous) reply from unlink

Constructors

DidUnlinkProcess ProcessId

Instances

Binary DidUnlinkProcess
Typeable * DidUnlinkProcess

newtype DidUnlinkNode Source

(Asynchronous) reply from unlinkNode

Constructors

DidUnlinkNode NodeId

Instances

Binary DidUnlinkNode
Typeable * DidUnlinkNode

newtype DidUnlinkPort Source

(Asynchronous) reply from unlinkPort

Constructors

DidUnlinkPort SendPortId

Instances

Binary DidUnlinkPort
Typeable * DidUnlinkPort

newtype SpawnRef Source

SpawnRef are used to return pids of spawned processes

Constructors

SpawnRef Int32

Instances

Eq SpawnRef
Show SpawnRef
Binary SpawnRef
Typeable * SpawnRef

data DidSpawn Source

(Asynchronius) reply from spawn

Constructors

DidSpawn SpawnRef ProcessId

Instances

Show DidSpawn
Binary DidSpawn
Typeable * DidSpawn

data WhereIsReply Source

(Asynchronous) reply from whereis

Constructors

WhereIsReply String (Maybe ProcessId)

Instances

Show WhereIsReply
Binary WhereIsReply
Typeable * WhereIsReply

data RegisterReply Source

(Asynchronous) reply from register and unregister

Constructors

RegisterReply String Bool

Instances

Show RegisterReply
Binary RegisterReply
Typeable * RegisterReply

data ProcessInfo Source

Provide information about a running process

Constructors

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

Instances

Eq ProcessInfo
Show ProcessInfo
Binary ProcessInfo
Typeable * ProcessInfo

data ProcessInfoNone Source

Constructors

ProcessInfoNone DiedReason

Instances

Show ProcessInfoNone
Binary ProcessInfoNone
Typeable * ProcessInfoNone

data NodeStats Source

Constructors

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

Instances

Eq NodeStats
Show NodeStats
Binary NodeStats
Typeable * NodeStats

Node controller internal data types

data NCMsg Source

Messages to the node controller

Constructors

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

Instances

Show NCMsg
Binary NCMsg

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
LocalSend !ProcessId !Message
LocalPortSend !SendPortId !Message
Kill !ProcessId !String
Exit !ProcessId !Message
GetInfo !ProcessId
SigShutdown
GetNodeStats !NodeId

Instances

Show ProcessSignal
Binary ProcessSignal

Accessors

localProcesses :: Accessor LocalNodeState (Map LocalProcessId LocalProcess) Source

localPidCounter :: Accessor LocalNodeState Int32 Source

localPidUnique :: Accessor LocalNodeState Int32 Source

localConnections :: Accessor LocalNodeState (Map (Identifier, Identifier) (Connection, ImplicitReconnect)) Source

localProcessWithId :: LocalProcessId -> Accessor LocalNodeState (Maybe LocalProcess) Source

localConnectionBetween :: Identifier -> Identifier -> Accessor LocalNodeState (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