Package org.apache.pekko.actor

Interface Timers

All Superinterfaces:

Actor

All Known Implementing Classes:

AbstractActorWithTimers, AbstractPersistentActorWithTimers, PersistentShardCoordinator, ShardCoordinator

public interface Timers
extends Actor

Scala API: Mix in Timers into your Actor to get support for scheduled self messages via TimerScheduler.

Timers are bound to the lifecycle of the actor that owns it, and thus are cancelled automatically when it is restarted or stopped.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pekko.actor.Actor

Actor.emptyBehavior$, Actor.ignoringBehavior$

Method Summary

Modifier and Type	Method	Description
org.apache.pekko.actor.ActorCell	actorCell()
void	aroundPostStop()	INTERNAL API.
void	aroundPreRestart(java.lang.Throwable reason, scala.Option<java.lang.Object> message)	INTERNAL API.
void	aroundReceive(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive, java.lang.Object msg)	INTERNAL API.
void	super$aroundPostStop()
void	super$aroundPreRestart(java.lang.Throwable reason, scala.Option<java.lang.Object> message)	Start and cancel timers via the enclosed TimerScheduler.
void	super$aroundReceive(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive, java.lang.Object msg)
TimerScheduler	timers()	Start and cancel timers via the enclosed TimerScheduler.

Methods inherited from interface org.apache.pekko.actor.Actor

aroundPostRestart, aroundPreStart, context, org$apache$pekko$actor$Actor$_setter_$context_$eq, org$apache$pekko$actor$Actor$_setter_$self_$eq, postRestart, postStop, preRestart, preStart, receive, self, sender, supervisorStrategy, unhandled

Method Detail

actorCell

org.apache.pekko.actor.ActorCell actorCell()

aroundPostStop

void aroundPostStop()

Description copied from interface: Actor

INTERNAL API.

Can be overridden to intercept calls to postStop. Calls postStop by default.

Specified by:

aroundPostStop in interface Actor

aroundPreRestart

void aroundPreRestart(java.lang.Throwable reason,
                      scala.Option<java.lang.Object> message)

Description copied from interface: Actor

INTERNAL API.

Can be overridden to intercept calls to preRestart. Calls preRestart by default.

Specified by:

aroundPreRestart in interface Actor

aroundReceive

void aroundReceive(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive,
                   java.lang.Object msg)

Description copied from interface: Actor

INTERNAL API.

Can be overridden to intercept calls to this actor's current behavior.

Specified by:

aroundReceive in interface Actor

Parameters:

receive - current behavior.

msg - current message.

super$aroundPostStop

void super$aroundPostStop()

super$aroundPreRestart

void super$aroundPreRestart(java.lang.Throwable reason,
                            scala.Option<java.lang.Object> message)

Start and cancel timers via the enclosed TimerScheduler.

super$aroundReceive

void super$aroundReceive(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive,
                         java.lang.Object msg)

timers

TimerScheduler timers()

Start and cancel timers via the enclosed TimerScheduler.