org.yamcs.protobuf.Cop1ApiClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.9
package org.yamcs.protobuf;

import com.google.protobuf.Empty;
import org.yamcs.api.MethodHandler;
import org.yamcs.api.Observer;

/**
 *  *  Methods for virtual channel TC links that have ``useCop1: true``.
 *  This service contains methods for setting/getting the configuration and
 *  performing various operations.
 *  In addition, a websocket subscription is available that will allow receiving periodically the status.
 * 
 */
@javax.annotation.processing.Generated(value = "org.yamcs.maven.ServiceGenerator", date = "2025-02-13T11:12:59.906892338Z")
public class Cop1ApiClient extends AbstractCop1Api {

    private final MethodHandler handler;

    public Cop1ApiClient(MethodHandler handler) {
        this.handler = handler;
    }

    /**
     *      *  Initialize COP-1 in case state is UNITIALIZED
     * 
     */
    @Override
    public final void initialize(Void ctx, InitializeRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(0),
            request,
            Empty.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Resume COP-1 operation in case state is SUSPENDED
     * 
     */
    @Override
    public final void resume(Void ctx, ResumeRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(1),
            request,
            Empty.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Disable COP-1 operation
     * 
     *  This causes the sent queue to be purged.
     *  All TCs from the wait queue, as well as newly received TCs
     *  are sent immediately
     * 
     */
    @Override
    public final void disable(Void ctx, DisableRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(2),
            request,
            Empty.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Update configuration settings
     * 
     */
    @Override
    public final void updateConfig(Void ctx, UpdateConfigRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(3),
            request,
            Cop1Config.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get COP-1 configuration
     * 
     */
    @Override
    public final void getConfig(Void ctx, GetConfigRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(4),
            request,
            Cop1Config.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get COP-1 status
     * 
     */
    @Override
    public final void getStatus(Void ctx, GetStatusRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(5),
            request,
            Cop1Status.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Receive COP-1 status updates
     * 
     */
    @Override
    public final void subscribeStatus(Void ctx, SubscribeStatusRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(6),
            request,
            Cop1Status.getDefaultInstance(),
            observer);
    }
}