org.yamcs.sle.OfflineTmSleLink Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yamcs-sle Show documentation

Data links for connecting Yamcs to SLE (Space Link Extension) providers such as Ground Stations

There is a newer version: 1.6.0

package org.yamcs.sle;

import java.util.concurrent.CompletableFuture;
import java.util.concurrent.LinkedBlockingQueue;

import org.yamcs.ConfigurationException;
import org.yamcs.YConfiguration;
import org.yamcs.sle.CcsdsTime;
import org.yamcs.sle.Constants.DeliveryMode;
import org.yamcs.sle.user.RafServiceUserHandler;
import org.yamcs.sle.user.RcfServiceUserHandler;

/**
 * Receives TM frames via SLE. The Virtual Channel configuration is identical with the configuration of
 * {@link OfflineTmSleLink}.
 * 
 * The SLE specific settings are loaded from sle.yaml based on the sleProvider key specified in the link configuration.
 * The description of the sle.yaml configuration parameters are as follows:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * initiatorId identifier of the local application
responderPortId Responder Port Identifier
serviceInstance Used in the bind request to select the instance number of the remote service.This number together with the
 * deliverymode specify the so called service name identifier (raf=onltX where X is the number)
versionNumber the version number is sent in the bind invocation. We only support the version of the SLE valid in April-2019;
 * however this field is not checked. 
myUsername username that is passed in outgoing SLE messages. A corresponding password has to be specified (in hexadecimal)
 * in the security.yaml file.
peerUsername username that is used to verify the incoming SLE messages. A corresponding password has to be specified (in
 * hexadecimal) in the security.yaml file.
authLevel one of NONE, BIND or ALL - it configures which incoming and outgoing PDUs contain authentication
 * information.
 * 
 * 
 * @author nm
 *
 */
public class OfflineTmSleLink extends AbstractTmSleLink {
    RacfSleMonitor sleMonitor = new MyMonitor();

    LinkedBlockingQueue requestQueue = new LinkedBlockingQueue<>();

    
    public void init(String instance, String name, YConfiguration config) throws ConfigurationException {
        super.init(instance, name, config, DeliveryMode.rtnOffline);
        reconnectionIntervalSec = -1;
    }

    @Override
    protected void doStart() {
        notifyStarted();
    }

    @Override
    protected void doStop() {
        if (rsuh != null) {
            rsuh.shutdown();
            rsuh = null;
        }
        notifyStopped();
    }

    void sleStart() {
        RequestRange rr = requestQueue.poll();
        if (rr == null) {
            eventProducer.sendInfo("All requests finished, disconnecting from SLE");
            rsuh.shutdown();
            rsuh = null;
        } else {
            eventProducer.sendInfo("Starting an offline request for interval "+rr);
            CompletableFuture cf;
            if(gvcid==null) {
               cf = ((RafServiceUserHandler)rsuh).start(rr.start, rr.stop);  
            } else {
                cf = ((RcfServiceUserHandler)rsuh).start(rr.start, rr.stop, gvcid);
            }
            cf.handle((v, t) -> {
                if (t != null) {
                    eventProducer.sendWarning("Request for interval "+rr+" failed: "+t );
                    //we can do nothing about it, try maybe there is a new request
                    sleStart();
                    return null;
                }
                return null;
            });
        }
    }

    @Override
    protected void doDisable() {
        if (rsuh != null) {
            rsuh.shutdown();
            rsuh = null;
        }
    }

    @Override
    protected void doEnable() throws Exception {
        if (!requestQueue.isEmpty()) {
            connect();
        }
    }

    @Override
    public void onEndOfData() {
        eventProducer.sendInfo("SLE end of data received");
        rsuh.stop().handle((v, t) -> {
            if (t != null) {
                eventProducer.sendWarning("Failed to stop: " + t.getMessage());
                return null;
            }
            sleStart();
            return null;
        });
    }

    public synchronized void addRequest(CcsdsTime start, CcsdsTime stop) {
        requestQueue.add(new RequestRange(start, stop));
        if (rsuh == null) {
            connect();
        }
    }

    static class RequestRange {
        CcsdsTime start;
        CcsdsTime stop;
        
        public RequestRange(CcsdsTime start, CcsdsTime stop) {
            this.start = start;
            this.stop = stop;
        }
        
        @Override
        public String toString() {
            return "["+start + ", "+ stop + "]";
        }
    }
}

initiatorId	identifier of the local application
responderPortId	Responder Port Identifier
serviceInstance	Used in the bind request to select the instance number of the remote service.This number together with the * deliverymode specify the so called service name identifier (raf=onltX where X is the number)
versionNumber	the version number is sent in the bind invocation. We only support the version of the SLE valid in April-2019; * however this field is not checked.
myUsername	username that is passed in outgoing SLE messages. A corresponding password has to be specified (in hexadecimal) * in the security.yaml file.
peerUsername	username that is used to verify the incoming SLE messages. A corresponding password has to be specified (in * hexadecimal) in the security.yaml file.
authLevel	one of NONE, BIND or ALL - it configures which incoming and outgoing PDUs contain authentication * information.