Interface IActorContext

TBD

Inherited Members
Namespace: Akka.Actor
Assembly: Akka.dll
Syntax
public interface IActorContext : IActorRefFactory, ICanWatch

Properties

| Improve this Doc View Source

Dispatcher

The dispatcher this actor is running on

Declaration
MessageDispatcher Dispatcher { get; }
Property Value
Type Description
MessageDispatcher
| Improve this Doc View Source

Parent

Gets the IActorRef of the parent of the current actor.

Declaration
IActorRef Parent { get; }
Property Value
Type Description
IActorRef
| Improve this Doc View Source

Props

The Props used to originally create this IActorRef

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

ReceiveTimeout

Gets the inactivity deadline timeout set using SetReceiveTimeout(Nullable<TimeSpan>).

Declaration
TimeSpan? ReceiveTimeout { get; }
Property Value
Type Description
Nullable<TimeSpan>
| Improve this Doc View Source

Self

Gets the IActorRef belonging to the current actor.

Declaration
IActorRef Self { get; }
Property Value
Type Description
IActorRef
| Improve this Doc View Source

Sender

Gets the IActorRef of the actor who sent the current message.

If the message was not sent by an actor (i.e. some external non-actor code sent this actor a message) then this value will default to NoSender.

Declaration
IActorRef Sender { get; }
Property Value
Type Description
IActorRef
| Improve this Doc View Source

System

Gets a reference to the ActorSystem to which this actor belongs.

This property is how you can get access to the IScheduler and other parts of Akka.NET from within an actor instance.
Declaration
ActorSystem System { get; }
Property Value
Type Description
ActorSystem

Methods

| Improve this Doc View Source

Become(Receive)

Changes the actor's behavior and replaces the current receive handler with the specified handler.

Declaration
void Become(Receive receive)
Parameters
Type Name Description
Receive receive

The new message handler.
| Improve this Doc View Source

BecomeStacked(Receive)

Changes the actor's behavior and replaces the current receive handler with the specified handler. The current handler is stored on a stack, and you can revert to it by calling UnbecomeStacked() Please note, that in order to not leak memory, make sure every call to BecomeStacked(Receive) is matched with a call to UnbecomeStacked().

Declaration
void BecomeStacked(Receive receive)
Parameters
Type Name Description
Receive receive

The new message handler.
| Improve this Doc View Source

Child(String)

Retrieves a child actor with the specified name, if it exists.

If the child with the given name cannot be found, then Nobody will be returned instead.

Declaration
IActorRef Child(string name)
Parameters
Type Name Description
String name

The name of the child actor.

e.g. "child1", "foo"

Not the path, just the name of the child at the time it was created by this parent.
Returns
Type Description
IActorRef

The IActorRef belonging to the child if found, Nobody otherwise.
| Improve this Doc View Source

GetChildren()

Gets all of the children that belong to this actor.

If this actor has no children, an empty collection of IActorRef is returned instead.

Declaration
IEnumerable<IActorRef> GetChildren()
Returns
Type Description
IEnumerable<IActorRef>

TBD
| Improve this Doc View Source

SetReceiveTimeout(Nullable<TimeSpan>)

Defines the inactivity timeout after which the sending of a ReceiveTimeout message is triggered. When specified, the receive function should be able to handle a ReceiveTimeout message.

Please note that the receive timeout might fire and enqueue the ReceiveTimeout message right after another message was enqueued; hence it is not guaranteed that upon reception of the receive timeout there must have been an idle period beforehand as configured via this method.

Once set, the receive timeout stays in effect (i.e. continues firing repeatedly after inactivity periods). Pass in null to switch off this feature.

Declaration
void SetReceiveTimeout(TimeSpan? timeout)
Parameters
Type Name Description
Nullable<TimeSpan> timeout

The timeout. Pass in null to switch off this feature.
| Improve this Doc View Source

Stop(IActorRef)

Issues a stop command to the provided IActorRef, which will cause that actor to terminate.

Declaration
void Stop(IActorRef child)
Parameters
Type Name Description
IActorRef child

The actor who will be stopped.
| Improve this Doc View Source

UnbecomeStacked()

Changes the actor's behavior and replaces the current receive handler with the previous one on the behavior stack. In order to store an actor on the behavior stack, a call to BecomeStacked(Receive) must have been made prior to this call

Declaration
void UnbecomeStacked()

Extension Methods