org.yamcs.client.ParameterSubscription Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-client Show documentation
There is a newer version: 5.10.8
package org.yamcs.client;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArraySet;

import org.yamcs.api.MethodHandler;
import org.yamcs.client.base.AbstractSubscription;
import org.yamcs.protobuf.Pvalue.ParameterValue;
import org.yamcs.protobuf.SubscribeParametersData;
import org.yamcs.protobuf.SubscribeParametersRequest;
import org.yamcs.protobuf.SubscribeParametersRequest.Action;
import org.yamcs.protobuf.Yamcs.NamedObjectId;

public class ParameterSubscription extends AbstractSubscription {

    protected Set listeners = new CopyOnWriteArraySet<>();

    private Map latestValues = new ConcurrentHashMap<>();

    // Maps server-assigned numeric ids against the request identifiers
    protected Map mapping = new ConcurrentHashMap<>();

    protected ParameterSubscription(MethodHandler methodHandler) {
        super(methodHandler, "parameters", SubscribeParametersData.class);
        addMessageListener(this::processMessage);
    }

    protected void processMessage(SubscribeParametersData message) {
        mapping.putAll(message.getMappingMap());

        for (NamedObjectId id : message.getInvalidList()) {
            listeners.forEach(l -> l.onInvalidIdentification(id));
        }

        List values = new ArrayList<>(message.getValuesCount());
        for (ParameterValue incomingValue : message.getValuesList()) {
            NamedObjectId id = mapping.get(incomingValue.getNumericId());
            ParameterValue value = ParameterValue.newBuilder(incomingValue).setId(id).build();
            values.add(value);
            latestValues.put(id, value);
        }

        if (!values.isEmpty()) {
            listeners.forEach(l -> l.onData(values));
        }
    }

    public void addListener(Listener listener) {
        listeners.add(listener);
    }

    /**
     * Get the latest value for a specific parameter. This method looks for the value from a local cache. It does not
     * contact Yamcs.
     */
    public ParameterValue get(NamedObjectId id) {
        return latestValues.get(id);
    }

    /**
     * Extends the ongoing subscription with the provided identifiers.
     */
    public void add(List ids) {
        if (!ids.isEmpty()) {
            clientObserver.next(SubscribeParametersRequest.newBuilder()
                    .setAction(Action.ADD)
                    .setAbortOnInvalid(false)
                    .addAllId(ids)
                    .build());
        }
    }

    /**
     * Shrinks the ongoing subscription by removing the provided identifiers.
     */
    public void remove(List ids) {
        if (!ids.isEmpty()) {
            clientObserver.next(SubscribeParametersRequest.newBuilder()
                    .setAction(Action.REMOVE)
                    .setAbortOnInvalid(false)
                    .addAllId(ids)
                    .build());
        }
    }

    @FunctionalInterface
    public static interface Listener {

        void onData(List values);

        default void onInvalidIdentification(NamedObjectId id) {
        }
    }
}