Akka.Actor Namespace

Classes


  Class Description
Public class ActorBase
Class ActorBase.
Class ActorBase.
Public class ActorCell
Class ActorCell.
Public class ActorIdentity
Public class ActorInitializationException
Class ActorInitializationException.
Public class ActorKilledException
Class ActorKilledException.
Public class ActorNotFoundException
Class ActorNotFoundException.
Public class ActorPath
Actor path is a unique path to an actor that shows the creation path up through the actor tree to the root actor. ActorPath defines a natural ordering (so that ActorRefs can be put into collections with this requirement); this ordering is intended to be as fast as possible, which owing to the bottom-up recursive nature of ActorPath is sorted by path elements FROM RIGHT TO LEFT, where RootActorPath > ChildActorPath in case the number of elements is different. Two actor paths are compared equal when they have the same name and parent elements, including the root address information. That does not necessarily mean that they point to the same incarnation of the actor if the actor is re-created with the same path. In other words, in contrast to how actor references are compared the unique id of the actor is not taken into account when comparing actor paths.
Public class ActorRef
Public class ActorRefExtensions
An extension method class for working with ActorRefs
Public class ActorRefFactoryShared
This class contains implementations originally found in Akka´s trait ActorRefFactory in ActorRefProvider.scala https://github.com/akka/akka/blob/master/akka-actor/src/main/scala/akka/actor/ActorRefProvider.scala#L180 IActorRefFactory corresponds to that trait, but since it is an interface it cannot contain any code, hence this class.
Public class ActorRefSurrogate
Public class ActorRefWithCell
Public class ActorSelection
Class ActorSelection.
Public class ActorSelectionMessage
Class ActorSelectionMessage.
Public class ActorSystem
An actor system is a hierarchical group of actors which share common configuration, e.g. dispatchers, deployments, remote capabilities and addresses. It is also the entry point for creating or looking up actors. There are several possibilities for creating actors (see [[Akka.Actor.Props]] for details on `props`):
C#
system.ActorOf(props, "name");
system.ActorOf(props);
system.ActorOf(Props.Create(typeof(MyActor)), "name");
system.ActorOf(Props.Create(() => new MyActor(arg1, arg2), "name");
Where no name is given explicitly, one will be automatically generated. Important Notice: This class is not meant to be extended by user code.
Public class Address
Class Address.
Public class AkkaException
Class AkkaException.
Public class AllForOneStrategy
Class AllForOneStrategy. This class cannot be inherited.
Public class BroadcastActorRef
Public class ChildActorPath
Class ChildActorPath.
Public class DeadLetterActorRef
Class DeadLetterActorRef.
Public class DeadLetterMailbox
Public class DeathPactException
A DeathPactException is thrown by an Actor that receives a Terminated(someActor) message that it doesn't handle itself, effectively crashing the Actor and escalating to the supervisor.
Public class Deploy
Public class Deployer
Public class EmptyLocalActorRef
Public class EventStreamActor
Class EventStreamActor.
Public class ExtendedActorSystem
Static helper class used for resolving extensions
Public class ExtensionIdProvider<(Of <(<'T>)>)>
Class ExtensionBase.
Public class Failure
Represents a single failure.
Public class Failures
Collection of failures, used to keep track of how many times a given actor have failed.
Public class FSM<(Of <(<'TS, TD>)>)>
Finite state machine (FSM) actor.
Public class FSM<(Of <(<'TS, TD>)>)>..::..TransformHelper
Public class FSMBase
Public class FSMBase..::..CurrentState<(Of <(<'TS>)>)>
Message type which is sent directly to the subscriber Actor in FSMBase..::..SubscribeTransitionCallBack before sending any [Transition{TS}] messages.
Public class FSMBase..::..Event<(Of <(<'TD>)>)>
All messages sent to the [FSM{TS,TD}] will be wrapped inside an [Event{TD}], which allows pattern matching to extract both state and data.
Public class FSMBase..::..Failure
Signifies that the [FSM{T,S}] is shutting itself down because of an error, e.g. if the state to transition into does not exist. You can use this to communicate a more precise cause to the [FSM{T,S}.OnTermination] block.
Public class FSMBase..::..LogEntry<(Of <(<'TS, TD>)>)>
Log entry of the [LoggingFSM] - can be obtained by calling [GetLog]
Public class FSMBase..::..Normal
Default FSMBase..::..Reason if calling Stop().
Public class FSMBase..::..Reason
Reason why this [FSM{T,S}] is shutting down
Public class FSMBase..::..Shutdown
Reason given when someone as calling Stop from outside; also applies to ActorSystem supervision directive.
Public class FSMBase..::..State<(Of <(<'TS, TD>)>)>
This captures all of the managed state of the [FSM{T,S}]: the state name, the state data, possibly custom timeout, stop reason, and repleis accumulated while processing the last message.
Public class FSMBase..::..StateTimeout
Used in the event of a timeout between transitions
Public class FSMBase..::..StopEvent<(Of <(<'TS, TD>)>)>
Class respresenting the stae of the [FSM{TS,TD}] within the OnTermination block.
Public class FSMBase..::..SubscribeTransitionCallBack
Send this to an FSMBase..::..SubscribeTransitionCallBack to request first the FSMBase..::..UnsubscribeTransitionCallBack followed by a series of [Transition{TS}] updates. Cancel the subscription using [CurrentState{TS}].
Public class FSMBase..::..Transition<(Of <(<'TS>)>)>
Message type which is used to communicate transitions between states to all subscribed listeners (use FSMBase..::..SubscribeTransitionCallBack)
Public class FSMBase..::..UnsubscribeTransitionCallBack
Unsubscribe from FSMBase..::..SubscribeTransitionCallBack notifications which were initializd by sending the corresponding [Transition{TS}].
Public class FutureActorRef
Public class Futures
Extension method class designed to create Ask support for non-ActorRef objects such as ActorSelection.
Public class GracefulStopSupport
Returns a Task that will be completed with success when existing messages of the target actor have been processed and the actor has been terminated. Useful when you need to wait for termination or compose ordered termination of several actors, which should only be done outside of the ActorSystem as blocking inside ActorBase is discouraged.

Remarks


IMPORTANT: the actor being terminated and its supervisor being informed of the availability of the deceased actor's name are two distinct operations, which do not obey any reliable ordering.
If the target actor isn't terminated within the timeout the Task is complted with failure. If you want to invoke specialized stopping logic on your target actor instead of PoisonPill, you can pass your stop command as a parameter:
C#
GracefulStop(someChild, timeout, MyStopGracefullyMessage).ContinueWith(r => {
    // Do something after someChild starts being stopped.
});
Public class GuardianActor
Class GuardianActor.
Public class Identify
Public class IllegalActorNameException
IllegalActorNameException is thrown when an Actor with an invalid name is deployed our bound.
Public class IllegalActorStateException
IllegalActorStateException is thrown when a core invariant in the Actor implementation has been voilated. For instance, if you try to create an Actor that doesn't inherit from ActorBase.
Public class InternalActorRef
Public class InvalidMessageException
InvalidMessageException is thrown when an invalid message is sent to an Actor. Currently only null is an invalid message.
Public class Kill
Public class LocalActorRef
Public class LocalActorRefProvider
Class LocalActorRefProvider. This class cannot be inherited.
Public class LocalScope
Public class MinimalActorRef
Public class NameAndUid
Public class Nobody
This is an internal look-up failure token, not useful for anything else.
Public class NoSender
Public class OneForOneStrategy
Class OneForOneStrategy. This class cannot be inherited.
Public class PipeToSupport
Creates the PipeTo pattern for automatically sending the results of completed tasks into the inbox of a designated Actor
Public class PoisonPill
Public class PreRestartException
Class PreRestartException.
Public class Props
Props is a configuration object using in creating an [[Actor]]; it is immutable, so it is thread-safe and fully shareable. Examples on C# API:
C#
private Props props = Props.Empty();
private Props props = Props.Create(() => new MyActor(arg1, arg2));

private Props otherProps = props.WithDispatcher("dispatcher-id");
private Props otherProps = props.WithDeploy(deployment info);
Public class ReceiveActor
Public class ReceiveTimeout
Public class RemoteScope
Public class RepointableActorRef
Public class ReservedActorRef
Public class RootActorPath
Class RootActorPath.
Public class RootGuardianActorRef
Public class RootGuardianSupervisor
Top-level anchor for the supervision hierarchy of this actor system. Note: This class is called theOneWhoWalksTheBubblesOfSpaceTime in Akka
Public class Scheduler
Class Scheduler.
Public class Scope
Public class SelectChildName
Class SelectChildName.
Public class SelectChildPattern
Class SelectChildPattern.
Public class SelectionPathElement
Class SelectionPathElement.
Public class SelectParent
Class SelectParent.
Public class Settings
Settings are the overall ActorSystem Settings which also provides a convenient access to the Config object. For more detailed information about the different possible configuration options, look in the Akka .NET Documentation under "Configuration"
Public class StashFactory
Static factor used for creating Stash instances
Public class StashOverflowException
Is thrown when the size of the Stash exceeds the capacity of the stash
Public class Status
Classes for passing status back to the sender. Used for internal ACKing protocol, but also exposed as a utility class for user-specific ACKing if needed.
Public class Status..::..Failure
Indicates the failure of some operation that was requested and includes an Exception describing the underlying cause of the problem.
Public class Status..::..Success
Indicates the success of some operation which has been performed
Public class SupervisorStrategy
Base class for supervision strategies
Public class SystemGuardianActor
Public class Terminated
Public class TerminatedProps
Public class TypedActor
Class TypedActor.
Public class UnstartedCell
Public class UntypedActor
Class UntypedActor.
Public class UntypedActorWithBoundedStash
An UntypedActor with bounded Stash capabilites
Public class UntypedActorWithUnboundedStash
An UntypedActor with Unbounded Stash capabilites
Public class VirtualPathContainer

Structures


  Structure Description
Public structure Envelope
Envelope class, represents a message and the sender of the message.

Interfaces


  Interface Description
Public interface ActorRefProvider
Public interface AutoReceivedMessage
Public interface Cell
INTERNAL
Public interface IActorContext
Public interface IActorLogging
Interface used on Actors that have an explicit requirement for a logger
Public interface IActorRefFactory
Interface IActorRefFactory
Public interface IActorStash
Marker interface for adding stash support
Public interface ICanTell
Public interface IExtension
Marker interface used to identify an object as ActorSystem extension
Public interface IExtensionId
Non-generic version of interface, mostly to avoid issues with generic casting
Public interface IExtensionId<(Of <(<'T>)>)>
Marker interface used to distinguish a unqiue ActorSystem extensions
Public interface IHandle<(Of <(<'TMessage>)>)>
Interface IHandle
Public interface IInternalActor
Contains things needed by the framework
Public interface ILogReceive
Interface ILogReceive
Public interface IStash
Public interface used to expose stash capabilites to user-level actors
Public interface IUntypedActorContext
Interface IUntypedActorContext
Public interface NoSerializationVerificationNeeded
Marker Interface NoSerializationVerificationNeeded, this interface prevents implementing message types from being serialized if configuration setting 'akka.actor.serialize-messages' is "on"
Public interface PossiblyHarmful
Marker interface to indicate that a message might be potentially harmful; this is used to block messages coming in over remoting.
Public interface WithBoundedStash
Lets the StashFactory know that this Actor needs stash support with restricted storage capacity
Public interface WithUnboundedStash
Lets the StashFactory know that this Actor needs stash support with unrestricted storage capacity

Delegates


  Delegate Description
Public delegate FSM<(Of <(<'TS, TD>)>)>..::..StateFunction
Public delegate FSM<(Of <(<'TS, TD>)>)>..::..TransitionHandler
Public delegate Receive
Delegate Receive
Public delegate UntypedReceive
Delegate UntypedReceive

Enumerations


  Enumeration Description
Public enumeration Directive
Enum Directive for supervisor actions