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 :: a -> Process ()

Create a link with the supplied object.

class Killable a where

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

Methods

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

exitProc :: Serializable m => a -> m -> Process ()

Instances

Resolvable r => Killable r

Killable ProcessId

class Resolvable a where

Class of things that can be resolved to a ProcessId.

Methods

resolve :: a -> Process (Maybe ProcessId)

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

Instances

Resolvable String

Resolvable ProcessId

Resolvable Recipient

Resolvable LogClient

Resolvable (NodeId, String)

class Routable a where

Provides a unified API for addressing processes.

Minimal complete definition

sendTo, unsafeSendTo

Methods

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

Send a message to the target asynchronously

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

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

unresolvableMessage :: a -> String

Unresolvable Addressable Message

Instances

Routable String

Resolvable a => Routable a

Routable ProcessId

Routable Recipient

Routable (Message -> Process ())

Routable (NodeId, String)

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

Instances

(Resolvable a, Routable a) => Addressable a

sendToRecipient :: Serializable m => Recipient -> m -> Process ()

data Recipient

A simple means of mapping to a receiver.

Constructors

Pid !ProcessId

Registered !String

RemoteRegistered !String !NodeId

Instances

Eq Recipient

Show Recipient

Generic Recipient

Binary Recipient

NFData Recipient

Routable Recipient

Resolvable Recipient

type Rep Recipient

data RegisterSelf

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

Constructors

RegisterSelf

Instances

Generic RegisterSelf

Binary RegisterSelf

NFData RegisterSelf

type Rep RegisterSelf

Interactions

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

A synchronous version of whereis, this relies on call to perform the relevant monitoring of the remote node.

resolveOrDie :: (Routable a, 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

Show CancelWait

Generic CancelWait

Binary CancelWait

NFData CancelWait

type Rep CancelWait

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

Show Shutdown

Generic Shutdown

Binary Shutdown

NFData Shutdown

type Rep Shutdown

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

Show ExitReason

Generic ExitReason

Binary ExitReason

NFData ExitReason

type Rep ExitReason

data ServerDisconnected

Given when a server is unobtainable.

Constructors

ServerDisconnected !DiedReason

Instances

Generic ServerDisconnected

Binary ServerDisconnected

NFData ServerDisconnected

type Rep ServerDisconnected

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

__remoteTable :: RemoteTable -> RemoteTable