akka.persistence.multidc.testkit

Class SimulatedContext

java.lang.Object

akka.persistence.multidc.testkit.SimulatedContext

All Implemented Interfaces:

CommandContextImpl, ReplicatedActorContextImpl, ReplicatedEntity.ActorContext, ReplicatedEntity.CommandContext

public class SimulatedContext
extends java.lang.Object
implements CommandContextImpl

INTERNAL API

Constructor Summary

Constructors

Constructor and Description
SimulatedContext(akka.actor.ActorRef self, akka.actor.ActorRef sender, akka.actor.ActorRef parent, akka.actor.TimerScheduler timers, akka.actor.ActorSystem system, scala.Option<java.lang.String> dispatcherId)

Method Summary

Modifier and Type	Method and Description
static scala.Option<java.lang.String>	$lessinit$greater$default$6()
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 &ldquo;$&rdquo; 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 &ldquo;$&rdquo;.
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.
scala.Option<java.lang.String>	dispatcherId()
java.util.Optional<akka.actor.ActorRef>	findChild(java.lang.String name) Get the child with the given name if it exists.
java.lang.Iterable<akka.actor.ActorRef>	getChildren() Returns all supervised children; this method returns a view (i.e.
scala.concurrent.ExecutionContextExecutor	getDispatcher() Returns the dispatcher (MessageDispatcher) that is used for this Actor.
akka.actor.ActorRef	getParent() Returns the supervising parent ActorRef.
scala.concurrent.duration.Duration	getReceiveTimeout() Gets the current receive timeout.
akka.actor.ActorRef	getSelf() Commands can be sent with the ReplicatedEntity itself with this ActorRef, or it can be passed in reply messages.
akka.actor.ActorRef	getSender() Replies can be sent with this sender() ActorRef an ActorRef that is passed in the command.
akka.actor.ActorSystem	getSystem() The system that the actor belongs to.
akka.actor.TimerScheduler	getTimers() Start and cancel timers via the enclosed TimerScheduler.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimulatedContext

public SimulatedContext(akka.actor.ActorRef self,
                        akka.actor.ActorRef sender,
                        akka.actor.ActorRef parent,
                        akka.actor.TimerScheduler timers,
                        akka.actor.ActorSystem system,
                        scala.Option<java.lang.String> dispatcherId)

Method Detail

$lessinit$greater$default$6

public static scala.Option<java.lang.String> $lessinit$greater$default$6()

self

public akka.actor.ActorRef self()

Description copied from interface: ReplicatedEntity.ActorContext

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

public akka.actor.ActorRef sender()

Description copied from interface: ReplicatedEntity.ActorContext

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)

parent

public akka.actor.ActorRef parent()

Description copied from interface: ReplicatedEntity.ActorContext

Returns the supervising parent ActorRef.

When used with Cluster Sharding, this will be this entity's parent ShardRegion.

Returns:

(undocumented)

timers

public akka.actor.TimerScheduler timers()

Description copied from interface: ReplicatedEntity.ActorContext

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)

system

public akka.actor.ActorSystem system()

Description copied from interface: ReplicatedEntity.ActorContext

The system that the actor belongs to. Importing this member will place an implicit ActorSystem in scope.

Returns:

(undocumented)

dispatcherId

public scala.Option<java.lang.String> dispatcherId()

receiveTimeout

public scala.concurrent.duration.Duration receiveTimeout()

Description copied from interface: ReplicatedEntity.ActorContext

Gets the current receive timeout. When specified, the receive method should be able to handle a akka.actor.ReceiveTimeout message.

Returns:

(undocumented)

setReceiveTimeout

public void setReceiveTimeout(scala.concurrent.duration.Duration timeout)

Description copied from interface: ReplicatedEntity.ActorContext

Defines the inactivity timeout after which the sending of a akka.actor.ReceiveTimeout message is triggered. Message handlers for timer messages can be registered with SignalHandlerBuilder.onReceiveTimeout(akka.persistence.multidc.javadsl.SignalHandler<akka.actor.ReceiveTimeout, 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.

Specified by:

setReceiveTimeout in interface ReplicatedEntity.ActorContext

Parameters:

timeout - (undocumented)

children

public scala.collection.immutable.Iterable<akka.actor.ActorRef> children()

Description copied from interface: ReplicatedEntity.ActorContext

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)

child

public scala.Option<akka.actor.ActorRef> child(java.lang.String name)

Description copied from interface: ReplicatedEntity.ActorContext

Get the child with the given name if it exists.

Parameters:

name - (undocumented)

Returns:

(undocumented)

dispatcher

public scala.concurrent.ExecutionContextExecutor dispatcher()

Description copied from interface: ReplicatedEntity.ActorContext

Returns the dispatcher (MessageDispatcher) that is used for this Actor. Importing this member will place an implicit ExecutionContext in scope.

Returns:

(undocumented)

watch

public akka.actor.ActorRef watch(akka.actor.ActorRef subject)

Description copied from interface: ReplicatedEntity.ActorContext

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 CommandHandlerBuilder.onTerminated

Specified by:

