summaryrefslogtreecommitdiffstats
path: root/java/jvpp-registry/io/fd/jvpp/JVpp.java
diff options
context:
space:
mode:
authorMichal Cmarada <mcmarada@cisco.com>2019-02-28 10:21:59 +0100
committerMichal Cmarada <mcmarada@cisco.com>2019-03-04 11:11:16 +0100
commit2388db4347cf0c4a1032cb945db2fdb1011d74d7 (patch)
tree3eb778d84464edc9bd49d1f0f895232944477ea8 /java/jvpp-registry/io/fd/jvpp/JVpp.java
parent2fc03523c64803826e74ce0af42880f65f60a107 (diff)
Update package names
updating package names from io.fd.vpp.jvpp* to io.fd.jvpp* Change-Id: Ia1634db8f0875ff6ecfeddc281041cd49c4aacc2 Signed-off-by: Michal Cmarada <mcmarada@cisco.com>
Diffstat (limited to 'java/jvpp-registry/io/fd/jvpp/JVpp.java')
-rw-r--r--java/jvpp-registry/io/fd/jvpp/JVpp.java56
1 files changed, 56 insertions, 0 deletions
diff --git a/java/jvpp-registry/io/fd/jvpp/JVpp.java b/java/jvpp-registry/io/fd/jvpp/JVpp.java
new file mode 100644
index 0000000..251b0a7
--- /dev/null
+++ b/java/jvpp-registry/io/fd/jvpp/JVpp.java
@@ -0,0 +1,56 @@
+/*
+ * 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 io.fd.jvpp;
+
+import io.fd.jvpp.callback.JVppCallback;
+import io.fd.jvpp.dto.ControlPing;
+import io.fd.jvpp.dto.JVppRequest;
+
+/**
+ * Base interface for plugin's Java API.
+ */
+public interface JVpp extends AutoCloseable {
+
+ /**
+ * Sends request to vpp.
+ *
+ * @param request request to be sent
+ * @return unique identifer of message in message queue
+ * @throws VppInvocationException when message could not be sent
+ */
+ int send(final JVppRequest request) throws VppInvocationException;
+
+ /**
+ * Initializes plugin's Java API.
+ *
+ * @param registry plugin registry
+ * @param callback called by vpe.api message handlers
+ * @param queueAddress address of vpp shared memory queue
+ * @param clientIndex vpp client identifier
+ */
+ void init(final JVppRegistry registry, final JVppCallback callback, final long queueAddress,
+ final int clientIndex);
+
+ /**
+ * Sends control_ping message.
+ *
+ * @param controlPing request DTO
+ * @return unique identifer of message in message queue
+ * @throws VppInvocationException when message could not be sent
+ */
+ int controlPing(final ControlPing controlPing) throws VppInvocationException;
+}