Interface Actor

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  Actor.emptyBehavior$
      emptyBehavior is a Receive-expression that matches no messages at all, ever.
      static class  Actor.ignoringBehavior$
      ignoringBehavior is a Receive-expression that consumes and ignores all messages.
    • Method Detail

      • org$apache$pekko$actor$Actor$_setter_$context_$eq

        void org$apache$pekko$actor$Actor$_setter_$context_$eq​(ActorContext x$1)
        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.

      • org$apache$pekko$actor$Actor$_setter_$self_$eq

        void org$apache$pekko$actor$Actor$_setter_$self_$eq​(ActorRef x$1)
        The 'self' field holds the ActorRef for this actor.

        Can be used to send messages to itself:
         self ! message
         
      • context

        ActorContext context()
        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.

      • self

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

        Can be used to send messages to itself:
         self ! message
         
      • sender

        ActorRef sender()
        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!

      • receive

        scala.PartialFunction<java.lang.Object,​scala.runtime.BoxedUnit> receive()
        Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.
      • aroundReceive

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

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

        Parameters:
        receive - current behavior.
        msg - current message.
      • aroundPreStart

        void aroundPreStart()
        INTERNAL API.

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

      • aroundPostStop

        void aroundPostStop()
        INTERNAL API.

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

      • aroundPreRestart

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

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

      • aroundPostRestart

        void aroundPostRestart​(java.lang.Throwable reason)
        INTERNAL API.

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

      • supervisorStrategy

        SupervisorStrategy supervisorStrategy()
        User overridable definition the strategy to use for supervising child actors.
      • preStart

        void preStart()
               throws java.lang.Exception
        User overridable callback.

        Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.
        Throws:
        java.lang.Exception
      • postStop

        void postStop()
               throws java.lang.Exception
        User overridable callback.

        Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.
        Throws:
        java.lang.Exception
      • preRestart

        void preRestart​(java.lang.Throwable reason,
                        scala.Option<java.lang.Object> message)
                 throws java.lang.Exception
        Scala API: User overridable callback: '''By default it disposes of all children and then calls postStop().'''
        Parameters:
        reason - the Throwable that caused the restart to happen
        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.
        Throws:
        java.lang.Exception
      • postRestart

        void postRestart​(java.lang.Throwable reason)
                  throws java.lang.Exception
        User overridable callback: By default it calls preStart().
        Parameters:
        reason - the Throwable that caused the restart to happen

        Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.
        Throws:
        java.lang.Exception
      • unhandled

        void unhandled​(java.lang.Object message)
        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 an pekko.actor.UnhandledMessage to the actor's system's pekko.event.EventStream