 | Dispatcher Class |
The event-based Dispatcher binds a set of actors to a thread pool backed up
by a thread-safe queue.
The preferred way of creating dispatchers is to define them in configuration and use the
Lookup(String) method.
Inheritance HierarchySystemObject
Akka.DispatchMessageDispatcher
Akka.DispatchDispatcher
Akka.DispatchCurrentSynchronizationContextDispatcher
Akka.DispatchPinnedDispatcher
Akka.DispatchMessageDispatcher
Akka.DispatchDispatcher
Akka.DispatchCurrentSynchronizationContextDispatcher
Akka.DispatchPinnedDispatcher
Namespace: Akka.Dispatch
Assembly: Akka (in Akka.dll) Version: 1.2.3.42 (1.2.3.42)
SyntaxThe Dispatcher type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Dispatcher |
Used to create a default Dispatcher |
Properties| Name | Description | |
|---|---|---|
 | Configurator |
The configurator used to configure this message dispatcher.
(Inherited from MessageDispatcher.) |
| EventStream |
The EventStream for this dispatcher's actor system
(Inherited from MessageDispatcher.) |
| Id |
The ID for this dispatcher.
(Inherited from MessageDispatcher.) |
 | Inhabitants |
The number of actors attached to this MessageDispatcher (Inherited from MessageDispatcher.) |
| Mailboxes |
The list of available Mailboxes for this dispatcher's actor system
(Inherited from MessageDispatcher.) |
| ShutdownTimeout |
INTERNAL API
When the dispatcher no longer has any actors registered, the ShutdownTimeout determines
how long it will wait until it shuts itself down, defaulting to your Akka.NET config's 'akka.actor.default-dispatcher.shutdown-timeout'
or the system default specified.
(Inherited from MessageDispatcher.) |
| Throughput |
Gets or sets the throughput.
(Inherited from MessageDispatcher.) |
| ThroughputDeadlineTime |
Gets or sets the throughput deadline time.
(Inherited from MessageDispatcher.) |
Methods| Name | Description | |
|---|---|---|
| Attach |
Attaches the dispatcher to the ActorCell (Inherited from MessageDispatcher.)Remarks
Practically, doesn't do very much right now - dispatchers aren't responsible for creating
mailboxes in Akka.NET
|
| Detach |
Detaches the dispatcher to the ActorCell (Inherited from MessageDispatcher.)Remarks
Only really used in dispatchers with 1:1 relationship with dispatcher.
|
| Dispatch |
Dispatches a user-defined message from a mailbox to an ActorCell (Inherited from MessageDispatcher.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | ExecuteTask |
Schedules the IRunnable to be executed.
(Overrides MessageDispatcherExecuteTask(IRunnable).) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ReportFailure |
Publish failure that occurred while inside the running MessageDispatcher
to the EventStream.
(Inherited from MessageDispatcher.) |
| Schedule(Action) |
Schedules the specified delegate.
(Inherited from MessageDispatcher.) |
| Schedule(IRunnable) |
Schedules an arbitrary task to run.
(Inherited from MessageDispatcher.) |
| Shutdown |
INTERNAL API
Called one time every time an actor is detached from this dispatcher and this dispatcher has no actors left attached
(Overrides MessageDispatcherShutdown.) |
| SystemDispatch |
Dispatches a SystemMessage from a mailbox to an ActorCell (Inherited from MessageDispatcher.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AsInstanceOfT |
TBD
(Defined by Extensions.) |
| Match | Overloaded.
Matches the specified target.
(Defined by PatternMatch.) |
| MatchT | Overloaded.
Matches the specified target and return a result of target processing.
(Defined by PatternMatch.) |
See Also