docs: change code blocks from "shell" to "console"
[vpp.git] / extras / japi / java / jvpp-core / io / fd / vpp / jvpp / core / examples / Readme.txt
1 This package contains basic examples for jvpp. To run the examples:
2
3 - Make sure VPP is running
4 - From VPP's build-root/ folder execute:
5   - release version: sudo java -cp build-vpp-native/vpp/vpp-api/java/jvpp-registry-18.01.jar:build-vpp-native/vpp/vpp-api/java/jvpp-core-18.01.jar io.fd.vpp.jvpp.core.examples.[test name]
6   - debug version: sudo java -cp build-vpp_debug-native/vpp/vpp-api/java/jvpp-registry-18.01.jar:build-vpp_debug-native/vpp/vpp-api/java/jvpp-core-18.01.jar io.fd.vpp.jvpp.core.examples.[test name]
7
8 Available examples:
9 CallbackApiExample - Similar to ControlPingTest, invokes more complex calls (e.g. interface dump) using low level JVpp APIs
10 CallbackJVppFacadeNotificationExample - Example of interface notifications using Callback based JVpp facade
11 CallbackJVppFacadeExample - Execution of more complex calls using Callback based JVpp facade
12 CallbackNotificationApiExample -  Example of interface notifications using low level JVpp APIs
13 CreateSubInterfaceExample - Example of sub-interface creation
14 FutureApiNotificationExample - Example of interface notifications using Future based JVpp facade
15 FutureApiExample - Execution of more complex calls using Future based JVpp facade
16 L2AclExample - Example of L2 ACL creation
17 LispAdjacencyExample - Example of lisp adjacency creation and read (custom vpe.api type support showcase)
18
19 CallbackApiReadPerfTest, FutureApiReadPerfTest, CallbackApiWritePerfTest - test provide two ways to count invocations:
20 1) maximum number of invocations and received replyies within 1 sec
21 sudo java -cp build-vpp-native/vpp/vpp-api/java/jvpp-registry-18.01.jar:build-vpp-native/vpp/vpp-api/java/jvpp-core-18.01.jar io.fd.vpp.jvpp.core.examples.[test name]
22 2) measure time in ns from first request to receiving last reply over set amount of requests
23 sudo java -cp build-vpp-native/vpp/vpp-api/java/jvpp-registry-18.01.jar:build-vpp-native/vpp/vpp-api/java/jvpp-core-18.01.jar io.fd.vpp.jvpp.core.examples.[test name] [number of request to send]
24