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 cbor
    Definition Classes
    client
  • CommandAkkaSerializer
  • MessageCodecs
  • MessageCodecsBase
t

csw.command.client.cbor

MessageCodecsBase

trait MessageCodecsBase extends ParamCodecs with LoggingCodecs with LocationCodecs

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MessageCodecsBase
  2. LocationCodecs
  3. LocationCodecsBase
  4. LoggingCodecs
  5. ParamCodecs
  6. ParamCodecsBase
  7. CommonCodecs
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type ArrayDec[T] = Decoder[Array[T]]
    Definition Classes
    ParamCodecsBase
  2. type ArrayEnc[T] = Encoder[Array[T]]
    Definition Classes
    ParamCodecsBase
  3. case class Timestamp(seconds: Long, nanos: Long) extends Product with Serializable
    Definition Classes
    CommonCodecs

Value Members

  1. implicit def actorRefCodec[T]: Codec[ActorRef[T]]
  2. implicit lazy val angleCodec: Codec[Angle]
    Definition Classes
    ParamCodecsBase
  3. implicit def arrayDataCodec[T](implicit arg0: ArrayEnc[T], arg1: ArrayDec[T]): Codec[ArrayData[T]]
    Definition Classes
    ParamCodecsBase
  4. implicit lazy val bytesDec: Decoder[Array[Byte]]
    Definition Classes
    ParamCodecsBase
  5. implicit lazy val bytesEnc: Encoder[Array[Byte]]
    Definition Classes
    ParamCodecsBase
  6. implicit lazy val charDec: Decoder[Char]
    Definition Classes
    ParamCodecsBase
  7. implicit lazy val charEnc: Encoder[Char]
    Definition Classes
    ParamCodecsBase
  8. implicit lazy val characterDec: Decoder[Character]
    Definition Classes
    ParamCodecsBase
  9. implicit lazy val characterEnc: Encoder[Character]
    Definition Classes
    ParamCodecsBase
  10. implicit lazy val choiceCodec: Codec[Choice]
    Definition Classes
    ParamCodecsBase
  11. implicit lazy val commandIssueCodecValue: Codec[CommandIssue]
    Definition Classes
    ParamCodecsBase
  12. implicit lazy val commandNameCodec: Codec[CommandName]
    Definition Classes
    ParamCodecsBase
  13. implicit def commandResponseCodec[T <: CommandResponse]: Codec[T]
    Definition Classes
    ParamCodecs
  14. implicit lazy val componentCodec: Codec[Component]
  15. implicit lazy val componentIdCodec: Codec[ComponentId]
    Definition Classes
    LocationCodecsBase
  16. implicit lazy val componentInfoCodec: Codec[ComponentInfo]
  17. implicit lazy val componentsCodec: Codec[Components]
  18. implicit def connectionCodec[C <: Connection]: Codec[C]
    Definition Classes
    LocationCodecsBase
  19. implicit lazy val connectionInfoCodec: Codec[ConnectionInfo]
    Definition Classes
    LocationCodecsBase
  20. implicit lazy val controlCommandCodec: Codec[ControlCommand]
    Definition Classes
    ParamCodecsBase
  21. implicit def coordCodec[T <: Coord]: Codec[T]
    Definition Classes
    ParamCodecs
  22. lazy val coordCodecValue: Codec[Coord]
    Definition Classes
    ParamCodecsBase
  23. implicit lazy val cswSequencerMessageCodec: Codec[CswSequencerMessage]
  24. implicit lazy val currentStateCodecValue: Codec[CurrentState]
    Definition Classes
    ParamCodecsBase
  25. implicit def enumCodec[T <: EnumEntry](implicit arg0: Enum[T]): Codec[T]
    Definition Classes
    CommonCodecs
  26. implicit lazy val eventCodec: Codec[Event]
    Definition Classes
    ParamCodecsBase
  27. implicit lazy val eventNameCodec: Codec[EventName]
    Definition Classes
    ParamCodecsBase
  28. def explicitEnumCodec[T <: EnumEntry](implicit arg0: Enum[T]): Codec[T]
    Definition Classes
    LoggingCodecs
  29. implicit lazy val finiteDurationCodec: Codec[FiniteDuration]
    Definition Classes
    CommonCodecs
  30. implicit val flatAdtEncoding: AdtEncodingStrategy
    Definition Classes
    CommonCodecs
  31. implicit lazy val idCodec: Codec[Id]
    Definition Classes
    ParamCodecsBase
  32. implicit lazy val instantDec: Decoder[Instant]
    Definition Classes
    CommonCodecs
  33. implicit lazy val instantEnc: Encoder[Instant]
    Definition Classes
    CommonCodecs
  34. implicit lazy val javaByteArrayDec: Decoder[Array[Byte]]
    Definition Classes
    ParamCodecsBase
  35. implicit lazy val javaByteArrayEnc: Encoder[Array[Byte]]
    Definition Classes
    ParamCodecsBase
  36. implicit lazy val levelCodec: Codec[Level]
    Definition Classes
    LoggingCodecs
  37. implicit lazy val lifecycleStateChangedCodec: Codec[LifecycleStateChanged]
  38. implicit def locationCodec[T <: Location]: Codec[T]
    Definition Classes
    LocationCodecs
  39. implicit lazy val lockingResponseCodec: Codec[LockingResponse]
  40. implicit lazy val logMetadataCodec: Codec[LogMetadata]
    Definition Classes
    LoggingCodecs
  41. implicit def matrixDataCodec[T](implicit arg0: ClassTag[T], arg1: ArrayEnc[T], arg2: ArrayDec[T]): Codec[MatrixData[T]]
    Definition Classes
    ParamCodecsBase
  42. implicit lazy val metadataCodec: Codec[Metadata]
    Definition Classes
    LocationCodecsBase
  43. implicit lazy val networkType: Codec[NetworkType]
    Definition Classes
    LocationCodecsBase
  44. implicit lazy val obsIdCodec: Codec[ObsId]
    Definition Classes
    ParamCodecsBase
  45. implicit def paramCodec[T](implicit arg0: ArrayEnc[T], arg1: ArrayDec[T]): Codec[Parameter[T]]
    Definition Classes
    ParamCodecsBase
  46. implicit def paramCoreCodec[T](implicit arg0: ArrayEnc[T], arg1: ArrayDec[T]): Codec[ParamCore[T]]
    Definition Classes
    ParamCodecsBase
  47. implicit lazy val paramDecExistential: Decoder[Parameter[_]]
    Definition Classes
    ParamCodecsBase
  48. implicit lazy val paramEncExistential: Encoder[Parameter[_]]
    Definition Classes
    ParamCodecsBase
  49. implicit lazy val prefixCodec: Codec[Prefix]
    Definition Classes
    CommonCodecs
  50. implicit lazy val properMotionCodec: Codec[ProperMotion]
    Definition Classes
    ParamCodecsBase
  51. implicit lazy val registrationCodec: Codec[Registration]
    Definition Classes
    LocationCodecsBase
  52. implicit lazy val resultCodec: Codec[Result]
    Definition Classes
    ParamCodecsBase
  53. implicit lazy val sequenceCodec: Codec[Sequence]
    Definition Classes
    ParamCodecsBase
  54. implicit lazy val sequenceCommandCodec: Codec[SequenceCommand]
    Definition Classes
    ParamCodecsBase
  55. implicit lazy val stateNameCodec: Codec[StateName]
    Definition Classes
    ParamCodecsBase
  56. implicit lazy val stateVariableCodecValue: Codec[StateVariable]
    Definition Classes
    ParamCodecsBase
  57. implicit lazy val tagCodec: Codec[Tag]
    Definition Classes
    ParamCodecsBase
  58. implicit lazy val taiTimeCodec: Codec[TAITime]
    Definition Classes
    ParamCodecsBase
  59. implicit lazy val trackingEventCodec: Codec[TrackingEvent]
    Definition Classes
    LocationCodecsBase
  60. implicit lazy val uriCodec: Codec[URI]
    Definition Classes
    LocationCodecsBase
  61. implicit lazy val utcTimeCodec: Codec[UTCTime]
    Definition Classes
    ParamCodecsBase
  62. implicit def waCodec[T](implicit arg0: ArrayEnc[T], arg1: ArrayDec[T]): Codec[ArraySeq[T]]
    Definition Classes
    ParamCodecsBase