csw
API
Generated with
csw/csw/csw.command/csw.command.api/csw.command.api.client/CommandServiceClient

CommandServiceClient

csw.command.api.client.CommandServiceClient
class CommandServiceClient(httpTransport: Transport[CommandServiceRequest], websocketTransport: Transport[CommandServiceStreamRequest])(implicit actorSystem: ActorSystem[_]) extends CommandService, CommandServiceCodecs

Attributes

Graph
Supertypes
trait BasicCodecs
trait ParamCodecs
trait CommonCodecs
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited classlikes

case class Timestamp(seconds: Long, nanos: Long)

Attributes

Inherited from:
CommonCodecs
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Inherited types

type ArrayDec[T] = Decoder[Array[T]]

Attributes

Inherited from:
ParamCodecsBase
type ArrayEnc[T] = Encoder[Array[T]]

Attributes

Inherited from:
ParamCodecsBase

Value members

Concrete methods

override def executeDiagnosticMode(startTime: UTCTime, hint: String): Unit

On receiving a diagnostic data command, the component goes into a diagnostic data mode based on hint at the specified startTime. Validation of supported hints need to be handled by the component writer.

On receiving a diagnostic data command, the component goes into a diagnostic data mode based on hint at the specified startTime. Validation of supported hints need to be handled by the component writer.

Value parameters

hint

represents supported diagnostic data mode for a component

startTime

represents the time at which the diagnostic mode actions will take effect

Attributes

Definition Classes
override def executeOperationsMode(): Unit

On receiving a operations mode command, the current diagnostic data mode is halted.

On receiving a operations mode command, the current diagnostic data mode is halted.

Attributes

Definition Classes
override def onGoOffline(): Unit

A component can be notified to run in offline mode.

A component can be notified to run in offline mode.

Attributes

Definition Classes
override def onGoOnline(): Unit

A component can be notified to run in online mode again in case it was put to run in offline mode.

A component can be notified to run in online mode again in case it was put to run in offline mode.

Attributes

Definition Classes
override def oneway(controlCommand: ControlCommand): Future[OnewayResponse]

Send a command as a Oneway and get a csw.params.commands.CommandResponse.OnewayResponse as a Future. The OnewayResponse can be a response of validation (Accepted, Invalid) or Locked. The use of oneway is the highest performance command interaction. It is used when completion, if needed at all, is provided through CurrentState or status values and Event Service. See also onewayAndMatch

Send a command as a Oneway and get a csw.params.commands.CommandResponse.OnewayResponse as a Future. The OnewayResponse can be a response of validation (Accepted, Invalid) or Locked. The use of oneway is the highest performance command interaction. It is used when completion, if needed at all, is provided through CurrentState or status values and Event Service. See also onewayAndMatch

Value parameters

controlCommand

the csw.params.commands.ControlCommand payload

Attributes

Returns

a OnewayResponse as a Future value

Definition Classes
override def onewayAndMatch(controlCommand: ControlCommand, stateMatcher: StateMatcher): Future[MatchingResponse]

Submit a command and match the published state from the component using a csw.command.api.StateMatcher. If the match is successful a Completed response is provided as a future. In case of a failure or unmatched state, Error CommandResponse is provided as a Future.

Submit a command and match the published state from the component using a csw.command.api.StateMatcher. If the match is successful a Completed response is provided as a future. In case of a failure or unmatched state, Error CommandResponse is provided as a Future.

Value parameters

controlCommand

the csw.params.commands.ControlCommand payload

stateMatcher

the StateMatcher implementation for matching received state against a demand state

Attributes

Returns

a MatchingResponse as a Future value

Definition Classes
override def query(commandRunId: Id): Future[SubmitResponse]

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

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

Value parameters

commandRunId

the runId of the command for which response is required

Attributes

Returns

a SubmitResponse as a Future value

Definition Classes
override def queryFinal(commandRunId: Id)(implicit timeout: Timeout): Future[SubmitResponse]

Query for the final result of a long running command which was sent as Submit to get a csw.params.commands.CommandResponse.SubmitResponse as a Future

Query for the final result of a long running command which was sent as Submit to get a csw.params.commands.CommandResponse.SubmitResponse as a Future

Value parameters

commandRunId

the runId of the command for which response is required

timeout

max-time to wait for a final response

Attributes

Returns

a SubmitResponse as a Future value

Definition Classes
override def submit(controlCommand: ControlCommand): Future[SubmitResponse]

Submit given command and returns csw.params.commands.CommandResponse.SubmitResponse as a Future

Submit given command and returns csw.params.commands.CommandResponse.SubmitResponse as a Future

Value parameters

controlCommand

the csw.params.commands.ControlCommand payload

Attributes

Returns

a SubmitResponse as a Future value

Definition Classes
override def submitAllAndWait(submitCommands: List[ControlCommand])(implicit timeout: Timeout): Future[List[SubmitResponse]]

Submit multiple commands and get a List of csw.params.commands.CommandResponse.SubmitResponse for all commands. The CommandResponse can be a response of validation (Accepted, Invalid) or a final Response. In case of response as Accepted, final CommandResponse can be obtained by using subscribe API.

Submit multiple commands and get a List of csw.params.commands.CommandResponse.SubmitResponse for all commands. The CommandResponse can be a response of validation (Accepted, Invalid) or a final Response. In case of response as Accepted, final CommandResponse can be obtained by using subscribe API.

Value parameters

submitCommands

the set of csw.params.commands.ControlCommand payloads

timeout

max-time to wait for a final response

Attributes

Returns

a future list of SubmitResponse, one for each command

Definition Classes
override def submitAndWait(controlCommand: ControlCommand)(implicit timeout: Timeout): Future[SubmitResponse]

Submit a command and Subscribe for the result if it was successfully validated as Started to get a final csw.params.commands.CommandResponse.SubmitResponse as a Future

Submit a command and Subscribe for the result if it was successfully validated as Started to get a final csw.params.commands.CommandResponse.SubmitResponse as a Future

Value parameters

controlCommand

the csw.params.commands.ControlCommand payload

timeout

max-time to wait for a final response

Attributes

Returns

a SubmitResponse as a Future value

Definition Classes
override def subscribeCurrentState(names: Set[StateName]): Source[CurrentState, Subscription]

Subscribe to the current state of a component corresponding to the csw.location.api.models.PekkoLocation of the component

Subscribe to the current state of a component corresponding to the csw.location.api.models.PekkoLocation of the component

Value parameters

names

subscribe to states which have any of the provided value for name. If no states are provided, all the current states will be received.

Attributes

Returns

a stream of current states with CurrentStateSubscription as the materialized value which can be used to stop the subscription

Definition Classes
override def subscribeCurrentState(callback: CurrentState => Unit): Subscription

Subscribe to the current state of a component corresponding to the csw.location.api.models.PekkoLocation of the component

Subscribe to the current state of a component corresponding to the csw.location.api.models.PekkoLocation of the component

Value parameters

callback

the action to be applied on the CurrentState element received as a result of subscription

Attributes

Returns

a Subscription to stop the subscription

Note

Callbacks are not thread-safe on the JVM. If you are doing side effects/mutations inside the callback, you should ensure that it is done in a thread-safe way inside an actor.

Definition Classes
override def subscribeCurrentState(names: Set[StateName], callback: CurrentState => Unit): Subscription

Subscribe to the current state of a component corresponding to the csw.location.api.models.PekkoLocation of the component

Subscribe to the current state of a component corresponding to the csw.location.api.models.PekkoLocation of the component

Value parameters

callback

the action to be applied on the CurrentState element received as a result of subscription

names

subscribe to only those states which have any of the provided value for name

Attributes

Returns

a Subscription to stop the subscription

Note

Callbacks are not thread-safe on the JVM. If you are doing side effects/mutations inside the callback, you should ensure that it is done in a thread-safe way inside an actor.

Definition Classes
override def validate(controlCommand: ControlCommand): Future[ValidateResponse]

Send a Validate command and get ValidateResponse as a Future. The ValidateResponse can be of type Accepted, Invalid or Locked.

Send a Validate command and get ValidateResponse as a Future. The ValidateResponse can be of type Accepted, Invalid or Locked.

Value parameters

controlCommand

the csw.params.commands.ControlCommand payload

Attributes

Returns

a ValidateResponse as a Future value

Definition Classes

Inherited fields

lazy protected val commandResponseCodecValue: Codec[CommandResponse]

Attributes

Inherited from:
ParamCodecsBase
lazy val coordCodecValue: Codec[Coord]

Attributes

Inherited from:
ParamCodecsBase

Implicits

Inherited implicits

implicit lazy val angleCodec: Codec[Angle]

Attributes

Inherited from:
ParamCodecsBase
implicit def arrayDataCodec[T : ArrayDec]: Codec[ArrayData[T]]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val bytesDec: Decoder[Array[Byte]]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val bytesEnc: Encoder[Array[Byte]]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val charDec: Decoder[Char]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val charEnc: Encoder[Char]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val characterDec: Decoder[Character]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val characterEnc: Encoder[Character]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val choiceCodec: Codec[Choice]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val commandIssueCodecValue: Codec[CommandIssue]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val commandNameCodec: Codec[CommandName]

Attributes

Inherited from:
ParamCodecsBase
implicit def commandResponseCodec[T <: CommandResponse]: Codec[T]

Attributes

Inherited from:
ParamCodecs
implicit lazy val controlCommandCodec: Codec[ControlCommand]

Attributes

Inherited from:
ParamCodecsBase
implicit def coordCodec[T <: Coord]: Codec[T]

Attributes

Inherited from:
ParamCodecs
implicit lazy val currentStateCodecValue: Codec[CurrentState]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val doneCodec: Codec[Done]

Attributes

Inherited from:
BasicCodecs
implicit def eitherCodec[E : Decoder, S : Decoder]: Codec[Either[E, S]]

Attributes

Inherited from:
BasicCodecs
implicit def enumCodec[T <: EnumEntry : Enum]: Codec[T]

Attributes

Inherited from:
CommonCodecs
implicit lazy val eventCodec: Codec[Event]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val eventNameCodec: Codec[EventName]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val finiteDurationCodec: Codec[FiniteDuration]

Attributes

Inherited from:
CommonCodecs
implicit val flatAdtEncoding: AdtEncodingStrategy

Attributes

Inherited from:
CommonCodecs
implicit lazy val httpCodecsValue: Codec[CommandServiceRequest]

Attributes

Inherited from:
CommandServiceCodecs
implicit lazy val idCodec: Codec[Id]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val instantDec: Decoder[Instant]

Attributes

Inherited from:
CommonCodecs
implicit lazy val instantEnc: Encoder[Instant]

Attributes

Inherited from:
CommonCodecs
implicit lazy val javaByteArrayDec: Decoder[Array[Byte]]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val javaByteArrayEnc: Encoder[Array[Byte]]

Attributes

Inherited from:
ParamCodecsBase
implicit def matrixDataCodec[T : ArrayDec]: Codec[MatrixData[T]]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val obsIdCodec: Codec[ObsId]

Attributes

Inherited from:
ParamCodecsBase
implicit def paramCodec[T : ArrayDec]: Codec[Parameter[T]]

Attributes

Inherited from:
ParamCodecsBase
implicit def paramCoreCodec[T : ArrayDec]: Codec[ParamCore[T]]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val paramDecExistential: Decoder[Parameter[_]]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val paramEncExistential: Encoder[Parameter[_]]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val prefixCodec: Codec[Prefix]

Attributes

Inherited from:
CommonCodecs
implicit lazy val properMotionCodec: Codec[ProperMotion]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val resultCodec: Codec[Result]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val sequenceCodec: Codec[Sequence]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val sequenceCommandCodec: Codec[SequenceCommand]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val stateNameCodec: Codec[StateName]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val stateVariableCodecValue: Codec[StateVariable]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val tagCodec: Codec[Tag]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val taiTimeCodec: Codec[TAITime]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val timeoutInSecondsCodec: Codec[Timeout]

Attributes

Inherited from:
BasicCodecs
implicit lazy val utcTimeCodec: Codec[UTCTime]

Attributes

Inherited from:
ParamCodecsBase
implicit def waCodec[T : ArrayDec]: Codec[ArraySeq[T]]

Attributes

Inherited from:
ParamCodecsBase
implicit lazy val websocketCodecs: Codec[CommandServiceStreamRequest]

Attributes

Inherited from:
CommandServiceCodecs
Generated with