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 auth
    Definition Classes
    client
  • package cbor
    Definition Classes
    client
  • package extensions
    Definition Classes
    client
  • package handlers
    Definition Classes
    client
  • package messages
    Definition Classes
    client
  • package models
    Definition Classes
    client
  • CommandResponseManager
  • CommandServiceFactory
  • MiniCRM
  • SequencerCommandServiceImpl
c

csw.command.client

SequencerCommandServiceImpl

class SequencerCommandServiceImpl extends SequencerCommandService

Create a SequencerCommandService for sending commands to sequencer

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

Instance Constructors

  1. new SequencerCommandServiceImpl(sequencerLocation: AkkaLocation)(implicit actorSystem: ActorSystem[_])

    sequencerLocation

    the destination sequencer location to which sequence needs to be sent

    actorSystem

    required for sending sequence commands or querying the sequencer

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() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def query(runId: Id): Future[SubmitResponse]

    Query for the result of the sequence which was submitted to get a csw.params.commands.CommandResponse.SubmitResponse as a Future.

    Query for the result of the sequence which was submitted to get a csw.params.commands.CommandResponse.SubmitResponse as a Future. Query allows checking to see if the long-running sequence is completed without waiting as with queryFinal.

    runId

    of the sequence under execution

    returns

    a csw.params.commands.CommandResponse.SubmitResponse as a Future value

    Definition Classes
    SequencerCommandServiceImpl → SequencerCommandService
  15. def queryFinal(runId: Id)(implicit timeout: Timeout): Future[SubmitResponse]

    Query for the final result of a long running sequence which was sent through submit

    Query for the final result of a long running sequence which was sent through submit

    runId

    of the sequence under execution

    timeout

    max-time to wait for a final response

    returns

    a final csw.params.commands.CommandResponse.SubmitResponse as a Future value

    Definition Classes
    SequencerCommandServiceImpl → SequencerCommandService
  16. def submit(sequence: Sequence): Future[SubmitResponse]

    Submit the given sequence to the sequencer.

    Submit the given sequence to the sequencer. If the sequencer is idle, the provided sequence is loaded in the sequencer and execution of the sequence starts immediately, and a csw.params.commands.CommandResponse.Started response is returned If the sequencer is already running another sequence, an csw.params.commands.CommandResponse.Invalid response is returned

    sequence

    to run on the sequencer

    returns

    an initial csw.params.commands.CommandResponse.SubmitResponse as a Future value

    Definition Classes
    SequencerCommandServiceImpl → SequencerCommandService
  17. def submitAndWait(sequence: Sequence)(implicit timeout: Timeout): Future[SubmitResponse]

    Submit the given sequence to the sequencer and wait for the final response if the sequence was successfully csw.params.commands.CommandResponse.Started.

    Submit the given sequence to the sequencer and wait for the final response if the sequence was successfully csw.params.commands.CommandResponse.Started. If the sequencer is idle, the provided sequence will be submitted to the sequencer and the final response will be returned. If the sequencer is already running another sequence, an csw.params.commands.CommandResponse.Invalid response is returned.

    sequence

    to run on the sequencer

    timeout

    max-time to wait for a final response

    returns

    a final csw.params.commands.CommandResponse.SubmitResponse as a Future value

    Definition Classes
    SequencerCommandServiceImpl → SequencerCommandService
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from SequencerCommandService

Inherited from AnyRef

Inherited from Any

Ungrouped