Packages

abstract class HelpCmd extends Actor

A base for help commands. Commands need to be registered manually using HelpCmd.AddCmd.

Can only be used with the cache in Core.

Linear Supertypes
Actor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HelpCmd
  2. Actor
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HelpCmd()

Type Members

  1. type Receive = PartialFunction[Any, Unit]
    Definition Classes
    Actor

Abstract Value Members

  1. abstract def createReplyAll(message: Message, page: Int)(implicit c: MemoryCacheSnapshot): CreateMessageData

    Create a reply for all the commands tracked by this help command.

    Create a reply for all the commands tracked by this help command.

    page

    The page to use. Starts at 0.

    returns

    Data to create a message describing the commands tracked by this help command.

  2. abstract def createSearchReply(message: Message, query: String, matches: Seq[CommandRegistration])(implicit c: MemoryCacheSnapshot): CreateMessageData

    Create a reply for a search result

    Create a reply for a search result

    matches

    All the commands that matched the arguments

    returns

    Data to create a message describing the search

  3. abstract def sendAck(sender: ActorRef): Unit

    Sends an ack once the processing of a command is done.

    Sends an ack once the processing of a command is done.

    sender

    The actor to send the ack to.

  4. abstract def sendMessageAndAck(sender: ActorRef, request: Request[RawMessage, NotUsed]): Unit

    Send a request, and acks the sender.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def aroundPostRestart(reason: Throwable): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  5. def aroundPostStop(): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  6. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  7. def aroundPreStart(): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  8. def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  11. val commands: HashSet[CommandRegistration]
  12. implicit val context: ActorContext
    Definition Classes
    Actor
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def postRestart(reason: Throwable): Unit
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  23. def postStop(): Unit
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  24. def preRestart(reason: Throwable, message: Option[Any]): Unit
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  25. def preStart(): Unit
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  26. def receive: Receive
    Definition Classes
    HelpCmd → Actor
  27. implicit final val self: ActorRef
    Definition Classes
    Actor
  28. final def sender(): ActorRef
    Definition Classes
    Actor
  29. def supervisorStrategy: SupervisorStrategy
    Definition Classes
    Actor
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def unhandled(message: Any): Unit
    Definition Classes
    Actor
  33. def unknownCmd(command: String): Option[CreateMessageData]
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped