CommandService | @tmtsoftware/esw-ts

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

interface

Hierarchy

CommandService

Index

Methods

oneway

oneway(command: ControlCommand): Promise<OnewayResponse>

- Defined in src/clients/command/CommandService.ts:50
Submit a oneway command to a component which returns a promise of OnewayResponse. This api is used when completion is provided through CurrentState or status values and eventService.

Parameters
- command: ControlCommand
  
  Command to be sent as oneway command.
Returns Promise<OnewayResponse>
OnewayResponse as Promise

query

query(runId: string): Promise<SubmitResponse>

- Defined in src/clients/command/CommandService.ts:58
This api is used to get the result of a long running command which was submitted and returns a promise of SubmitResponse.

Parameters
- runId: string
  
  The runId of the command for which response is required
Returns Promise<SubmitResponse>
SubmitResponse as Promise

queryFinal

queryFinal(runId: string, timeoutInSeconds: number): Promise<SubmitResponse>

- Defined in src/clients/command/CommandService.ts:67
This api is used to get the final result of a long running command which was submitted and returns a promise of SubmitResponse.

Parameters
- runId: string
  
  The runId of the command for which response is required
- timeoutInSeconds: number
  
  time to wait for a final response
Returns Promise<SubmitResponse>
SubmitResponse as Promise

submit

submit(command: ControlCommand): Promise<SubmitResponse>

- Defined in src/clients/command/CommandService.ts:41
Submit a command to a component which returns a promise of SubmitResponse.

Parameters
- command: ControlCommand
  
  Command to be submitted.
Returns Promise<SubmitResponse>
SubmitResponse as Promise

submitAllAndWait

submitAllAndWait(commands: ControlCommand[], timeoutInSeconds: number): Promise<SubmitResponse[]>

- Defined in src/clients/command/CommandService.ts:103
Submit multiple commands and wait for the result of the all submitted commands

Parameters
- commands: ControlCommand[]
  
  a list of commands to be submitted
- timeoutInSeconds: number
  
  time to wait for a final response
Returns Promise<SubmitResponse[]>
SubmitResponse's List as Promise

submitAndWait

submitAndWait(command: ControlCommand, timeoutInSeconds: number): Promise<SubmitResponse>

- Defined in src/clients/command/CommandService.ts:94
Submit a single command and wait for the result of the submitted command

Parameters
- command: ControlCommand
  
  Command to be submitted
- timeoutInSeconds: number
  
  time to wait for a final response
Returns Promise<SubmitResponse>
SubmitResponse as Promise

subscribeCurrentState

subscribeCurrentState(stateNames: Set<string>): (onStateChange: (state: CurrentState) => void, onError?: (error: ServiceError) => void, onClose?: () => void) => Subscription

- Defined in src/clients/command/CommandService.ts:79
Subscribe to the current state of a component corresponding to the AkkaLocation of the component

Parameters
- stateNames: Set<string>
  
  Subscribe to the set of currentStates. If no states are provided, all the current states will be received.
Returns (onStateChange: (state: CurrentState) => void, onError?: (error: ServiceError) => void, onClose?: () => void) => Subscription
Subscription which can be used to cancel to the subscription in future.
- - (onStateChange: (state: CurrentState) => void, onError?: (error: ServiceError) => void, onClose?: () => void): Subscription
  - Subscribe to the current state of a component corresponding to the AkkaLocation of the component
    
    Parameters
    - onStateChange: (state: CurrentState) => void
      
      a callback which gets called on change of any of the subscribed currentState
      - (state: CurrentState): void
        Parameters
        state: CurrentState
        Returns void
    - Optional onError: (error: ServiceError) => void
      
      a optional error callback which gets called on receiving error. it can be Parsing error or a Runtime error [for ex. Gateway exception]
      - (error: ServiceError): void
        Parameters
        error: ServiceError
        Returns void
    - Optional onClose: () => void
      
      a optional close callback which gets called when the connection is closed.
      - (): void
        Returns void
    Returns Subscription
    Subscription which can be used to cancel to the subscription in future.

validate

validate(command: ControlCommand): Promise<ValidateResponse>

- Defined in src/clients/command/CommandService.ts:33
Send a validate command to a component which returns a promise of ValidateResponse.

Parameters
- command: ControlCommand
  
  Command to be validated.
Returns Promise<ValidateResponse>
ValidateResponse as Promise

Hierarchy

Index

Methods

Methods

oneway

Parameters

command: ControlCommand

Returns Promise<OnewayResponse>

query

Parameters

runId: string

Returns Promise<SubmitResponse>

queryFinal

Parameters

runId: string

timeoutInSeconds: number

Returns Promise<SubmitResponse>

submit

Parameters

command: ControlCommand

Returns Promise<SubmitResponse>

submitAllAndWait

Parameters

commands: ControlCommand[]

timeoutInSeconds: number

Returns Promise<SubmitResponse[]>

submitAndWait

Parameters

command: ControlCommand

timeoutInSeconds: number

Returns Promise<SubmitResponse>

subscribeCurrentState

Parameters

stateNames: Set<string>

Returns (onStateChange: (state: CurrentState) => void, onError?: (error: ServiceError) => void, onClose?: () => void) => Subscription

Parameters

onStateChange: (state: CurrentState) => void

Parameters

state: CurrentState

Returns void

Optional onError: (error: ServiceError) => void

Parameters

error: ServiceError

Returns void

Optional onClose: () => void

Returns void

Returns Subscription

validate

Parameters

command: ControlCommand

Returns Promise<ValidateResponse>