Package org.yamcs.protobuf

Class AbstractCop1Api<T>

java.lang.Object

org.yamcs.protobuf.AbstractCop1Api<T>

All Implemented Interfaces:

Api<T>

Direct Known Subclasses:

Cop1ApiClient

public abstract class AbstractCop1Api<T>
extends Object
implements Api<T>

  Methods for virtual channel TC links that have ``useCop1: true``.
  This service contains methods for setting/getting the configuration and
  performing various operations.
  In addition, a websocket subscription is available that will allow receiving periodically the status.
 

Constructor Summary

Constructors

Constructor	Description
AbstractCop1Api()

Method Summary

Modifier and Type	Method	Description
void	callMethod(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, com.google.protobuf.Message request, Observer<com.google.protobuf.Message> future)
Observer<com.google.protobuf.Message>	callMethod(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, Observer<com.google.protobuf.Message> future)
abstract void	disable(T ctx, DisableRequest request, Observer<com.google.protobuf.Empty> observer)	Disable COP-1 operation This causes the sent queue to be purged.
abstract void	getConfig(T ctx, GetConfigRequest request, Observer<Cop1Config> observer)	Get COP-1 configuration
com.google.protobuf.Descriptors.ServiceDescriptor	getDescriptorForType()
com.google.protobuf.Message	getRequestPrototype(com.google.protobuf.Descriptors.MethodDescriptor method)
com.google.protobuf.Message	getResponsePrototype(com.google.protobuf.Descriptors.MethodDescriptor method)
abstract void	getStatus(T ctx, GetStatusRequest request, Observer<Cop1Status> observer)	Get COP-1 status
abstract void	initialize(T ctx, InitializeRequest request, Observer<com.google.protobuf.Empty> observer)	Initialize COP-1 in case state is UNITIALIZED
abstract void	resume(T ctx, ResumeRequest request, Observer<com.google.protobuf.Empty> observer)	Resume COP-1 operation in case state is SUSPENDED
abstract void	subscribeStatus(T ctx, SubscribeStatusRequest request, Observer<Cop1Status> observer)	Receive COP-1 status updates
abstract void	updateConfig(T ctx, UpdateConfigRequest request, Observer<Cop1Config> observer)	Update configuration settings

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCop1Api

public AbstractCop1Api()

Method Detail

initialize

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

  Initialize COP-1 in case state is UNITIALIZED
 

resume

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

  Resume COP-1 operation in case state is SUSPENDED
 

disable

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

  Disable COP-1 operation
 
  This causes the sent queue to be purged.
  All TCs from the wait queue, as well as newly received TCs
  are sent immediately
 

updateConfig

public abstract void updateConfig(T ctx,
                                  UpdateConfigRequest request,
                                  Observer<Cop1Config> observer)

  Update configuration settings
 

getConfig

public abstract void getConfig(T ctx,
                               GetConfigRequest request,
                               Observer<Cop1Config> observer)

  Get COP-1 configuration
 

getStatus

public abstract void getStatus(T ctx,
                               GetStatusRequest request,
                               Observer<Cop1Status> observer)

  Get COP-1 status
 

subscribeStatus

public abstract void subscribeStatus(T ctx,
                                     SubscribeStatusRequest request,
                                     Observer<Cop1Status> observer)

  Receive COP-1 status updates
 

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>