akka.typed.adapter

Class ActorContextAdapter<T>

java.lang.Object

akka.typed.adapter.ActorContextAdapter<T>

All Implemented Interfaces:

ActorContext<T>

public class ActorContextAdapter<T>
extends java.lang.Object
implements ActorContext<T>

INTERNAL API. Wrapping an ActorContext as an ActorContext.

Constructor Summary

Constructors

Constructor and Description
ActorContextAdapter(ActorContext ctx)

Method Summary

Modifier and Type	Method and Description
void	cancelReceiveTimeout() Cancel the sending of receive timeout notifications.
scala.Option<ActorRef<java.lang.Object>>	child(java.lang.String name) The named child Actor if it is alive.
scala.collection.Iterable<ActorRef<scala.runtime.Nothing$>>	children() The list of child Actors created by this Actor during its lifetime that are still alive, in no particular order.
scala.concurrent.ExecutionContextExecutor	executionContext() This Actor&rsquo;s execution context.
int	mailboxCapacity() Return the mailbox capacity that was configured by the parent for this actor.
T	receiveTimeoutMsg()
<U> Cancellable	schedule(scala.concurrent.duration.FiniteDuration delay, ActorRef<U> target, U msg) Schedule the sending of the given message to the given target Actor after the given time period has elapsed.
ActorRef<T>	self() The identity of this Actor, bound to the lifecycle of this Actor instance.
void	setReceiveTimeout(scala.concurrent.duration.FiniteDuration d, T msg) Schedule the sending of a notification in case no other message is received during the given period of time.
<U> ActorRef<U>	spawn(Behavior<U> behavior, java.lang.String name, DeploymentConfig deployment) Create a child Actor from the given Props and with the given name.
<U> ActorRef<U>	spawnAdapter(scala.Function1<U,T> f) Create a child actor that will wrap messages such that other Actor&rsquo;s protocols can be ingested by this Actor.
<U> ActorRef<U>	spawnAnonymous(Behavior<U> behavior, DeploymentConfig deployment) Create a child Actor from the given Props under a randomly chosen name.
boolean	stop(ActorRef<scala.runtime.Nothing$> child) Force the child Actor under the given name to terminate after it finishes processing its current message.
ActorSystem<scala.runtime.Nothing$>	system() The ActorSystem to which this Actor belongs.
<U> ActorRef<U>	unwatch(ActorRef<U> other) Revoke the registration established by watch.
<U> ActorRef<U>	watch(ActorRef<U> other) Register for Terminated notification once the Actor identified by the given ActorRef terminates.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActorContextAdapter

public ActorContextAdapter(ActorContext ctx)

Method Detail

self

public ActorRef<T> self()

Description copied from interface: ActorContext

The identity of this Actor, bound to the lifecycle of this Actor instance. An Actor with the same name that lives before or after this instance will have a different ActorRef.

Specified by:

self in interface ActorContext<T>

Returns:

(undocumented)

system

public ActorSystem<scala.runtime.Nothing$> system()

Description copied from interface: ActorContext

The ActorSystem to which this Actor belongs.

Specified by:

system in interface ActorContext<T>

Returns:

(undocumented)

mailboxCapacity

public int mailboxCapacity()

Description copied from interface: ActorContext

Return the mailbox capacity that was configured by the parent for this actor.

Specified by:

mailboxCapacity in interface ActorContext<T>

Returns:

(undocumented)

children

public scala.collection.Iterable<ActorRef<scala.runtime.Nothing$>> children()

Description copied from interface: ActorContext

The list of child Actors created by this Actor during its lifetime that are still alive, in no particular order.

Specified by:

children in interface ActorContext<T>

Returns:

(undocumented)

child

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

Description copied from interface: ActorContext

The named child Actor if it is alive.

Specified by:

child in interface ActorContext<T>

Parameters:

name - (undocumented)

Returns:

(undocumented)

spawnAnonymous

