Package org.apache.pekko.actor

Interface Cell

public interface Cell
INTERNAL API

  • Method Summary

    Modifier and Type
    Method
    Description
    ChildrenContainer
    childrenRefs()
    All children of this actor, including only reserved-names.
    scala.Option<ChildStats>
    getChildByName(String name)
    Get the stats for the named child, if that exists.
    org.apache.pekko.actor.InternalActorRef
    getSingleChild(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.
    org.apache.pekko.actor.InternalActorRef
    parent()
    The supervisor of this actor.
    Props
    props()
    The props for this actor cell.
    void
    restart(Throwable cause)
    Restart this actor (will recursively restart or stop all children).
    void
    resume(Throwable causedByFailure)
    Recursively resume this actor and all its children.
    ActorRef
    self()
    The &ldquo;self&rdquo; reference which this Cell is attached to.
    void
    sendMessage(Object message, ActorRef sender)
    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
    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.
    Cell
    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.
    void
    suspend()
    Recursively suspend this actor and all its children.
    ActorSystem
    system()
    The system within which this Cell lives.
    org.apache.pekko.actor.ActorSystemImpl
    systemImpl()
    The system internals where this Cell lives.

  • Method Details

    • childrenRefs

      ChildrenContainer childrenRefs()
      All children of this actor, including only reserved-names.

    • getChildByName

      scala.Option<ChildStats> getChildByName(String name)
      Get the stats for the named child, if that exists.

    • getSingleChild

      org.apache.pekko.actor.InternalActorRef getSingleChild(String name)
      Method for looking up a single child beneath this actor. It is racy if called from the outside.

    • hasMessages

      boolean hasMessages()
      If the actor isLocal, returns whether "user messages" are currently queued, &ldquo;false&rdquo; otherwise.

    • isLocal

      boolean isLocal()
      Returns true if the actor is local, i.e. if it is actually scheduled on a Thread in the current JVM when run.

    • isTerminated

      boolean isTerminated()
      Returns &ldquo;true&rdquo; if the actor is locally known to be terminated, &ldquo;false&rdquo; if alive or uncertain.

    • numberOfMessages

      int numberOfMessages()
      If the actor isLocal, returns the number of "user messages" currently queued, which may be a costly operation, 0 otherwise.

    • parent

      org.apache.pekko.actor.InternalActorRef parent()
      The supervisor of this actor.

    • props

      Props props()
      The props for this actor cell.

    • restart

      void restart(Throwable cause)
      Restart this actor (will recursively restart or stop all children). Is only allowed to throw Fatal Throwables.

    • resume

      void resume(Throwable causedByFailure)
      Recursively resume this actor and all its children. Is only allowed to throw Fatal Throwables.

    • self

      ActorRef self()
      The &ldquo;self&rdquo; reference which this Cell is attached to.

    • sendMessage

      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. Is only allowed to throw Fatal Throwables.

    • sendMessage

      void sendMessage(Object message, ActorRef sender)
      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.

    • sendSystemMessage

      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. Is only allowed to throw Fatal Throwables.

    • start

      Cell start()
      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.

    • stop

      void stop()
      Recursively terminate this actor and all its children. Is only allowed to throw Fatal Throwables.

    • suspend

      void suspend()
      Recursively suspend this actor and all its children. Is only allowed to throw Fatal Throwables.

    • system

      ActorSystem system()
      The system within which this Cell lives.

    • systemImpl

      org.apache.pekko.actor.ActorSystemImpl systemImpl()
      The system internals where this Cell lives.