org.yamcs.protobuf

Class AbstractCop1Api<T>

java.lang.Object

org.yamcs.protobuf.AbstractCop1Api<T>

All Implemented Interfaces:

Api<T>

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

the COP1 service is valid for the 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 and Description
AbstractCop1Api()

Method Summary

Modifier and Type	Method and 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 COP1 operation, causing the sent queue to be purged all TCs from the wait queue and the newly received ones will be sent immediately
abstract void	getConfig(T ctx, GetConfigRequest request, Observer<Cop1Config> observer)
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)
abstract void	initialize(T ctx, InitializeRequest request, Observer<com.google.protobuf.Empty> observer) used in case state = UNITIALIZED to initialize COP1
abstract void	resume(T ctx, ResumeRequest request, Observer<com.google.protobuf.Empty> observer) used in case state = SUSPENDED to resume COP1 operation
abstract void	setConfig(T ctx, SetConfigRequest request, Observer<com.google.protobuf.Empty> observer)

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)

used in case state = UNITIALIZED to initialize COP1

resume

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

used in case state = SUSPENDED to resume COP1 operation

disable

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

disable COP1 operation, causing the sent queue to be purged all TCs from the wait queue and the newly received ones will be sent immediately

setConfig

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

getConfig

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

getStatus

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

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>