vpp/vpp-api/java/jvpp-registry/org/openvpp/jvpp/future/AbstractFutureJVppInvoker.java

/*
 * Copyright (c) 2016 Cisco and/or its affiliates.
 *
 * 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.openvpp.jvpp.future;


import java.util.Map;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionStage;
import org.openvpp.jvpp.JVpp;
import org.openvpp.jvpp.JVppRegistry;
import org.openvpp.jvpp.VppInvocationException;
import org.openvpp.jvpp.dto.JVppDump;
import org.openvpp.jvpp.dto.JVppReply;
import org.openvpp.jvpp.dto.JVppReplyDump;
import org.openvpp.jvpp.dto.JVppRequest;

/**
 * Future facade on top of JVpp
 */
public abstract class AbstractFutureJVppInvoker implements FutureJVppInvoker {

    private final JVpp jvpp;
    private final JVppRegistry registry;

    /**
     * Guarded by self
     */
    private final Map<Integer, CompletableFuture<? extends JVppReply<?>>> requests;

    protected AbstractFutureJVppInvoker(final JVpp jvpp, final JVppRegistry registry,
                                        final Map<Integer, CompletableFuture<? extends JVppReply<?>>> requestMap) {
        this.jvpp =  Objects.requireNonNull(jvpp, "jvpp should not be null");
        this.registry =  Objects.requireNonNull(registry, "registry should not be null");
        // Request map represents the shared state between this facade and it's callback
        // where facade puts futures in and callback completes + removes them
        this.requests = Objects.requireNonNull(requestMap, "Null requestMap");
    }

    protected final Map<Integer, CompletableFuture<? extends JVppReply<?>>> getRequests() {
        return this.requests;
    }

    // TODO use Optional in Future, java8

    @Override
    @SuppressWarnings("unchecked")
    public <REQ extends JVppRequest, REPLY extends JVppReply<REQ>> CompletionStage<REPLY> send(REQ req) {
        synchronized(requests) {
            try {
                final CompletableFuture<REPLY> replyCompletableFuture;
                final int contextId = jvpp.send(req);

                if(req instanceof JVppDump) {
                    throw new IllegalArgumentException("Send with empty reply dump has to be used in case of dump calls");
                }
                replyCompletableFuture = new CompletableFuture<>();
                requests.put(contextId, replyCompletableFuture);

                // TODO in case of timeouts/missing replies, requests from the map are not removed
                // consider adding cancel method, that would remove requests from the map and cancel
                // associated replyCompletableFuture

                return replyCompletableFuture;
            } catch (VppInvocationException ex) {
                final CompletableFuture<REPLY> replyCompletableFuture = new CompletableFuture<>();
                replyCompletableFuture.completeExceptionally(ex);
                return replyCompletableFuture;
            }
        }
    }

    @Override
    @SuppressWarnings("unchecked")
    public <REQ extends JVppRequest, REPLY extends JVppReply<REQ>, DUMP extends JVppReplyDump<REQ, REPLY>> CompletionStage<DUMP> send(
            REQ req, DUMP emptyReplyDump) {
        synchronized(requests) {
            try {
                final CompletableDumpFuture<DUMP> replyCompletableFuture;
                final int contextId = jvpp.send(req);

                if(!(req instanceof JVppDump)) {
                    throw new IllegalArgumentException("Send without empty reply dump has to be used in case of regular calls");
                }
                replyCompletableFuture = new CompletableDumpFuture<>(contextId, emptyReplyDump);

                requests.put(contextId, replyCompletableFuture);
                requests.put(registry.controlPing(jvpp.getClass()), replyCompletableFuture);

                // TODO in case of timeouts/missing replies, requests from the map are not removed
                // consider adding cancel method, that would remove requests from the map and cancel
                // associated replyCompletableFuture

                return replyCompletableFuture;
            } catch (VppInvocationException ex) {
                final CompletableFuture<DUMP> replyCompletableFuture = new CompletableFuture<>();
                replyCompletableFuture.completeExceptionally(ex);
                return replyCompletableFuture;
            }
        }
    }

    public static final class CompletableDumpFuture<T extends JVppReplyDump<?, ?>> extends CompletableFuture<T> {
        private final T replyDump;
        private final long contextId;

        public CompletableDumpFuture(final long contextId, final T emptyDump) {
            this.contextId = contextId;
            this.replyDump = emptyDump;
        }

        public long getContextId() {
            return contextId;
        }

        public T getReplyDump() {
            return replyDump;
        }
    }

    @Override
    public void close() throws Exception {
        jvpp.close();
    }
}