From 5a5f5aac91426d97eccfa353b5ebbe99d09f2e3f Mon Sep 17 00:00:00 2001 From: Marek Gradzki Date: Wed, 17 Aug 2016 12:33:50 +0200 Subject: VPP-205: documentation update Change-Id: I98e5bdbd0472c2973885defe2712b53d9da8a536 Signed-off-by: Marek Gradzki --- vpp-api/java/jvpp-registry/org/openvpp/jvpp/JVppRegistry.java | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'vpp-api/java/jvpp-registry') diff --git a/vpp-api/java/jvpp-registry/org/openvpp/jvpp/JVppRegistry.java b/vpp-api/java/jvpp-registry/org/openvpp/jvpp/JVppRegistry.java index c25b6536bb1..4515bb3fc20 100644 --- a/vpp-api/java/jvpp-registry/org/openvpp/jvpp/JVppRegistry.java +++ b/vpp-api/java/jvpp-registry/org/openvpp/jvpp/JVppRegistry.java @@ -62,8 +62,15 @@ public interface JVppRegistry extends AutoCloseable { /** * Sends control ping. Reply handler calls callback registered for give plugin. * + * Control ping is used for initial RX thread to Java thread attachment + * that takes place in the plugin's JNI lib + * and to wrap dump message replies in one list. + * + * VPP plugins don't have to provide special control ping, therefore + * it is necessary to providing control ping support in JVppRegistry. + * @param clazz identifies plugin that should receive ping callback - * @return unique identifer of message in message queue + * @return unique identifier of message in message queue */ int controlPing(final Class clazz) throws VppInvocationException; } -- cgit 1.2.3-korg