Package org.yamcs.protobuf

Class ClientsApiClient

java.lang.Object

org.yamcs.protobuf.AbstractClientsApi<Void>

org.yamcs.protobuf.ClientsApiClient

All Implemented Interfaces:

Api<Void>

public class ClientsApiClient
extends AbstractClientsApi<Void>

  Methods for working with 'clients'.
 
  .. warning::
      This API is gradually being phased out and subject to removal.
      It dates from a time when client software was not knowledgeable about
      Yamcs and where their state (instance, processor) had to be managed
      server-side.
 

Constructor Summary

Constructors

Constructor	Description
ClientsApiClient(MethodHandler handler)

Method Summary

Modifier and Type	Method	Description
void	getClient(Void ctx, GetClientRequest request, Observer<ClientInfo> observer)	Get a client .. warning:: It is recommended to avoid using this method.
void	listClients(Void ctx, com.google.protobuf.Empty request, Observer<ListClientsResponse> observer)	List clients .. warning:: It is recommended to avoid using this method.
void	updateClient(Void ctx, EditClientRequest request, Observer<com.google.protobuf.Empty> observer)	Update a client .. warning:: It is recommended to avoid using this method.

Methods inherited from class org.yamcs.protobuf.AbstractClientsApi

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

ClientsApiClient

public ClientsApiClient(MethodHandler handler)

Method Detail

listClients

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

  List clients
 
  .. warning::
      It is recommended to avoid using this method. It dates from a time
      when clients were not knowledgeable about Yamcs and their state had
      to be managed server-side. Nowadays we are favouring stateless APIs
      and leave state management entirely to the client software.
 

Specified by:

listClients in class AbstractClientsApi<Void>

getClient

public final void getClient(Void ctx,
                            GetClientRequest request,
                            Observer<ClientInfo> observer)

  Get a client
 
  .. warning::
      It is recommended to avoid using this method. It dates from a time
      when clients were not knowledgeable about Yamcs and their state had
      to be managed server-side. Nowadays we are favouring stateless APIs
      and leave state management entirely to the client software.
 

Specified by:

getClient in class AbstractClientsApi<Void>

updateClient

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

  Update a client
 
  .. warning::
      It is recommended to avoid using this method. It dates from a time
      when clients were not knowledgeable about Yamcs and their state had
      to be managed server-side. Nowadays we are favouring stateless APIs
      and leave state management entirely to the client software.
 

Specified by:

updateClient in class AbstractClientsApi<Void>