diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ivy-java.sgml | 21 | ||||
| -rw-r--r-- | doc/jprobe.1 | 2 |
2 files changed, 22 insertions, 1 deletions
diff --git a/doc/ivy-java.sgml b/doc/ivy-java.sgml index 92fe115..0e4d233 100644 --- a/doc/ivy-java.sgml +++ b/doc/ivy-java.sgml @@ -38,7 +38,7 @@ <para> This document is a programmer's guide that describes how to use the Ivy Java library to connect applications to an Ivy bus. This guide describes -version 1.2.10 of the library. This document itself is part of the Java +version 1.2.12 of the library. This document itself is part of the Java package, available on the <ulink url="http://www.tls.cena.fr/products/ivy/">Ivy web site</ulink>. </para> @@ -558,6 +558,23 @@ chance to match the message you're sending, use the </para> </sect2> +<sect2><title>Monitoring the bus</title> +<para> +When in doubt, to check if the remote client is still responding, instead of +relying on a callback, you can test the response of the protocol parsing +thread. Use following method: +<programlisting> +Ivyclient.ping(PingCallback pc); +</programlisting> +It will send a ping token that will (hopefully) be parsed by the remote agent, +and will trigger the following message with the elapsed time in milliseconds: +<programlisting> +void PingCallback.pongReceived(IvyClient ic,int elapsedTime); +</programlisting> +An example is provided in fr.dgac.ivy.tools.Probe. +</para> +</sect2> + <sect2><title>Message classes</title> <para> When your Ivy bus is populated with many agents, the cost of pattern matching @@ -683,6 +700,8 @@ the numeric id <listitem><para> .time COUNT MSG sends the MSG COUNT times and displays the elapsed time </para></listitem> +<listitem><para> +.ping CLIENT measures the time it takes to reach a client </itemizedlist> </para> </sect2> diff --git a/doc/jprobe.1 b/doc/jprobe.1 index e4d8da0..e5a3d2d 100644 --- a/doc/jprobe.1 +++ b/doc/jprobe.1 @@ -69,6 +69,8 @@ issue a command to jprobe, use one of the following commands: \.where CLIENT displays the host where a client runs .nf \.time COUNT MESSAGE measures the time it takes to send COUNT messages +.nf + \.ping CLIENT measures the roundrip time in milliseconds to a client .SH "EXAMPLES" .nf |