Package org.yamcs.protobuf

Class Cop1ApiClient

java.lang.Object

org.yamcs.protobuf.AbstractCop1Api<Void>

org.yamcs.protobuf.Cop1ApiClient

All Implemented Interfaces:

Api<Void>

public class Cop1ApiClient
extends AbstractCop1Api<Void>

  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
Cop1ApiClient(MethodHandler handler)

Method Summary

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

Methods inherited from class org.yamcs.protobuf.AbstractCop1Api

callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype

Methods inherited from class java.lang.Object

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

Constructor Detail

Cop1ApiClient

public Cop1ApiClient(MethodHandler handler)

Method Detail

initialize

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

  Initialize COP-1 in case state is UNITIALIZED
 

Specified by:

initialize in class AbstractCop1Api<Void>

resume

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

  Resume COP-1 operation in case state is SUSPENDED
 

Specified by:

resume in class AbstractCop1Api<Void>

disable

public final void disable(Void 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
 

Specified by:

disable in class AbstractCop1Api<Void>

updateConfig

public final void updateConfig(Void ctx,
                               UpdateConfigRequest request,
                               Observer<Cop1Config> observer)

  Update configuration settings
 

Specified by:

updateConfig in class AbstractCop1Api<Void>

getConfig

public final void getConfig(Void ctx,
                            GetConfigRequest request,
                            Observer<Cop1Config> observer)

  Get COP-1 configuration
 

Specified by:

getConfig in class AbstractCop1Api<Void>

getStatus

public final void getStatus(Void ctx,
                            GetStatusRequest request,
                            Observer<Cop1Status> observer)

  Get COP-1 status
 

Specified by:

getStatus in class AbstractCop1Api<Void>

subscribeStatus

public final void subscribeStatus(Void ctx,
                                  SubscribeStatusRequest request,
                                  Observer<Cop1Status> observer)

  Receive COP-1 status updates
 

Specified by:

subscribeStatus in class AbstractCop1Api<Void>