Packages

t

csw.command.api.scaladsl

SequencerCommandService

trait SequencerCommandService extends AnyRef

A command Service API of a sequencer. This model provides method based APIs for command interactions with a sequencer.

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

Abstract Value Members

  1. abstract 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

  2. abstract 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

  3. abstract 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

  4. abstract 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

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() @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. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. 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 AnyRef

Inherited from Any

Ungrouped