Package org.yamcs.protobuf
Class AbstractClientsApi<T>
java.lang.Object
org.yamcs.protobuf.AbstractClientsApi<T>
- All Implemented Interfaces:
Api<T>
- Direct Known Subclasses:
ClientsApi
,ClientsApiClient
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
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
callMethod
(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, com.google.protobuf.Message request, Observer<com.google.protobuf.Message> future) final Observer<com.google.protobuf.Message>
callMethod
(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, Observer<com.google.protobuf.Message> future) abstract void
getClient
(T ctx, GetClientRequest request, Observer<ClientInfo> observer) Get a client .. warning:: It is recommended to avoid using this method.final com.google.protobuf.Descriptors.ServiceDescriptor
final com.google.protobuf.Message
getRequestPrototype
(com.google.protobuf.Descriptors.MethodDescriptor method) final com.google.protobuf.Message
getResponsePrototype
(com.google.protobuf.Descriptors.MethodDescriptor method) abstract void
listClients
(T ctx, com.google.protobuf.Empty request, Observer<ListClientsResponse> observer) List clients .. warning:: It is recommended to avoid using this method.abstract void
updateClient
(T ctx, EditClientRequest request, Observer<com.google.protobuf.Empty> observer) Update a client .. warning:: It is recommended to avoid using this method.
-
Constructor Details
-
AbstractClientsApi
public AbstractClientsApi()
-
-
Method Details
-
listClients
public abstract void listClients(T 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.
-
getClient
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.
-
updateClient
public abstract void updateClient(T 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.
-
getDescriptorForType
public final com.google.protobuf.Descriptors.ServiceDescriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfaceApi<T>
-
getRequestPrototype
public final com.google.protobuf.Message getRequestPrototype(com.google.protobuf.Descriptors.MethodDescriptor method) - Specified by:
getRequestPrototype
in interfaceApi<T>
-
getResponsePrototype
public final com.google.protobuf.Message getResponsePrototype(com.google.protobuf.Descriptors.MethodDescriptor method) - Specified by:
getResponsePrototype
in interfaceApi<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 interfaceApi<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 interfaceApi<T>
-