Module org.yamcs.api

Package org.yamcs.protobuf

Class AbstractCommandsApi<T>

java.lang.Object

org.yamcs.protobuf.AbstractCommandsApi<T>

All Implemented Interfaces:

Api<T>

Direct Known Subclasses:

CommandsApiClient

@Generated(value="org.yamcs.maven.ServiceGenerator",
           date="2024-10-24T18:57:21.044764814Z")
public abstract class AbstractCommandsApi<T>
extends Object
implements Api<T>

Constructor Summary

Constructors

Constructor	Description
AbstractCommandsApi()

Method Summary

Modifier and Type	Method	Description
final void	callMethod(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, com.google.protobuf.Message request, Observer<com.google.protobuf.Message> future)
final Observer<com.google.protobuf.Message>	callMethod(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, Observer<com.google.protobuf.Message> future)
abstract void	exportCommand(T ctx, ExportCommandRequest request, Observer<HttpBody> observer)	Export a raw command
abstract void	exportCommands(T ctx, ExportCommandsRequest request, Observer<HttpBody> observer)	Export commands in CSV format
abstract void	getCommand(T ctx, GetCommandRequest request, Observer<Commanding.CommandHistoryEntry> observer)	Get a command
final com.google.protobuf.Descriptors.ServiceDescriptor	getDescriptorForType()
final com.google.protobuf.Message	getRequestPrototype(com.google.protobuf.Descriptors.MethodDescriptor method)
final com.google.protobuf.Message	getResponsePrototype(com.google.protobuf.Descriptors.MethodDescriptor method)
abstract void	issueCommand(T 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.
abstract void	listCommands(T ctx, ListCommandsRequest request, Observer<ListCommandsResponse> observer)	List commands
abstract void	streamCommands(T ctx, StreamCommandsRequest request, Observer<Commanding.CommandHistoryEntry> observer)	Streams back commands
abstract void	subscribeCommands(T ctx, SubscribeCommandsRequest request, Observer<Commanding.CommandHistoryEntry> observer)	Receive updates on issued commands
abstract void	updateCommandHistory(T ctx, UpdateCommandHistoryRequest request, Observer<com.google.protobuf.Empty> observer)	Update command history

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractCommandsApi

public AbstractCommandsApi()

Method Details

issueCommand

public abstract void issueCommand(T 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.
 

updateCommandHistory

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

  Update command history
 

listCommands

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

  List commands
 

getCommand

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

  Get a command
 

streamCommands

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

  Streams back commands
 

subscribeCommands

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

  Receive updates on issued commands
 

exportCommand

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

  Export a raw command
 

exportCommands

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

  Export commands in CSV format
 

getDescriptorForType

public final com.google.protobuf.Descriptors.ServiceDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Api<T>

getRequestPrototype

public final com.google.protobuf.Message getRequestPrototype(com.google.protobuf.Descriptors.MethodDescriptor method)

Specified by:

getRequestPrototype in interface Api<T>

getResponsePrototype

public final com.google.protobuf.Message getResponsePrototype(com.google.protobuf.Descriptors.MethodDescriptor method)

Specified by:

getResponsePrototype in interface Api<T>

callMethod

public final void callMethod(com.google.protobuf.Descriptors.MethodDescriptor method,
 T ctx,
 com.google.protobuf.Message request,
 Observer<com.google.protobuf.Message> future)

Specified by:

callMethod in interface Api<T>

callMethod

public final Observer<com.google.protobuf.Message> callMethod(com.google.protobuf.Descriptors.MethodDescriptor method,
 T ctx,
 Observer<com.google.protobuf.Message> future)

Specified by:

callMethod in interface Api<T>