aboutsummaryrefslogtreecommitdiffstats
path: root/vpp-api/java/jvpp/org/openvpp/jvpp/future/FutureJVppInvokerFacade.java
diff options
context:
space:
mode:
Diffstat (limited to 'vpp-api/java/jvpp/org/openvpp/jvpp/future/FutureJVppInvokerFacade.java')
-rw-r--r--vpp-api/java/jvpp/org/openvpp/jvpp/future/FutureJVppInvokerFacade.java111
1 files changed, 111 insertions, 0 deletions
diff --git a/vpp-api/java/jvpp/org/openvpp/jvpp/future/FutureJVppInvokerFacade.java b/vpp-api/java/jvpp/org/openvpp/jvpp/future/FutureJVppInvokerFacade.java
new file mode 100644
index 00000000000..ef8b13c5b01
--- /dev/null
+++ b/vpp-api/java/jvpp/org/openvpp/jvpp/future/FutureJVppInvokerFacade.java
@@ -0,0 +1,111 @@
+/*
+ * 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.concurrent.CompletableFuture;
+import java.util.concurrent.CompletionStage;
+import org.openvpp.jvpp.JVpp;
+import org.openvpp.jvpp.dto.ControlPing;
+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 class FutureJVppInvokerFacade implements FutureJVppInvoker {
+
+ private final JVpp jvpp;
+
+ /**
+ * Guarded by self
+ */
+ private final Map<Integer, CompletableFuture<? extends JVppReply<?>>> requests;
+
+ public FutureJVppInvokerFacade(final JVpp jvpp,
+ final Map<Integer, CompletableFuture<? extends JVppReply<?>>> requestMap) {
+ // TODO use guava's preconditions for nonNull and state checks
+ // However adding guava as a dependency requires better build system for Java in VPP project
+ // Currently it's just invocation of javac
+ if(jvpp == null) {
+ throw new NullPointerException("Null jvpp");
+ }
+ this.jvpp = jvpp;
+ if(requestMap == null) {
+ throw new NullPointerException("Null requestMap");
+ }
+ // Request map represents the shared state between this facade and it's callback
+ // where facade puts futures in and callback completes + removes them
+ // TODO what if the call never completes ?
+ this.requests = requestMap;
+ }
+
+ // TODO use Optional in Future, java8
+
+ @Override
+ @SuppressWarnings("unchecked")
+ public <REQ extends JVppRequest, REPLY extends JVppReply<REQ>> CompletionStage<REPLY> send(REQ req) {
+ synchronized(requests) {
+ final int contextId = jvpp.send(req);
+
+ final CompletableFuture<REPLY> replyCompletableFuture;
+ if(req instanceof JVppDump) {
+ replyCompletableFuture = (CompletableFuture<REPLY>) new CompletableDumpFuture<>(contextId);
+ } else {
+ replyCompletableFuture = new CompletableFuture<>();
+ }
+
+ requests.put(contextId, replyCompletableFuture);
+ if(req instanceof JVppDump) {
+ requests.put(jvpp.send(new ControlPing()), replyCompletableFuture);
+ }
+ return replyCompletableFuture;
+ }
+ }
+
+ static final class CompletableDumpFuture<T extends JVppReplyDump<?, ?>> extends CompletableFuture<T> {
+ // The reason why this is not final is the instantiation of ReplyDump DTOs
+ // Their instantiation must be generated, so currently the DTOs are created in callback and set when first dump reponses
+ // is handled in the callback.
+ private T replyDump;
+ private final long contextId;
+
+ CompletableDumpFuture(final long contextId) {
+ this.contextId = contextId;
+ }
+
+ long getContextId() {
+ return contextId;
+ }
+
+ T getReplyDump() {
+ return replyDump;
+ }
+
+ void setReplyDump(final T replyDump) {
+ this.replyDump = replyDump;
+ }
+ }
+
+ @Override
+ public void close() throws Exception {
+ // NOOP
+ }
+}