ReplicatedEntity.ActorContext

All Known Subinterfaces:

CommandContextImpl, ReplicatedActorContextImpl, ReplicatedEntity.CommandContext

All Known Implementing Classes:

SimulatedContext

Enclosing class:

ReplicatedEntity<Command,Event,State>
```
public static interface ReplicatedEntity.ActorContext
```
Actor context for ReplicatedEntity with somewhat limited capabilities and additional functionality specifically replicated entities.
Not for user extension.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`akka.actor.ActorRef`	`actorOf(akka.actor.Props props)` Create new actor as child of this actor and give it an automatically generated name (currently similar to base64-encoded integer count, reversed and with “$” prepended, may change in the future).
`akka.actor.ActorRef`	`actorOf(akka.actor.Props props, java.lang.String name)` Create new actor as child of this actor with the given name, which must not be null, empty or start with “$”.
`akka.actor.ActorSelection`	`actorSelection(akka.actor.ActorPath path)` Construct an `ActorSelection` from the given path, which is parsed for wildcards (these are replaced by regular expressions internally).
`akka.actor.ActorSelection`	`actorSelection(java.lang.String path)` Construct an `ActorSelection` from the given path, which is parsed for wildcards (these are replaced by regular expressions internally).
`scala.Option<akka.actor.ActorRef>`	`child(java.lang.String name)` Get the child with the given name if it exists.
`scala.collection.immutable.Iterable<akka.actor.ActorRef>`	`children()` Returns all supervised children; this method returns a view (i.e.
`scala.concurrent.ExecutionContextExecutor`	`dispatcher()` Returns the dispatcher (MessageDispatcher) that is used for this Actor.
`akka.actor.ActorRef`	`parent()` Returns the supervising parent `ActorRef`.
`scala.concurrent.duration.Duration`	`receiveTimeout()` Gets the current receive timeout.
`akka.actor.ActorRef`	`self()` Commands can be sent with the `ReplicatedEntity` itself with this `ActorRef`, or it can be passed in reply messages.
`akka.actor.ActorRef`	`sender()` Replies can be sent with this `sender()` `ActorRef` an `ActorRef` that is passed in the command.
`void`	`setReceiveTimeout(scala.concurrent.duration.Duration timeout)` Defines the inactivity timeout after which the sending of a `akka.actor.ReceiveTimeout` message is triggered.
`void`	`stop(akka.actor.ActorRef actor)` Stop the actor pointed to by the given `ActorRef`; this is an asynchronous operation, i.e.
`akka.actor.ActorSystem`	`system()` The system that the actor belongs to.
`akka.actor.TimerScheduler`	`timers()` Start and cancel timers via the enclosed `TimerScheduler`.
`akka.actor.ActorRef`	`unwatch(akka.actor.ActorRef subject)` Unregisters this actor as Monitor for the provided ActorRef.
`akka.actor.ActorRef`	`watch(akka.actor.ActorRef subject)` Registers this actor as a Monitor for the provided ActorRef.

- Method Detail
  - actorOf
```
akka.actor.ActorRef actorOf(akka.actor.Props props)
```
    Create new actor as child of this actor and give it an automatically generated name (currently similar to base64-encoded integer count, reversed and with “$” prepended, may change in the future).
    See Props for details on how to obtain a Props object.
    
    Parameters:
    
    props - (undocumented)
    
    Returns:
    
    (undocumented)
  - actorOf
```
akka.actor.ActorRef actorOf(akka.actor.Props props,
                            java.lang.String name)
```
    Create new actor as child of this actor with the given name, which must not be null, empty or start with “$”. If the given name is already in use, an InvalidActorNameException is thrown.
    See Props for details on how to obtain a Props object.
    
    Parameters:
    
    props - (undocumented)
    
    name - (undocumented)
    
    Returns:
    
    (undocumented)
  - actorSelection
```
akka.actor.ActorSelection actorSelection(java.lang.String path)
```
    Construct an ActorSelection from the given path, which is parsed for wildcards (these are replaced by regular expressions internally). No attempt is made to verify the existence of any part of the supplied path, it is recommended to send a message and gather the replies in order to resolve the matching set of actors.
    
    Parameters:
    
    path - (undocumented)
    
    Returns:
    
    (undocumented)
  - actorSelection
```
akka.actor.ActorSelection actorSelection(akka.actor.ActorPath path)
```
    Construct an ActorSelection from the given path, which is parsed for wildcards (these are replaced by regular expressions internally). No attempt is made to verify the existence of any part of the supplied path, it is recommended to send a message and gather the replies in order to resolve the matching set of actors.
    
    Parameters:
    
    path - (undocumented)
    
    Returns:
    
    (undocumented)
  - child
```
scala.Option<akka.actor.ActorRef> child(java.lang.String name)
```
    Get the child with the given name if it exists.
    
    Parameters:
    
    name - (undocumented)
    
    Returns:
    
    (undocumented)
  - children
```
scala.collection.immutable.Iterable<akka.actor.ActorRef> children()
```
    Returns all supervised children; this method returns a view (i.e. a lazy collection) onto the internal collection of children. Targeted lookups should be using ActorContext.child instead for performance reasons:
```
 // DON'T DO THIS:
 val badLookup = context.children find (_.path.name == "kid")

 // should better be expressed as:
 val goodLookup = context.child("kid")
 
```
    Returns:
    
    (undocumented)
  - dispatcher
```
scala.concurrent.ExecutionContextExecutor dispatcher()
```
    Returns the dispatcher (MessageDispatcher) that is used for this Actor. Importing this member will place an implicit ExecutionContext in scope.
    
    Returns:
    
    (undocumented)
  - parent
```
akka.actor.ActorRef parent()
```
    Returns the supervising parent ActorRef.
    When used with Cluster Sharding, this will be this entity's parent ShardRegion.
    
    Returns:
    
    (undocumented)
  - receiveTimeout
```
scala.concurrent.duration.Duration receiveTimeout()
```
    Gets the current receive timeout. When specified, the receive method should be able to handle a akka.actor.ReceiveTimeout message.
    
    Returns:
    
    (undocumented)
  - self
```
akka.actor.ActorRef self()
```
    Commands can be sent with the ReplicatedEntity itself with this ActorRef, or it can be passed in reply messages.
    WARNING: It is not possible to use self from the constructor of the ReplicatedEntity.
    
    Returns:
    
    (undocumented)
  - sender
```
akka.actor.ActorRef sender()
```
    Replies can be sent with this sender() ActorRef an ActorRef that is passed in the command.
    WARNING: It is not safe to use the sender() method directly in different thread (e.g. from a Future). If you need to refer to the original sender in a Future, store the reference before the Future, like so val replyTo = ctx.sender(); Future { replyTo ! "ok" } which is safe.
    It IS safe to refer to the sender in the andThen effect callbacks however.
    
    Returns:
    
    (undocumented)
  - setReceiveTimeout
```
void setReceiveTimeout(scala.concurrent.duration.Duration timeout)
```
    Defines the inactivity timeout after which the sending of a akka.actor.ReceiveTimeout message is triggered. Message handlers for timeout messages can be registered with ReplicatedEntity.CommandHandler.onReceiveTimeout(scala.Function2<akka.persistence.multidc.scaladsl.ReplicatedEntity.CommandContext, State, akka.persistence.multidc.scaladsl.Effect<Event, State>>). 1 millisecond is the minimum supported timeout.
    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 Duration.Undefined to switch off this feature.
    Messages marked with NotInfluenceReceiveTimeout will not reset the timer. This can be useful when ReceiveTimeout should be fired by external inactivity but not influenced by internal activity, e.g. scheduled tick messages.
    
    Parameters:
    
    timeout - (undocumented)
  - stop
```
void stop(akka.actor.ActorRef actor)
```
    Stop the actor pointed to by the given ActorRef; this is an asynchronous operation, i.e. involves a message send. If this method is applied to the self reference from inside an Actor then that Actor is guaranteed to not process any further messages after this call; please note that the processing of the current message will continue, this method does not immediately terminate this actor.
    
    Parameters:
    
    actor - (undocumented)
  - system
```
akka.actor.ActorSystem system()
```
    The system that the actor belongs to. Importing this member will place an implicit ActorSystem in scope.
    
    Returns:
    
    (undocumented)
  - timers
```
akka.actor.TimerScheduler timers()
```
    Start and cancel timers via the enclosed TimerScheduler. Message handlers for timer messages can be registered with ReplicatedEntity.CommandHandler.onTimer(scala.Function3<akka.persistence.multidc.scaladsl.ReplicatedEntity.CommandContext, State, M, akka.persistence.multidc.scaladsl.Effect<Event, State>>, scala.reflect.ClassTag<M>).
    
    Returns:
    
    (undocumented)
  - unwatch
```
akka.actor.ActorRef unwatch(akka.actor.ActorRef subject)
```
    Unregisters this actor as Monitor for the provided ActorRef.
    
    Parameters:
    
    subject - (undocumented)
    
    Returns:
    
    the provided ActorRef
  - watch
```
akka.actor.ActorRef watch(akka.actor.ActorRef subject)
```
    Registers this actor as a Monitor for the provided ActorRef. This actor will receive a Terminated(subject) message when watched actor is terminated. Register handler for the Terminated message with ReplicatedEntity.CommandHandler.onTerminated(scala.Function3<akka.persistence.multidc.scaladsl.ReplicatedEntity.CommandContext, State, akka.actor.Terminated, akka.persistence.multidc.scaladsl.Effect<Event, State>>)
    
    Parameters:
    
    subject - (undocumented)
    
    Returns:
    
    the provided ActorRef

Interface ReplicatedEntity.ActorContext

Method Summary

Method Detail

actorOf

actorOf

actorSelection

actorSelection

child

children

dispatcher

parent

receiveTimeout

self

sender

setReceiveTimeout

stop

system

timers

unwatch

watch