Package akka.actor

Class AbstractActor

    • Constructor Detail

      • AbstractActor

        public AbstractActor()
    • Method Detail

      • emptyBehavior

        public static final AbstractActor.Receive emptyBehavior()
        emptyBehavior is a Receive-expression that matches no messages at all, ever.
        Returns:
        (undocumented)
      • sender

        public static final ActorRef sender()
      • aroundReceive

        protected static void aroundReceive​(scala.PartialFunction<java.lang.Object,​scala.runtime.BoxedUnit> receive,
                                            java.lang.Object msg)
      • aroundPreStart

        protected static void aroundPreStart()
      • aroundPostStop

        protected static void aroundPostStop()
      • aroundPreRestart

        protected static void aroundPreRestart​(java.lang.Throwable reason,
                                               scala.Option<java.lang.Object> message)
      • aroundPostRestart

        protected static void aroundPostRestart​(java.lang.Throwable reason)
      • unhandled

        public static void unhandled​(java.lang.Object message)
      • context

        public ActorContext context()
        Description copied from interface: Actor
        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!

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

        Specified by:
        context in interface Actor
        Returns:
        (undocumented)
      • self

        public final ActorRef self()
        Description copied from interface: Actor
        The 'self' field holds the ActorRef for this actor.

        Can be used to send messages to itself:
         self ! message
         
        Specified by:
        self in interface Actor
        Returns:
        (undocumented)
      • akka$actor$Actor$_setter_$context_$eq

        protected void akka$actor$Actor$_setter_$context_$eq​(ActorContext x$1)
        Description copied from interface: Actor
        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!

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

        Specified by:
        akka$actor$Actor$_setter_$context_$eq in interface Actor
        Parameters:
        x$1 - (undocumented)
      • akka$actor$Actor$_setter_$self_$eq

        protected final void akka$actor$Actor$_setter_$self_$eq​(ActorRef x$1)
        Description copied from interface: Actor
        The 'self' field holds the ActorRef for this actor.

        Can be used to send messages to itself:
         self ! message
         
        Specified by:
        akka$actor$Actor$_setter_$self_$eq in interface Actor
        Parameters:
        x$1 - (undocumented)
      • getContext

        public AbstractActor.ActorContext getContext()
        Returns this AbstractActor's ActorContext The ActorContext is not thread safe so do not expose it outside of the AbstractActor.
        Returns:
        (undocumented)
      • getSelf

        public ActorRef getSelf()
        Returns the ActorRef for this actor.

        Same as self().

        Returns:
        (undocumented)
      • getSender

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

        Returns:
        (undocumented)
      • supervisorStrategy

        public SupervisorStrategy supervisorStrategy()
        User overridable definition the strategy to use for supervising child actors.
        Specified by:
        supervisorStrategy in interface Actor
        Returns:
        (undocumented)
      • preStart

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

        Is called when an Actor is started. Actor are automatically started asynchronously when created. Empty default implementation.
        Specified by:
        preStart in interface Actor
        Throws:
        java.lang.Exception
      • postStop

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

        Is called asynchronously after getContext().stop() is invoked. Empty default implementation.
        Specified by:
        postStop in interface Actor
        Throws:
        java.lang.Exception
      • preRestart

        public void preRestart​(java.lang.Throwable reason,
                               scala.Option<java.lang.Object> message)
                        throws java.lang.Exception
        Deprecated.
        Override preRestart with message parameter with Optional type instead. Since 2.5.0.
        Description copied from interface: Actor
        Scala API: User overridable callback: '''By default it disposes of all children and then calls postStop().'''
        Specified by:
        preRestart in interface Actor
        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
      • preRestart

        public void preRestart​(java.lang.Throwable reason,
                               java.util.Optional<java.lang.Object> message)
                        throws java.lang.Exception
        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.
        Parameters:
        reason - (undocumented)
        message - (undocumented)
        Throws:
        java.lang.Exception
      • postRestart

        public void postRestart​(java.lang.Throwable reason)
                         throws java.lang.Exception
        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.
        Specified by:
        postRestart in interface Actor
        Parameters:
        reason - (undocumented)
        Throws:
        java.lang.Exception
      • createReceive

        public abstract AbstractActor.Receive createReceive()
        An actor has to define its initial receive behavior by implementing the createReceive method.
        Returns:
        (undocumented)
      • receive

        public scala.PartialFunction<java.lang.Object,​scala.runtime.BoxedUnit> receive()
        Description copied from interface: Actor
        Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.
        Specified by:
        receive in interface Actor
        Returns:
        (undocumented)
      • receiveBuilder

        public final ReceiveBuilder receiveBuilder()
        Convenience factory of the ReceiveBuilder. Creates a new empty ReceiveBuilder.
        Returns:
        (undocumented)