protocols/gnoi/api/src/main/java/org/onosproject/gnoi/api/GnoiClient.java

/*
 * Copyright 2019-present Open Networking Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.onosproject.gnoi.api;

import gnoi.system.SystemOuterClass.TimeResponse;
import gnoi.system.SystemOuterClass.RebootRequest;
import gnoi.system.SystemOuterClass.RebootResponse;
import gnoi.system.SystemOuterClass.SetPackageRequest;
import gnoi.system.SystemOuterClass.SetPackageResponse;
import gnoi.system.SystemOuterClass.SwitchControlProcessorRequest;
import gnoi.system.SystemOuterClass.SwitchControlProcessorResponse;
import com.google.common.annotations.Beta;
import org.onosproject.grpc.api.GrpcClient;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.SynchronousQueue;

/**
 * Client to control a gNOI server.
 */
@Beta
public interface GnoiClient extends GrpcClient {

    /**
     * Returns the current time on the target.
     *
     * @return the TimeResponse result
     */
    CompletableFuture<TimeResponse> time();

    /**
     * Causes the target to reboot immediately.
     *
     * @param request RebootRequest
     * @return the RebootResponse result
     */
    CompletableFuture<RebootResponse> reboot(RebootRequest request);

    /**
     * Executes a SetPackage RPC for the given list
     * of SetPackageRequest messages.
     *
     * @param stream list of SetPackageRequests.
     * @return SetPackageResponse from device.
     */
    CompletableFuture<SetPackageResponse> setPackage(SynchronousQueue<SetPackageRequest> stream);

     /**
     * Executes a SwitchControlProcessor RPC given the path
     * to the new software agent.
     *
     * @param request SwitchControlProcessorRequest
     * @return SwitchControlProcessorResponse from device.
     */
    CompletableFuture<SwitchControlProcessorResponse> switchControlProcessor(SwitchControlProcessorRequest request);

}