public <U> ActorRef<U> spawnAnonymous(Behavior<U> behavior,
                                      DeploymentConfig deployment)

Description copied from interface: ActorContext

Create a child Actor from the given Props under a randomly chosen name. It is good practice to name Actors wherever practical.

Specified by:

spawnAnonymous in interface ActorContext<T>

Parameters:

behavior - (undocumented)

deployment - (undocumented)

Returns:

(undocumented)

spawn

public <U> ActorRef<U> spawn(Behavior<U> behavior,
                             java.lang.String name,
                             DeploymentConfig deployment)

Description copied from interface: ActorContext

Create a child Actor from the given Props and with the given name.

Specified by:

spawn in interface ActorContext<T>

Parameters:

behavior - (undocumented)

name - (undocumented)

deployment - (undocumented)

Returns:

(undocumented)

stop

public boolean stop(ActorRef<scala.runtime.Nothing$> child)

Description copied from interface: ActorContext

Force the child Actor under the given name to terminate after it finishes processing its current message. Nothing happens if the ActorRef does not refer to a current child actor.

Specified by:

stop in interface ActorContext<T>

Parameters:

child - (undocumented)

Returns:

whether the passed-in ActorRef points to a current child Actor

watch

public <U> ActorRef<U> watch(ActorRef<U> other)

Description copied from interface: ActorContext

Register for Terminated notification once the Actor identified by the given ActorRef terminates. This notification is also generated when the ActorSystem to which the referenced Actor belongs is declared as failed (e.g. in reaction to being unreachable).

Specified by:

watch in interface ActorContext<T>

Parameters:

other - (undocumented)

Returns:

(undocumented)

unwatch

public <U> ActorRef<U> unwatch(ActorRef<U> other)

Description copied from interface: ActorContext

Revoke the registration established by watch. A Terminated notification will not subsequently be received for the referenced Actor.

Specified by:

unwatch in interface ActorContext<T>

Parameters:

other - (undocumented)

Returns:

(undocumented)

receiveTimeoutMsg

public T receiveTimeoutMsg()

setReceiveTimeout

public void setReceiveTimeout(scala.concurrent.duration.FiniteDuration d,
                              T msg)

Description copied from interface: ActorContext

Schedule the sending of a notification in case no other message is received during the given period of time. The timeout starts anew with each received message. Provide Duration.Undefined to switch off this mechanism.

Specified by:

setReceiveTimeout in interface ActorContext<T>

Parameters:

d - (undocumented)

msg - (undocumented)

cancelReceiveTimeout

public void cancelReceiveTimeout()

Description copied from interface: ActorContext

Cancel the sending of receive timeout notifications.

Specified by:

cancelReceiveTimeout in interface ActorContext<T>

executionContext

public scala.concurrent.ExecutionContextExecutor executionContext()

Description copied from interface: ActorContext

This Actor&rsquo;s execution context. It can be used to run asynchronous tasks like Future combinators.

Specified by:

executionContext in interface ActorContext<T>

Returns:

(undocumented)

schedule

public <U> Cancellable schedule(scala.concurrent.duration.FiniteDuration delay,
                                ActorRef<U> target,
                                U msg)

Description copied from interface: ActorContext

Schedule the sending of the given message to the given target Actor after the given time period has elapsed. The scheduled action can be cancelled by invoking Cancellable cancel on the returned handle.

Specified by:

schedule in interface ActorContext<T>

Parameters:

delay - (undocumented)

target - (undocumented)

msg - (undocumented)

Returns:

(undocumented)

spawnAdapter

public <U> ActorRef<U> spawnAdapter(scala.Function1<U,T> f)

Description copied from interface: ActorContext

Create a child actor that will wrap messages such that other Actor&rsquo;s protocols can be ingested by this Actor. You are strongly advised to cache these ActorRefs or to stop them when no longer needed.

Specified by:

spawnAdapter in interface ActorContext<T>

Parameters:

f - (undocumented)

Returns:

(undocumented)