diff options
| author |   Marek Gradzki <mgradzki@cisco.com> | 2016-08-17 12:33:50 +0200 |
|---|---|---|
| committer | Marek Gradzki <mgradzki@cisco.com> | 2016-08-17 15:20:20 +0200 |
| commit | 5a5f5aac91426d97eccfa353b5ebbe99d09f2e3f (patch) | |
| tree | 81c0d51a5a9066eb6aff02b6f40021a627941cda /vpp-api/java/jvpp-registry/org/openvpp | |
| parent | 220beac0310b2e8496628cc4037dd707c5ffce72 (diff) | |
VPP-205: documentation update
Change-Id: I98e5bdbd0472c2973885defe2712b53d9da8a536
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
Diffstat (limited to 'vpp-api/java/jvpp-registry/org/openvpp')
| -rw-r--r-- | vpp-api/java/jvpp-registry/org/openvpp/jvpp/JVppRegistry.java | 9 |
1 files changed, 8 insertions, 1 deletions
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<? extends JVpp> clazz) throws VppInvocationException; } |