Packages

abstract class HelpCmd[Command] extends AbstractBehavior[Command]

Linear Supertypes
AbstractBehavior[Command], ExtensibleBehavior[Command], Behavior[Command], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HelpCmd
  2. AbstractBehavior
  3. ExtensibleBehavior
  4. Behavior
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new HelpCmd(ctx: ActorContext[Command])

Abstract Value Members

  1. abstract def createReplyAll(message: Message, page: Int)(implicit c: CacheSnapshot): 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: CacheSnapshot): 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 onMessage(msg: Command): Behavior[Command]
    Definition Classes
    AbstractBehavior
    Annotations
    @throws(classOf[java.lang.Exception])
  4. abstract def sendMessageAndAck(sender: ActorRef[Ack.type], request: Request[RawMessage]): Unit

    Send a request, and acks the sender.

  5. abstract def terminateCommand(registration: CommandRegistration): Command

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. val commands: HashSet[CommandRegistration]
  7. val context: ActorContext[Command]
    Attributes
    protected
    Definition Classes
    AbstractBehavior
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def handler: Option[ActorRef[HandlerReply]]
    Attributes
    protected
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def narrow[U <: Command]: Behavior[U]
    Definition Classes
    Behavior
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. def onBaseMessage(msg: BaseCommand): Behavior[Command]
  20. def onSignal: PartialFunction[Signal, Behavior[Command]]
    Definition Classes
    AbstractBehavior
    Annotations
    @throws(classOf[java.lang.Exception])
  21. final def receive(ctx: TypedActorContext[Command], msg: Command): Behavior[Command]
    Definition Classes
    AbstractBehavior → ExtensibleBehavior
    Annotations
    @throws(classOf[java.lang.Exception])
  22. final def receiveSignal(ctx: TypedActorContext[Command], msg: Signal): Behavior[Command]
    Definition Classes
    AbstractBehavior → ExtensibleBehavior
    Annotations
    @throws(classOf[java.lang.Exception])
  23. def sendAck(sender: ActorRef[Ack.type]): 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.

  24. def sendEmptyEvent: Boolean

    If this help command should send an event to the handler when all it's commands have ended.

    If this help command should send an event to the handler when all it's commands have ended.

    Attributes
    protected
  25. def sendEndedEvent: Boolean

    If this help command should send an event to the handler when a command is stopped.

    If this help command should send an event to the handler when a command is stopped.

    Attributes
    protected
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. def unknownCmd(command: String): Option[CreateMessageData]
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AbstractBehavior[Command]

Inherited from ExtensibleBehavior[Command]

Inherited from Behavior[Command]

Inherited from AnyRef

Inherited from Any

Ungrouped