Module org.yamcs.api

Package org.yamcs.protobuf

Class AbstractProcessingApi<T>

java.lang.Object

org.yamcs.protobuf.AbstractProcessingApi<T>

All Implemented Interfaces:

Api<T>

Direct Known Subclasses:

ProcessingApiClient

@Generated(value="org.yamcs.protoc.ServiceGenerator",
           date="2023-09-18T00:21:24.535828694Z")
public abstract class AbstractProcessingApi<T>
extends Object
implements Api<T>

Constructor Summary

Constructors

Constructor	Description
AbstractProcessingApi()

Method Summary

Modifier and Type	Method	Description
abstract void	batchGetParameterValues(T ctx, BatchGetParameterValuesRequest request, Observer<BatchGetParameterValuesResponse> observer)	Batch get the value of multiple parameters
abstract void	batchSetParameterValues(T ctx, BatchSetParameterValuesRequest request, Observer<com.google.protobuf.Empty> observer)	Batch set the value of multiple parameters
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	createProcessor(T ctx, CreateProcessorRequest request, Observer<com.google.protobuf.Empty> observer)	Create a processor
abstract void	deleteProcessor(T ctx, DeleteProcessorRequest request, Observer<com.google.protobuf.Empty> observer)	Delete a processor Only replay processors can be removed.
abstract void	editAlgorithmTrace(T ctx, EditAlgorithmTraceRequest request, Observer<com.google.protobuf.Empty> observer)	Enable/disable algorithm tracing
abstract void	editProcessor(T ctx, EditProcessorRequest request, Observer<com.google.protobuf.Empty> observer)	Update a processor
abstract void	getAlgorithmStatus(T ctx, GetAlgorithmStatusRequest request, Observer<AlgorithmStatus> observer)	Get the algorithm status
abstract void	getAlgorithmTrace(T ctx, GetAlgorithmTraceRequest request, Observer<AlgorithmTrace> observer)	Get the algorithm trace
final com.google.protobuf.Descriptors.ServiceDescriptor	getDescriptorForType()
abstract void	getParameterValue(T ctx, GetParameterValueRequest request, Observer<Pvalue.ParameterValue> observer)	Get a parameter's value
abstract void	getProcessor(T ctx, GetProcessorRequest request, Observer<ProcessorInfo> observer)	Get a processor
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	listProcessors(T ctx, ListProcessorsRequest request, Observer<ListProcessorsResponse> observer)	List processors
abstract void	listProcessorTypes(T ctx, com.google.protobuf.Empty request, Observer<ListProcessorTypesResponse> observer)	List processor types
abstract void	setParameterValue(T ctx, SetParameterValueRequest request, Observer<com.google.protobuf.Empty> observer)	Set a parameter's value Only some type of parameters can be updated.
abstract void	subscribeAlgorithmStatus(T ctx, SubscribeAlgorithmStatusRequest request, Observer<AlgorithmStatus> observer)	Receive algorithm status updates
abstract Observer<SubscribeParametersRequest>	subscribeParameters(T ctx, Observer<SubscribeParametersData> observer)	Receive parameter updates The input message can be sent multiple types, allowing to alter a subscription with the ``action`` field.
abstract void	subscribeProcessors(T ctx, SubscribeProcessorsRequest request, Observer<ProcessorInfo> observer)	Receive processor updates
abstract void	subscribeTMStatistics(T ctx, SubscribeTMStatisticsRequest request, Observer<Statistics> observer)	Receive TM statistics updates

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractProcessingApi

public AbstractProcessingApi()

Method Details

listProcessorTypes

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

  List processor types
 

listProcessors

public abstract void listProcessors(T ctx,
 ListProcessorsRequest request,
 Observer<ListProcessorsResponse> observer)

  List processors
 

getProcessor

public abstract void getProcessor(T ctx,
 GetProcessorRequest request,
 Observer<ProcessorInfo> observer)

  Get a processor
 

deleteProcessor

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

  Delete a processor
 
  Only replay processors can be removed.
 

editProcessor

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

  Update a processor
 

createProcessor

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

  Create a processor
 

getParameterValue

public abstract void getParameterValue(T ctx,
 GetParameterValueRequest request,
 Observer<Pvalue.ParameterValue> observer)

  Get a parameter's value
 

setParameterValue

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

  Set a parameter's value
 
  Only some type of parameters can be updated.
 

batchGetParameterValues

public abstract void batchGetParameterValues(T ctx,
 BatchGetParameterValuesRequest request,
 Observer<BatchGetParameterValuesResponse> observer)

  Batch get the value of multiple parameters
 

batchSetParameterValues

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

  Batch set the value of multiple parameters
 

subscribeTMStatistics

public abstract void subscribeTMStatistics(T ctx,
 SubscribeTMStatisticsRequest request,
 Observer<Statistics> observer)

  Receive TM statistics updates
 

subscribeParameters

public abstract Observer<SubscribeParametersRequest> subscribeParameters(T ctx,
 Observer<SubscribeParametersData> observer)

  Receive parameter updates
 
  The input message can be sent multiple types, allowing to alter a
  subscription with the ``action`` field.
 

subscribeProcessors

public abstract void subscribeProcessors(T ctx,
 SubscribeProcessorsRequest request,
 Observer<ProcessorInfo> observer)

  Receive processor updates
 

getAlgorithmStatus

public abstract void getAlgorithmStatus(T ctx,
 GetAlgorithmStatusRequest request,
 Observer<AlgorithmStatus> observer)

  Get the algorithm status
 

subscribeAlgorithmStatus

public abstract void subscribeAlgorithmStatus(T ctx,
 SubscribeAlgorithmStatusRequest request,
 Observer<AlgorithmStatus> observer)

  Receive algorithm status updates
 

getAlgorithmTrace

public abstract void getAlgorithmTrace(T ctx,
 GetAlgorithmTraceRequest request,
 Observer<AlgorithmTrace> observer)

  Get the algorithm trace
 

editAlgorithmTrace

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

  Enable/disable algorithm tracing
 

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>