Akka.Actor Namespace
Classes
Class | Description | |
---|---|---|
![]() |
ActorBase |
Class ActorBase.
Class ActorBase.
|
![]() |
ActorCell |
Class ActorCell.
|
![]() |
ActorIdentity | |
![]() |
ActorInitializationException |
Class ActorInitializationException.
|
![]() |
ActorKilledException |
Class ActorKilledException.
|
![]() |
ActorNotFoundException |
Class ActorNotFoundException.
|
![]() |
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.
|
![]() |
ActorRef | |
![]() |
ActorRefExtensions |
An extension method class for working with ActorRefs
|
![]() |
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.
|
![]() |
ActorRefSurrogate | |
![]() |
ActorRefWithCell | |
![]() |
ActorSelection |
Class ActorSelection.
|
![]() |
ActorSelectionMessage |
Class ActorSelectionMessage.
|
![]() |
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"); |
![]() |
Address |
Class Address.
|
![]() |
AkkaException |
Class AkkaException.
|
![]() |
AllForOneStrategy |
Class AllForOneStrategy. This class cannot be inherited.
|
![]() |
BroadcastActorRef | |
![]() |
ChildActorPath |
Class ChildActorPath.
|
![]() |
DeadLetterActorRef |
Class DeadLetterActorRef.
|
![]() |
DeadLetterMailbox | |
![]() |
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.
|
![]() |
Deploy | |
![]() |
Deployer | |
![]() |
EmptyLocalActorRef | |
![]() |
EventStreamActor |
Class EventStreamActor.
|
![]() |
ExtendedActorSystem |
Static helper class used for resolving extensions
|
![]() |
ExtensionIdProvider<(Of <(<'T>)>)> |
Class ExtensionBase.
|
![]() |
Failure |
Represents a single failure.
|
![]() |
Failures |
Collection of failures, used to keep track of how many times a given actor have failed.
|
![]() |
FSM<(Of <(<'TS, TD>)>)> |
Finite state machine (FSM) actor.
|
![]() |
FSM<(Of <(<'TS, TD>)>)>..::..TransformHelper | |
![]() |
FSMBase | |
![]() |
FSMBase..::..CurrentState<(Of <(<'TS>)>)> |
Message type which is sent directly to the subscriber Actor in FSMBase..::..SubscribeTransitionCallBack
before sending any [Transition{TS}] messages.
|
![]() |
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.
|
![]() |
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.
|
![]() |
FSMBase..::..LogEntry<(Of <(<'TS, TD>)>)> |
Log entry of the [LoggingFSM] - can be obtained by calling [GetLog]
|
![]() |
FSMBase..::..Normal |
Default FSMBase..::..Reason if calling Stop().
|
![]() |
FSMBase..::..Reason |
Reason why this [FSM{T,S}] is shutting down
|
![]() |
FSMBase..::..Shutdown |
Reason given when someone as calling Stop from outside;
also applies to ActorSystem supervision directive.
|
![]() |
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.
|
![]() |
FSMBase..::..StateTimeout |
Used in the event of a timeout between transitions
|
![]() |
FSMBase..::..StopEvent<(Of <(<'TS, TD>)>)> |
Class respresenting the stae of the [FSM{TS,TD}] within the OnTermination block.
|
![]() |
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}].
|
![]() |
FSMBase..::..Transition<(Of <(<'TS>)>)> |
Message type which is used to communicate transitions between states to all subscribed listeners
(use FSMBase..::..SubscribeTransitionCallBack)
|
![]() |
FSMBase..::..UnsubscribeTransitionCallBack |
Unsubscribe from FSMBase..::..SubscribeTransitionCallBack notifications which were
initializd by sending the corresponding [Transition{TS}].
|
![]() |
FutureActorRef | |
![]() |
Futures |
Extension method class designed to create Ask support for
non-ActorRef objects such as ActorSelection.
|
![]() |
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.
RemarksC# GracefulStop(someChild, timeout, MyStopGracefullyMessage).ContinueWith(r => {
// Do something after someChild starts being stopped.
}); |
![]() |
GuardianActor |
Class GuardianActor.
|
![]() |
Identify | |
![]() |
IllegalActorNameException |
IllegalActorNameException is thrown when an Actor with an invalid name is deployed our bound.
|
![]() |
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.
|
![]() |
InternalActorRef | |
![]() |
InvalidMessageException |
InvalidMessageException is thrown when an invalid message is sent to an Actor.
Currently only null is an invalid message.
|
![]() |
Kill | |
![]() |
LocalActorRef | |
![]() |
LocalActorRefProvider |
Class LocalActorRefProvider. This class cannot be inherited.
|
![]() |
LocalScope | |
![]() |
MinimalActorRef | |
![]() |
NameAndUid | |
![]() |
Nobody |
This is an internal look-up failure token, not useful for anything else.
|
![]() |
NoSender | |
![]() |
OneForOneStrategy |
Class OneForOneStrategy. This class cannot be inherited.
|
![]() |
PipeToSupport |
Creates the PipeTo pattern for automatically sending the results of completed tasks
into the inbox of a designated Actor
|
![]() |
PoisonPill | |
![]() |
PreRestartException |
Class PreRestartException.
|
![]() |
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); |
![]() |
ReceiveActor | |
![]() |
ReceiveTimeout | |
![]() |
RemoteScope | |
![]() |
RepointableActorRef | |
![]() |
ReservedActorRef | |
![]() |
RootActorPath |
Class RootActorPath.
|
![]() |
RootGuardianActorRef | |
![]() |
RootGuardianSupervisor |
Top-level anchor for the supervision hierarchy of this actor system.
Note: This class is called theOneWhoWalksTheBubblesOfSpaceTime in Akka
|
![]() |
Scheduler |
Class Scheduler.
|
![]() |
Scope | |
![]() |
SelectChildName |
Class SelectChildName.
|
![]() |
SelectChildPattern |
Class SelectChildPattern.
|
![]() |
SelectionPathElement |
Class SelectionPathElement.
|
![]() |
SelectParent |
Class SelectParent.
|
![]() |
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"
|
![]() |
StashFactory |
Static factor used for creating Stash instances
|
![]() |
StashOverflowException |
Is thrown when the size of the Stash exceeds the capacity of the stash
|
![]() |
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.
|
![]() |
Status..::..Failure |
Indicates the failure of some operation that was requested and includes an
Exception describing the underlying cause of the problem.
|
![]() |
Status..::..Success |
Indicates the success of some operation which has been performed
|
![]() |
SupervisorStrategy |
Base class for supervision strategies
|
![]() |
SystemGuardianActor | |
![]() |
Terminated | |
![]() |
TerminatedProps | |
![]() |
TypedActor |
Class TypedActor.
|
![]() |
UnstartedCell | |
![]() |
UntypedActor |
Class UntypedActor.
|
![]() |
UntypedActorWithBoundedStash |
An UntypedActor with bounded Stash capabilites
|
![]() |
UntypedActorWithUnboundedStash |
An UntypedActor with Unbounded Stash capabilites
|
![]() |
VirtualPathContainer |
Structures
Structure | Description | |
---|---|---|
![]() |
Envelope |
Envelope class, represents a message and the sender of the message.
|
Interfaces
Interface | Description | |
---|---|---|
![]() |
ActorRefProvider | |
![]() |
AutoReceivedMessage | |
![]() |
Cell |
INTERNAL
|
![]() |
IActorContext | |
![]() |
IActorLogging |
Interface used on Actors that have an explicit requirement for a logger
|
![]() |
IActorRefFactory |
Interface IActorRefFactory
|
![]() |
IActorStash |
Marker interface for adding stash support
|
![]() |
ICanTell | |
![]() |
IExtension |
Marker interface used to identify an object as ActorSystem extension
|
![]() |
IExtensionId |
Non-generic version of interface, mostly to avoid issues with generic casting
|
![]() |
IExtensionId<(Of <(<'T>)>)> |
Marker interface used to distinguish a unqiue ActorSystem extensions
|
![]() |
IHandle<(Of <(<'TMessage>)>)> |
Interface IHandle
|
![]() |
IInternalActor |
Contains things needed by the framework
|
![]() |
ILogReceive |
Interface ILogReceive
|
![]() |
IStash |
Public interface used to expose stash capabilites to user-level actors
|
![]() |
IUntypedActorContext |
Interface IUntypedActorContext
|
![]() |
NoSerializationVerificationNeeded |
Marker Interface NoSerializationVerificationNeeded, this interface prevents
implementing message types from being serialized if configuration setting 'akka.actor.serialize-messages' is "on"
|
![]() |
PossiblyHarmful |
Marker interface to indicate that a message might be potentially harmful;
this is used to block messages coming in over remoting.
|
![]() |
WithBoundedStash |
Lets the StashFactory know that this Actor needs stash support
with restricted storage capacity
|
![]() |
WithUnboundedStash |
Lets the StashFactory know that this Actor needs stash support
with unrestricted storage capacity
|
Delegates
Delegate | Description | |
---|---|---|
![]() |
FSM<(Of <(<'TS, TD>)>)>..::..StateFunction | |
![]() |
FSM<(Of <(<'TS, TD>)>)>..::..TransitionHandler | |
![]() |
Receive |
Delegate Receive
|
![]() |
UntypedReceive |
Delegate UntypedReceive
|