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
Namespace: Akka.Dispatch
Assembly: Akka.dll
Syntax
public abstract class MessageDispatcher

Constructors

| Improve this Doc View Source

MessageDispatcher(MessageDispatcherConfigurator)

Initializes a new instance of the MessageDispatcher class.

Declaration
protected MessageDispatcher(MessageDispatcherConfigurator configurator)
Parameters
Type Name Description
MessageDispatcherConfigurator configurator

TBD

Fields

| Improve this Doc View Source

DefaultThroughput

The default throughput

Declaration
public const int DefaultThroughput = 100
Field Value
Type Description
Int32

Properties

| Improve this Doc View Source

Configurator

The configurator used to configure this message dispatcher.

Declaration
public MessageDispatcherConfigurator Configurator { get; }
Property Value
Type Description
MessageDispatcherConfigurator
| Improve this Doc View Source

EventStream

The EventStream for this dispatcher's actor system

Declaration
public EventStream EventStream { get; }
Property Value
Type Description
EventStream
| Improve this Doc View Source

Id

The ID for this dispatcher.

Declaration
public string Id { get; protected set; }
Property Value
Type Description
String
| Improve this Doc View Source

Inhabitants

The number of actors attached to this MessageDispatcher

Declaration
protected long Inhabitants { get; }
Property Value
Type Description
Int64
| Improve this Doc View Source

Mailboxes

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

Declaration
public Mailboxes Mailboxes { get; }
Property Value
Type Description
Mailboxes
| Improve this Doc View Source

Throughput

Gets or sets the throughput.

Declaration
public int Throughput { get; set; }
Property Value
Type Description
Int32

The throughput.
| Improve this Doc View Source

ThroughputDeadlineTime

Gets or sets the throughput deadline time.

Declaration
public long? ThroughputDeadlineTime { get; protected set; }
Property Value
Type Description
Nullable<Int64>

The throughput deadline time.

Methods

| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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
| Improve this Doc View Source

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
| Improve this Doc View Source

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.
| Improve this Doc View Source

Schedule(IRunnable)

Schedules an arbitrary task to run.

Declaration
public void Schedule(IRunnable run)
Parameters
Type Name Description
IRunnable run

The run.
| Improve this Doc View Source

Schedule(Action)

Schedules the specified delegate.

Declaration
public void Schedule(Action run)
Parameters
Type Name Description
Action run

The run.
| Improve this Doc View Source

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