Package org.yamcs.http.api

Class CommandsApi

java.lang.Object

org.yamcs.protobuf.AbstractCommandsApi<Context>

org.yamcs.http.api.CommandsApi

All Implemented Interfaces:

Api<Context>

public class CommandsApi
extends AbstractCommandsApi<Context>

Constructor Summary

Constructors

Constructor	Description
CommandsApi()

Method Summary

Modifier and Type	Method	Description
void	exportCommand(Context ctx, ExportCommandRequest request, Observer<HttpBody> observer)	Export a raw command
void	exportCommands(Context ctx, ExportCommandsRequest request, Observer<HttpBody> observer)	Export commands in CSV format
void	getCommand(Context ctx, GetCommandRequest request, Observer<Commanding.CommandHistoryEntry> observer)	Get a command
void	issueCommand(Context ctx, IssueCommandRequest request, Observer<IssueCommandResponse> observer)	Issue a command After validating the input parameters, the command is added to the appropriate command queue for further dispatch.
void	listCommands(Context ctx, ListCommandsRequest request, Observer<ListCommandsResponse> observer)	List commands
void	streamCommands(Context ctx, StreamCommandsRequest request, Observer<Commanding.CommandHistoryEntry> observer)	Streams back commands
void	subscribeCommands(Context ctx, SubscribeCommandsRequest request, Observer<Commanding.CommandHistoryEntry> observer)	Receive updates on issued commands
void	updateCommandHistory(Context ctx, UpdateCommandHistoryRequest request, Observer<com.google.protobuf.Empty> observer)	Update command history

Methods inherited from class org.yamcs.protobuf.AbstractCommandsApi

callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CommandsApi

public CommandsApi()

Method Details

issueCommand

public void issueCommand(Context ctx,
 IssueCommandRequest request,
 Observer<IssueCommandResponse> observer)

Description copied from class: AbstractCommandsApi

  Issue a command
 
  After validating the input parameters, the command is added to the appropriate
  command queue for further dispatch.
 

Specified by:

issueCommand in class AbstractCommandsApi<Context>

updateCommandHistory

public void updateCommandHistory(Context ctx,
 UpdateCommandHistoryRequest request,
 Observer<com.google.protobuf.Empty> observer)

Description copied from class: AbstractCommandsApi

  Update command history
 

Specified by:

updateCommandHistory in class AbstractCommandsApi<Context>

listCommands

public void listCommands(Context ctx,
 ListCommandsRequest request,
 Observer<ListCommandsResponse> observer)

Description copied from class: AbstractCommandsApi

  List commands
 

Specified by:

listCommands in class AbstractCommandsApi<Context>

getCommand

public void getCommand(Context ctx,
 GetCommandRequest request,
 Observer<Commanding.CommandHistoryEntry> observer)

Description copied from class: AbstractCommandsApi

  Get a command
 

Specified by:

getCommand in class AbstractCommandsApi<Context>

exportCommand

public void exportCommand(Context ctx,
 ExportCommandRequest request,
 Observer<HttpBody> observer)

Description copied from class: AbstractCommandsApi

  Export a raw command
 

Specified by:

exportCommand in class AbstractCommandsApi<Context>

subscribeCommands

public void subscribeCommands(Context ctx,
 SubscribeCommandsRequest request,
 Observer<Commanding.CommandHistoryEntry> observer)

Description copied from class: AbstractCommandsApi

  Receive updates on issued commands
 

Specified by:

subscribeCommands in class AbstractCommandsApi<Context>

streamCommands

public void streamCommands(Context ctx,
 StreamCommandsRequest request,
 Observer<Commanding.CommandHistoryEntry> observer)

Description copied from class: AbstractCommandsApi

  Streams back commands
 

Specified by:

streamCommands in class AbstractCommandsApi<Context>

exportCommands

public void exportCommands(Context ctx,
 ExportCommandsRequest request,
 Observer<HttpBody> observer)

Description copied from class: AbstractCommandsApi

  Export commands in CSV format
 

Specified by:

exportCommands in class AbstractCommandsApi<Context>