AbstractActorWithTimers

org.apache.pekko.actor.AbstractActorWithTimers
abstract class AbstractActorWithTimers extends AbstractActor, Timers

Java API: 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.

Attributes

Source
Timers.scala
Graph
Supertypes
trait Timers
trait Actor
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited types

type Receive = Receive

Attributes

Inherited from:
Actor
Source
Actor.scala

Value members

Concrete methods

Start and cancel timers via the enclosed TimerScheduler.

Start and cancel timers via the enclosed TimerScheduler.

Attributes

Source
Timers.scala

Inherited methods

Returns this AbstractActor's ActorContext The ActorContext is not thread safe so do not expose it outside of the AbstractActor.

Returns this AbstractActor's ActorContext The ActorContext is not thread safe so do not expose it outside of the AbstractActor.

Attributes

Inherited from:
AbstractActor
Source
AbstractActor.scala
def getSelf(): ActorRef

Returns the ActorRef for this actor.

Returns the ActorRef for this actor.

Same as self().

Attributes

Inherited from:
AbstractActor
Source
AbstractActor.scala

The reference sender Actor of the currently processed message. This is always a legal destination to send to, even if there is no logical recipient for the reply, in which case it will be sent to the dead letter mailbox.

The reference sender Actor of the currently processed message. This is always a legal destination to send to, even if there is no logical recipient for the reply, in which case it will be sent to the dead letter mailbox.

Same as sender().

WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

Attributes

Inherited from:
AbstractActor
Source
AbstractActor.scala
override def postRestart(reason: Throwable): Unit

User overridable callback: By default it calls preStart().

User overridable callback: By default it calls preStart().

Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.

Attributes

Definition Classes
Inherited from:
AbstractActor
Source
AbstractActor.scala
override def postStop(): Unit

User overridable callback.

User overridable callback.

Is called asynchronously after getContext().stop() is invoked. Empty default implementation.

Attributes

Definition Classes
Inherited from:
AbstractActor
Source
AbstractActor.scala
final override def preRestart(reason: Throwable, message: Option[Any]): Unit

Scala API: User overridable callback: '''By default it disposes of all children and then calls postStop().'''

Scala API: User overridable callback: '''By default it disposes of all children and then calls postStop().'''

Value parameters

message

optionally the current message the actor processed when failing, if applicable Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.

reason

the Throwable that caused the restart to happen

Attributes

Definition Classes
Inherited from:
AbstractActor
Source
AbstractActor.scala
def preRestart(reason: Throwable, message: Optional[Any]): Unit

User overridable callback: '''By default it disposes of all children and then calls postStop().'''

User overridable callback: '''By default it disposes of all children and then calls postStop().'''

Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.

Attributes

Inherited from:
AbstractActor
Source
AbstractActor.scala
override def preStart(): Unit

User overridable callback.

User overridable callback.

Is called when an Actor is started. Actor are automatically started asynchronously when created. Empty default implementation.

Attributes

Definition Classes
Inherited from:
AbstractActor
Source
AbstractActor.scala
override def receive: PartialFunction[Any, Unit]

Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.

Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.

Attributes

Definition Classes
Inherited from:
AbstractActor
Source
AbstractActor.scala
final def receiveBuilder(): ReceiveBuilder

Convenience factory of the ReceiveBuilder. Creates a new empty ReceiveBuilder.

Convenience factory of the ReceiveBuilder. Creates a new empty ReceiveBuilder.

Attributes

Inherited from:
AbstractActor
Source
AbstractActor.scala
final def sender(): ActorRef

The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in pekko.actor.ActorSystem.

The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in pekko.actor.ActorSystem.

WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

Attributes

Inherited from:
Actor
Source
Actor.scala

User overridable definition the strategy to use for supervising child actors.

User overridable definition the strategy to use for supervising child actors.

Attributes

Definition Classes
Inherited from:
AbstractActor
Source
AbstractActor.scala
final def timers: TimerScheduler

Start and cancel timers via the enclosed TimerScheduler.

Start and cancel timers via the enclosed TimerScheduler.

Attributes

Inherited from:
Timers
Source
Timers.scala
def unhandled(message: Any): Unit

User overridable callback.

User overridable callback.

Is called when a message isn't handled by the current behavior of the actor by default it fails with either a pekko.actor.DeathPactException (in case of an unhandled pekko.actor.Terminated message) or publishes a pekko.actor.UnhandledMessage to the actor's system's pekko.event.EventStream

Attributes

Inherited from:
Actor
Source
Actor.scala

Inherited and Abstract methods

An actor has to define its initial receive behavior by implementing the createReceive method.

An actor has to define its initial receive behavior by implementing the createReceive method.

Attributes

Inherited from:
AbstractActor
Source
AbstractActor.scala

Implicits

Inherited implicits

implicit val context: ActorContext

Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

pekko.actor.ActorContext is the Scala API. getContext returns a pekko.actor.AbstractActor.ActorContext, which is the Java API of the actor context.

Attributes

Inherited from:
Actor
Source
Actor.scala
final implicit val self: ActorRef

The 'self' field holds the ActorRef for this actor.

The 'self' field holds the ActorRef for this actor.

Can be used to send messages to itself:

self ! message

Attributes

Inherited from:
Actor
Source
Actor.scala