Module org.yamcs.client

Package org.yamcs.client

Class ParameterSubscription

java.lang.Object

org.yamcs.client.base.AbstractSubscription<org.yamcs.protobuf.SubscribeParametersRequest,org.yamcs.protobuf.SubscribeParametersData>

org.yamcs.client.ParameterSubscription

All Implemented Interfaces:

Future<Void>, Subscription<org.yamcs.protobuf.SubscribeParametersRequest,org.yamcs.protobuf.SubscribeParametersData>

public class ParameterSubscription
extends AbstractSubscription<org.yamcs.protobuf.SubscribeParametersRequest,org.yamcs.protobuf.SubscribeParametersData>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ParameterSubscription.Listener

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<ParameterSubscription.Listener>	listeners
protected Map<Integer,org.yamcs.protobuf.Yamcs.NamedObjectId>	mapping

Fields inherited from class org.yamcs.client.base.AbstractSubscription

clientObserver

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ParameterSubscription(org.yamcs.api.MethodHandler methodHandler)

Method Summary

Modifier and Type	Method	Description
void	add(List<org.yamcs.protobuf.Yamcs.NamedObjectId> ids)	Extends the ongoing subscription with the provided identifiers.
void	addListener(ParameterSubscription.Listener listener)
org.yamcs.protobuf.Pvalue.ParameterValue	get(org.yamcs.protobuf.Yamcs.NamedObjectId id)	Get the latest value for a specific parameter.
protected void	processMessage(org.yamcs.protobuf.SubscribeParametersData message)
void	remove(List<org.yamcs.protobuf.Yamcs.NamedObjectId> ids)	Shrinks the ongoing subscription by removing the provided identifiers.

Methods inherited from class org.yamcs.client.base.AbstractSubscription

addMessageListener, awaitConfirmation, awaitConfirmation, cancel, get, get, getConfirmationFuture, isCancelled, isDone, sendMessage

Methods inherited from class java.lang.Object

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

Field Details

listeners

protected Set<ParameterSubscription.Listener> listeners

mapping

protected Map<Integer,org.yamcs.protobuf.Yamcs.NamedObjectId> mapping

Constructor Details

ParameterSubscription

protected ParameterSubscription(org.yamcs.api.MethodHandler methodHandler)

Method Details

processMessage

protected void processMessage(org.yamcs.protobuf.SubscribeParametersData message)

addListener

public void addListener(ParameterSubscription.Listener listener)

get

public org.yamcs.protobuf.Pvalue.ParameterValue get(org.yamcs.protobuf.Yamcs.NamedObjectId id)

Get the latest value for a specific parameter. This method looks for the value from a local cache. It does not contact Yamcs.

add

public void add(List<org.yamcs.protobuf.Yamcs.NamedObjectId> ids)

Extends the ongoing subscription with the provided identifiers.

remove

public void remove(List<org.yamcs.protobuf.Yamcs.NamedObjectId> ids)

Shrinks the ongoing subscription by removing the provided identifiers.