abstract class HelpCmd[Command] extends AbstractBehavior[Command]
- Alphabetic
- By Inheritance
- HelpCmd
- AbstractBehavior
- ExtensibleBehavior
- Behavior
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new HelpCmd(ctx: ActorContext[Command])
Abstract Value Members
- 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.
- 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
- abstract def onMessage(msg: Command): Behavior[Command]
- Definition Classes
- AbstractBehavior
- Annotations
- @throws(classOf[java.lang.Exception])
- abstract def sendMessageAndAck(sender: ActorRef[Ack.type], request: Request[RawMessage]): Unit
Send a request, and acks the sender.
- abstract def terminateCommand(registration: CommandRegistration): Command
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val commands: HashSet[CommandRegistration]
- val context: ActorContext[Command]
- Attributes
- protected
- Definition Classes
- AbstractBehavior
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def handler: Option[ActorRef[HandlerReply]]
- Attributes
- protected
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def narrow[U <: Command]: Behavior[U]
- Definition Classes
- Behavior
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def onBaseMessage(msg: BaseCommand): Behavior[Command]
- def onSignal: PartialFunction[Signal, Behavior[Command]]
- Definition Classes
- AbstractBehavior
- Annotations
- @throws(classOf[java.lang.Exception])
- final def receive(ctx: TypedActorContext[Command], msg: Command): Behavior[Command]
- Definition Classes
- AbstractBehavior → ExtensibleBehavior
- Annotations
- @throws(classOf[java.lang.Exception])
- final def receiveSignal(ctx: TypedActorContext[Command], msg: Signal): Behavior[Command]
- Definition Classes
- AbstractBehavior → ExtensibleBehavior
- Annotations
- @throws(classOf[java.lang.Exception])
- 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.
- 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
- 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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unknownCmd(command: String): Option[CreateMessageData]
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()