Package org.yamcs.client.base

Class AbstractSubscription<C extends com.google.protobuf.Message,S extends com.google.protobuf.Message>

java.lang.Object

org.yamcs.client.base.AbstractSubscription<C,S>

All Implemented Interfaces:

Future<Void>, Subscription<C,S>

Direct Known Subclasses:

AlarmSubscription, ClearanceSubscription, CommandSubscription, EventSubscription, GlobalAlarmStatusSubscription, LinkSubscription, PacketSubscription, ParameterSubscription, ProcessorSubscription, QueueEventSubscription, QueueStatisticsSubscription, TimeSubscription

public abstract class AbstractSubscription<C extends com.google.protobuf.Message,S extends com.google.protobuf.Message>
extends Object
implements Subscription<C,S>

Default base class for a Subscription.

This is designed such that most subclasses need only to provide type information. More advanced subscription subclasses may want to add custom functionality such as call-specific message processing.

Field Summary

Fields

Modifier and Type	Field	Description
protected Observer<C>	clientObserver

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSubscription(MethodHandler methodHandler, String topic, Class<S> responseClass)

Method Summary

Modifier and Type	Method	Description
void	addMessageListener(MessageListener<S> listener)	Get updated on received server messages.
void	awaitConfirmation()	Waits until the server has confirmed the call for this subscription.
void	awaitConfirmation(long timeout, TimeUnit unit)	Waits until the server has confirmed the call for this subscription.
boolean	cancel(boolean mayInterruptIfRunning)	Cancel this subscription.
Void	get()
Void	get(long timeout, TimeUnit unit)
CompletableFuture<Void>	getConfirmationFuture()
boolean	isCancelled()
boolean	isDone()
void	sendMessage(C message)	Send a message (typically a subscription request) to Yamcs

Methods inherited from class java.lang.Object

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

Field Detail

clientObserver

protected Observer<C extends com.google.protobuf.Message> clientObserver

Constructor Detail

AbstractSubscription

protected AbstractSubscription(MethodHandler methodHandler,
                               String topic,
                               Class<S> responseClass)

Method Detail

sendMessage

public void sendMessage(C message)

Send a message (typically a subscription request) to Yamcs

Specified by:

sendMessage in interface Subscription<C extends com.google.protobuf.Message,S extends com.google.protobuf.Message>

addMessageListener

public void addMessageListener(MessageListener<S> listener)

Get updated on received server messages.

Specified by:

addMessageListener in interface Subscription<C extends com.google.protobuf.Message,S extends com.google.protobuf.Message>

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Cancel this subscription. After this method is called, you will no longer receive any messages from it.

Specified by:

cancel in interface Future<C extends com.google.protobuf.Message>

getConfirmationFuture

public CompletableFuture<Void> getConfirmationFuture()

awaitConfirmation

public void awaitConfirmation()
                       throws InterruptedException,
                              ExecutionException

Waits until the server has confirmed the call for this subscription. Only the first client message of a call is confirmed.

Throws:

InterruptedException

ExecutionException

awaitConfirmation

public void awaitConfirmation(long timeout,
                              TimeUnit unit)
                       throws InterruptedException,
                              ExecutionException,
                              TimeoutException

Waits until the server has confirmed the call for this subscription. Only the first client message of a call is confirmed.

Throws:

InterruptedException

ExecutionException

TimeoutException

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<C extends com.google.protobuf.Message>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<C extends com.google.protobuf.Message>

get

public Void get()
         throws InterruptedException,
                ExecutionException

Specified by:

get in interface Future<C extends com.google.protobuf.Message>

Throws:

InterruptedException

ExecutionException

get

public Void get(long timeout,
                TimeUnit unit)
         throws InterruptedException,
                ExecutionException,
                TimeoutException

Specified by:

get in interface Future<C extends com.google.protobuf.Message>

Throws:

InterruptedException

ExecutionException

TimeoutException