Package akka.actor

Class UnstartedCell

  • All Implemented Interfaces:
    Cell
    public class UnstartedCell
extends java.lang.Object
implements Cell

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ChildrenContainer childrenRefs()
      All children of this actor, including only reserved-names.
      scala.Option<ChildRestartStats> getChildByName​(java.lang.String name)
      Get the stats for the named child, if that exists.
      InternalActorRef getSingleChild​(java.lang.String name)
      Method for looking up a single child beneath this actor.
      boolean hasMessages()
      If the actor isLocal, returns whether "user messages" are currently queued, &ldquo;false&rdquo; otherwise.
      boolean isLocal()
      Returns true if the actor is local, i.e.
      boolean isTerminated()
      Returns &ldquo;true&rdquo; if the actor is locally known to be terminated, &ldquo;false&rdquo; if alive or uncertain.
      int numberOfMessages()
      If the actor isLocal, returns the number of "user messages" currently queued, which may be a costly operation, 0 otherwise.
      InternalActorRef parent()
      The supervisor of this actor.
      Props props()
      The props for this actor cell.
      void replaceWith​(Cell cell)  
      void restart​(java.lang.Throwable cause)
      Restart this actor (will recursively restart or stop all children).
      void resume​(java.lang.Throwable causedByFailure)
      Recursively resume this actor and all its children.
      RepointableActorRef self()
      The &ldquo;self&rdquo; reference which this Cell is attached to.
      void sendMessage​(Envelope msg)
      Enqueue a message to be sent to the actor; may or may not actually schedule the actor to run, depending on which type of cell it is.
      void sendSystemMessage​(SystemMessage msg)
      Enqueue a message to be sent to the actor; may or may not actually schedule the actor to run, depending on which type of cell it is.
      UnstartedCell start()
      Start the cell: enqueued message must not be processed before this has been called.
      void stop()
      Recursively terminate this actor and all its children.
      InternalActorRef supervisor()  
      void suspend()
      Recursively suspend this actor and all its children.
      ActorSystem system()
      The system within which this Cell lives.
      ActorSystemImpl systemImpl()
      The system internals where this Cell lives.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • childrenRefs

        public ChildrenContainer childrenRefs()
        Description copied from interface: Cell
        All children of this actor, including only reserved-names.
        Specified by:
        childrenRefs in interface Cell

      • getChildByName

        public scala.Option<ChildRestartStats> getChildByName​(java.lang.String name)
        Description copied from interface: Cell
        Get the stats for the named child, if that exists.
        Specified by:
        getChildByName in interface Cell

      • getSingleChild

        public InternalActorRef getSingleChild​(java.lang.String name)
        Description copied from interface: Cell
        Method for looking up a single child beneath this actor. It is racy if called from the outside.
        Specified by:
        getSingleChild in interface Cell

      • hasMessages

        public boolean hasMessages()
        Description copied from interface: Cell
        If the actor isLocal, returns whether "user messages" are currently queued, &ldquo;false&rdquo; otherwise.
        Specified by:
        hasMessages in interface Cell

      • isLocal

        public boolean isLocal()
        Description copied from interface: Cell
        Returns true if the actor is local, i.e. if it is actually scheduled on a Thread in the current JVM when run.
        Specified by:
        isLocal in interface Cell

      • isTerminated

        public boolean isTerminated()
        Description copied from interface: Cell
        Returns &ldquo;true&rdquo; if the actor is locally known to be terminated, &ldquo;false&rdquo; if alive or uncertain.
        Specified by:
        isTerminated in interface Cell

      • numberOfMessages

        public int numberOfMessages()
        Description copied from interface: Cell
        If the actor isLocal, returns the number of "user messages" currently queued, which may be a costly operation, 0 otherwise.
        Specified by:
        numberOfMessages in interface Cell

      • parent

        public InternalActorRef parent()
        Description copied from interface: Cell
        The supervisor of this actor.
        Specified by:
        parent in interface Cell

      • props

        public Props props()
        Description copied from interface: Cell
        The props for this actor cell.
        Specified by:
        props in interface Cell

      • replaceWith

        public void replaceWith​(Cell cell)

      • restart

        public void restart​(java.lang.Throwable cause)
        Description copied from interface: Cell
        Restart this actor (will recursively restart or stop all children). Is only allowed to throw Fatal Throwables.
        Specified by:
        restart in interface Cell

      • resume

        public void resume​(java.lang.Throwable causedByFailure)
        Description copied from interface: Cell
        Recursively resume this actor and all its children. Is only allowed to throw Fatal Throwables.
        Specified by:
        resume in interface Cell

      • self

        public RepointableActorRef self()
        Description copied from interface: Cell
        The &ldquo;self&rdquo; reference which this Cell is attached to.
        Specified by:
        self in interface Cell

      • sendMessage

        public void sendMessage​(Envelope msg)
        Description copied from interface: Cell
        Enqueue a message to be sent to the actor; may or may not actually schedule the actor to run, depending on which type of cell it is. Is only allowed to throw Fatal Throwables.
        Specified by:
        sendMessage in interface Cell

      • sendSystemMessage

        public void sendSystemMessage​(SystemMessage msg)
        Description copied from interface: Cell
        Enqueue a message to be sent to the actor; may or may not actually schedule the actor to run, depending on which type of cell it is. Is only allowed to throw Fatal Throwables.
        Specified by:
        sendSystemMessage in interface Cell

      • start

        public UnstartedCell start()
        Description copied from interface: Cell
        Start the cell: enqueued message must not be processed before this has been called. The usual action is to attach the mailbox to a dispatcher.
        Specified by:
        start in interface Cell

      • stop

        public void stop()
        Description copied from interface: Cell
        Recursively terminate this actor and all its children. Is only allowed to throw Fatal Throwables.
        Specified by:
        stop in interface Cell

      • suspend

        public void suspend()
        Description copied from interface: Cell
        Recursively suspend this actor and all its children. Is only allowed to throw Fatal Throwables.
        Specified by:
        suspend in interface Cell

      • system

        public ActorSystem system()
        Description copied from interface: Cell
        The system within which this Cell lives.
        Specified by:
        system in interface Cell

      • systemImpl

        public ActorSystemImpl systemImpl()
        Description copied from interface: Cell
        The system internals where this Cell lives.
        Specified by:
        systemImpl in interface Cell