< Back

Packages

package root
Definition Classes
root
package csw
Definition Classes
root
package command
Definition Classes
csw
package client
This project defines the basic classes and traits for the Command Service.
Command Service
This project defines the basic classes and traits for the Command Service.
Related projects are: - csw-messages:
- This defines the types of command (Oneway/Submit etc.) and types of configurations (Setup/Observe/Wait etc.)
- Complete usage of Messages is available at: https://tmtsoftware.github.io/csw/services/messages.html
- framework:
- This defines the Hcd and Assembly handlers, lifecycle manager and supervisor for components.
- Framework allows component writer to override onValidation, onSubmit and onOneway handlers. (Note it allows overriding other handlers as well.)
- On every command received by component, onValidation handler gets invoked where received command gets validated and validation response is returned.
- Based on validation response and command type, onSubmit/onOneway hooks gets invoked where command gets processed.
- Complete details of handling commands can be found here : https://tmtsoftware.github.io/csw/framework/handling-lifecycle.html#handling-commands
Important classes in this project are:
- csw.command.api.scaladsl.CommandService
This class wraps the csw.location.api.models.AkkaLocation and provides helpers to send commands to component actor extracted from provided location. Normal component writers workflow would be to first resolve component using location service and then create CommandService instance using resolved location.
Using this instance, you can Submit Command/Commands to other component or query for command result or subscribe for long running command result.
When you have multiple commands targeted to multiple components then you can use ConfigDistributor. Using CommandDistributor utility you can send all these commands in one go and get aggregated response.
Complete guide of usage of different API's provided by CommandService is available at: https://tmtsoftware.github.io/csw/command.html
Definition Classes
command
package messages
Definition Classes
client
package sequencer
Definition Classes
messages
CommandMessage
CommandSerializationMarker
CommonMessage
ComponentCommonMessage
ComponentMessage
ContainerCommonMessage
ContainerMessage
DiagnosticDataMessage
GetComponentLogMetadata
LogControlMessage
Query
QueryFinal
RunningMessage
SetComponentLogLevel
SupervisorContainerCommonMessages
SupervisorLockMessage
SupervisorRunningMessage
TopLevelActorMessage

t

csw.command.client.messages

CommandMessage

Companion object CommandMessage

sealed trait CommandMessage extends RunningMessage with SupervisorLockMessage

Represent messages that carry commands sent from one component to other

Linear Supertypes

SupervisorLockMessage, RunningMessage, RemoteMsg, CommandSerializable, SupervisorRunningMessage, ComponentMessage, SupervisorMessage, TopLevelActorMessage, AnyRef, Any

Known Subclasses

Oneway, Submit, Validate

Ordering

Alphabetic
By Inheritance

Inherited

CommandMessage
SupervisorLockMessage
RunningMessage
RemoteMsg
CommandSerializable
SupervisorRunningMessage
ComponentMessage
SupervisorMessage
TopLevelActorMessage
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract def command: ControlCommand
Represents a command sent to other component
abstract def replyTo: ActorRef[Locked]
Represents the actor that will receive the Locked response for Submit, Oneway and Validate kind of commands

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() @IntrinsicCandidate()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
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()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated

Inherited from SupervisorLockMessage

Inherited from RunningMessage

Inherited from RemoteMsg

Inherited from CommandSerializable

Inherited from SupervisorRunningMessage

Inherited from ComponentMessage

Inherited from SupervisorMessage

Inherited from TopLevelActorMessage

Inherited from AnyRef

Inherited from Any

Ungrouped