Class MessageDispatcher

Class responsible for pushing messages from an actor's mailbox into its receive methods. Comes in many different flavors.

Inheritance

object

MessageDispatcher

Dispatcher

CallingThreadDispatcher

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Dispatch

Assembly: Akka.dll

Syntax

public abstract class MessageDispatcher

Constructors

MessageDispatcher(MessageDispatcherConfigurator)

Initializes a new instance of the MessageDispatcher class.

Declaration

protected MessageDispatcher(MessageDispatcherConfigurator configurator)

Parameters

Type	Name	Description
MessageDispatcherConfigurator	configurator	TBD

Fields

DefaultThroughput

The default throughput

Declaration

public const int DefaultThroughput = 100

Field Value

Type	Description
int

Properties

Configurator

The configurator used to configure this message dispatcher.

Declaration

public MessageDispatcherConfigurator Configurator { get; }

Property Value

Type	Description
MessageDispatcherConfigurator

EventStream

The EventStream for this dispatcher's actor system

Declaration

public EventStream EventStream { get; }

Property Value

Type	Description
EventStream

Id

The ID for this dispatcher.

Declaration

public string Id { get; protected set; }

Property Value

Type	Description
string

Inhabitants

The number of actors attached to this MessageDispatcher

Declaration

protected long Inhabitants { get; }

Property Value

Type	Description
long

Mailboxes

The list of available Mailboxes for this dispatcher's actor system

Declaration

public Mailboxes Mailboxes { get; }

Property Value

Type	Description
Mailboxes

Throughput

Gets or sets the throughput.

Declaration

public int Throughput { get; set; }

Property Value

Type	Description
int	The throughput.

ThroughputDeadlineTime

Gets or sets the throughput deadline time.

Declaration

public long? ThroughputDeadlineTime { get; protected set; }

Property Value

Type	Description
long?	The throughput deadline time.

Methods

Attach(ActorCell)

Attaches the dispatcher to the ActorCell

Practically, doesn't do very much right now - dispatchers aren't responsible for creating mailboxes in Akka.NET

Declaration

public virtual void Attach(ActorCell cell)

Parameters

Type	Name	Description
ActorCell	cell	The ActorCell belonging to the actor who's attaching to this dispatcher.

Detach(ActorCell)

Detaches the dispatcher to the ActorCell

Only really used in dispatchers with 1:1 relationship with dispatcher.

Declaration

public virtual void Detach(ActorCell cell)

Parameters

Type	Name	Description
ActorCell	cell	The ActorCell belonging to the actor who's detaching from this dispatcher.

Dispatch(ActorCell, Envelope)

Dispatches a user-defined message from a mailbox to an ActorCell

Declaration

public virtual void Dispatch(ActorCell cell, Envelope envelope)

Parameters

Type	Name	Description
ActorCell	cell	TBD
Envelope	envelope	TBD

ExecuteTask(IRunnable)

Schedules the IRunnable to be executed.

Declaration

protected abstract void ExecuteTask(IRunnable run)

Parameters

Type	Name	Description
IRunnable	run	The asynchronous task we're going to run

ReportFailure(Exception)

Publish failure that occurred while inside the running MessageDispatcher to the EventStream.

Declaration

protected void ReportFailure(Exception ex)

Parameters

Type	Name	Description
Exception	ex	The failure to publish.

Schedule(IRunnable)

Schedules an arbitrary task to run.

Declaration

public void Schedule(IRunnable run)

Parameters

Type	Name	Description
IRunnable	run	The run.

Schedule(Action)

Schedules the specified delegate.

Declaration

public void Schedule(Action run)

Parameters

Type	Name	Description
Action	run	The run.

SystemDispatch(ActorCell, SystemMessage)

Dispatches a SystemMessage from a mailbox to an ActorCell

Declaration

public virtual void SystemDispatch(ActorCell cell, SystemMessage message)

Parameters

Type	Name	Description
ActorCell	cell	TBD
SystemMessage	message	TBD

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)