2 * Copyright (c) 2016 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 package org.openvpp.jvpp.future;
21 import java.util.concurrent.CompletableFuture;
22 import java.util.concurrent.CompletionStage;
23 import org.openvpp.jvpp.JVpp;
24 import org.openvpp.jvpp.dto.ControlPing;
25 import org.openvpp.jvpp.dto.JVppDump;
26 import org.openvpp.jvpp.dto.JVppReply;
27 import org.openvpp.jvpp.dto.JVppReplyDump;
28 import org.openvpp.jvpp.dto.JVppRequest;
31 * Future facade on top of JVpp
33 public final class FutureJVppFacade implements FutureJVpp {
35 private final JVpp jvpp;
40 private final Map<Integer, CompletableFuture<? extends JVppReply<?>>> requests;
42 public FutureJVppFacade(final JVpp jvpp,
43 final Map<Integer, CompletableFuture<? extends JVppReply<?>>> requestMap) {
44 // TODO use guava's preconditions for nonNull and state checks
45 // However adding guava as a dependency requires better build system for Java in VPP project
46 // Currently it's just invocation of javac
48 throw new NullPointerException("Null jvpp");
51 if(requestMap == null) {
52 throw new NullPointerException("Null requestMap");
54 // Request map represents the shared state between this facade and it's callback
55 // where facade puts futures in and callback completes + removes them
56 // TODO what if the call never completes ?
57 this.requests = requestMap;
60 // TODO use Optional in Future, java8
63 @SuppressWarnings("unchecked")
64 public <REQ extends JVppRequest, REPLY extends JVppReply<REQ>> CompletionStage<REPLY> send(REQ req) {
65 synchronized(requests) {
66 final int contextId = jvpp.send(req);
68 final CompletableFuture<REPLY> replyCompletableFuture;
69 if(req instanceof JVppDump) {
70 replyCompletableFuture = (CompletableFuture<REPLY>) new CompletableDumpFuture<>(contextId);
72 replyCompletableFuture = new CompletableFuture<>();
75 requests.put(contextId, replyCompletableFuture);
76 if(req instanceof JVppDump) {
77 requests.put(jvpp.send(new ControlPing()), replyCompletableFuture);
79 return replyCompletableFuture;
83 static final class CompletableDumpFuture<T extends JVppReplyDump<?, ?>> extends CompletableFuture<T> {
84 // TODO make this final
85 // The reason why this is not final is the instantiation of ReplyDump DTOs
86 // Their instantiation must be generated, so currently the DTOs are created in callback and set when first dump reponses
87 // is returned. Because in callback we have method per response, but here where requests are invoked there is only
88 // a single generic send method that does not have enough information to create the DTO
89 // This can be final as soon as we provide specific send methods here
91 private final long contextId;
93 CompletableDumpFuture(final long contextId) {
94 this.contextId = contextId;
105 void setReplyDump(final T replyDump) {
106 this.replyDump = replyDump;