watch in interface ReplicatedEntity.ActorContext

Parameters:

subject - (undocumented)

Returns:

the provided ActorRef

unwatch

public akka.actor.ActorRef unwatch(akka.actor.ActorRef subject)

Description copied from interface: ReplicatedEntity.ActorContext

Unregisters this actor as Monitor for the provided ActorRef.

Specified by:

unwatch in interface ReplicatedEntity.ActorContext

Parameters:

subject - (undocumented)

Returns:

the provided ActorRef

getSelf

public akka.actor.ActorRef getSelf()

Description copied from interface: ReplicatedEntity.ActorContext

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 getSelf from the constructor of the ReplicatedEntity.

Specified by:

getSelf in interface ReplicatedEntity.ActorContext

Returns:

(undocumented)

getSender

public akka.actor.ActorRef getSender()

Description copied from interface: ReplicatedEntity.ActorContext

Replies can be sent with this sender() ActorRef an ActorRef that is passed in the command.

Specified by:

getSender in interface ReplicatedEntity.ActorContext

Returns:

(undocumented)

getReceiveTimeout

public scala.concurrent.duration.Duration getReceiveTimeout()

Description copied from interface: ReplicatedEntity.ActorContext

Gets the current receive timeout. When specified, the receive method should be able to handle a akka.actor.ReceiveTimeout message.

Specified by:

getReceiveTimeout in interface ReplicatedEntity.ActorContext

Returns:

(undocumented)

getTimers

public akka.actor.TimerScheduler getTimers()

Description copied from interface: ReplicatedEntity.ActorContext

Start and cancel timers via the enclosed TimerScheduler. Message handlers for timer messages can be registered with SignalHandlerBuilder.onTimer(java.lang.Class<M>, akka.persistence.multidc.javadsl.SignalHandler<M, Event, State>).

Specified by:

getTimers in interface ReplicatedEntity.ActorContext

Returns:

(undocumented)

getChildren

public java.lang.Iterable<akka.actor.ActorRef> getChildren()

Description copied from interface: ReplicatedEntity.ActorContext

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 child instead for performance reasons:

 val badLookup = context.children find (_.path.name == "kid")
 // should better be expressed as:
 val goodLookup = context.child("kid")
 

Specified by:

getChildren in interface ReplicatedEntity.ActorContext

Returns:

(undocumented)

findChild

public java.util.Optional<akka.actor.ActorRef> findChild(java.lang.String name)

Description copied from interface: ReplicatedEntity.ActorContext

Get the child with the given name if it exists.

Specified by:

findChild in interface ReplicatedEntity.ActorContext

Parameters:

name - (undocumented)

Returns:

(undocumented)

getDispatcher

public scala.concurrent.ExecutionContextExecutor getDispatcher()

Description copied from interface: ReplicatedEntity.ActorContext

Returns the dispatcher (MessageDispatcher) that is used for this Actor. Importing this member will place an implicit ExecutionContext in scope.

Specified by:

getDispatcher in interface ReplicatedEntity.ActorContext

Returns:

(undocumented)

getSystem

public akka.actor.ActorSystem getSystem()

Description copied from interface: ReplicatedEntity.ActorContext

The system that the actor belongs to. Importing this member will place an implicit ActorSystem in scope.

Specified by:

getSystem in interface ReplicatedEntity.ActorContext

Returns:

(undocumented)

getParent

public akka.actor.ActorRef getParent()

Description copied from interface: ReplicatedEntity.ActorContext

Returns the supervising parent ActorRef.

Specified by:

getParent in interface ReplicatedEntity.ActorContext

Returns:

(undocumented)

actorOf

public akka.actor.ActorRef actorOf(akka.actor.Props props)

Description copied from interface: ReplicatedEntity.ActorContext

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.

Specified by:

actorOf in interface ReplicatedEntity.ActorContext

Parameters:

props - (undocumented)

Returns:

(undocumented)

actorOf

public akka.actor.ActorRef actorOf(akka.actor.Props props,
                                   java.lang.String name)

Description copied from interface: ReplicatedEntity.ActorContext

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.

Specified by:

actorOf in interface ReplicatedEntity.ActorContext

Parameters:

props - (undocumented)

name - (undocumented)

Returns:

(undocumented)

actorSelection

public akka.actor.ActorSelection actorSelection(java.lang.String path)

Description copied from interface: ReplicatedEntity.ActorContext

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.

Specified by:

actorSelection in interface ReplicatedEntity.ActorContext

Parameters:

path - (undocumented)

Returns:

(undocumented)

actorSelection

public akka.actor.ActorSelection actorSelection(akka.actor.ActorPath path)

Description copied from interface: ReplicatedEntity.ActorContext

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.

Specified by:

actorSelection in interface ReplicatedEntity.ActorContext

Parameters:

path - (undocumented)

Returns:

(undocumented)

stop

public void stop(akka.actor.ActorRef actor)

Description copied from interface: ReplicatedEntity.ActorContext

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.

Specified by:

stop in interface ReplicatedEntity.ActorContext

Parameters:

actor - (undocumented)