Package org.yamcs.http.api

Class ClientsApi

java.lang.Object

org.yamcs.protobuf.AbstractClientsApi<Context>

org.yamcs.http.api.ClientsApi

All Implemented Interfaces:

Api<Context>

public class ClientsApi
extends AbstractClientsApi<Context>

Constructor Summary

Constructors

Constructor	Description
ClientsApi()

Method Summary

Modifier and Type	Method	Description
void	getClient(Context ctx, GetClientRequest request, Observer<ClientInfo> observer)	Get a client .. warning:: It is recommended to avoid using this method.
void	listClients(Context ctx, com.google.protobuf.Empty request, Observer<ListClientsResponse> observer)	List clients .. warning:: It is recommended to avoid using this method.
static ClientInfo	toClientInfo(ConnectedClient client, ClientInfo.ClientState state)
void	updateClient(Context 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 Details

ClientsApi

public ClientsApi()

Method Details

listClients

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

Description copied from class: AbstractClientsApi

  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<Context>

getClient

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

Description copied from class: AbstractClientsApi

  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<Context>

updateClient

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

Description copied from class: AbstractClientsApi

  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<Context>

toClientInfo

public static ClientInfo toClientInfo(ConnectedClient client,
 ClientInfo.ClientState state)