aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjestin2006-07-11 13:56:41 +0000
committerjestin2006-07-11 13:56:41 +0000
commit5acff6b70cee194fbb74df827618169d2e2a6499 (patch)
tree234fc25eca67fadc58378b9c6ddbb9bbb116dc6a
parentc7578c87ce1d91ce79bbcb8c51a5455ff0893318 (diff)
downloadivy-java-5acff6b70cee194fbb74df827618169d2e2a6499.zip
ivy-java-5acff6b70cee194fbb74df827618169d2e2a6499.tar.gz
ivy-java-5acff6b70cee194fbb74df827618169d2e2a6499.tar.bz2
ivy-java-5acff6b70cee194fbb74df827618169d2e2a6499.tar.xz
Il me *faut* modifier la documentation , notamment pour les classes de
messages ... Il faut aussi rajouter des infos sur le protocole qui a été amendé !
-rw-r--r--doc/ivy-java.sgml23
1 files changed, 19 insertions, 4 deletions
diff --git a/doc/ivy-java.sgml b/doc/ivy-java.sgml
index dd8223e..4470c6e 100644
--- a/doc/ivy-java.sgml
+++ b/doc/ivy-java.sgml
@@ -459,7 +459,7 @@ other protocol special characters.
Direct messages is an ivy feature allowing the exchange of information between
two ivy clients. It overrides the subscription mechanism, making the exchange
faster ( there is no regexp matching, etc ). However, this features breaks the
-software bus metaphor, and should be replaced with the relevant bounded
+software bus metaphor, and should be replaced with the relevant bounded.
regexps, at the cost of a small CPU overhead. The full direct message
mechanism in Java has been made available since the ivy-java-1.2.3, but it
won't be much documented, in order to make it harder to use.
@@ -531,10 +531,14 @@ public void removeBindListener(int id)
A <function>IvyBindListener</function> object must implement the following
interface:
<programlisting>
-public void bindPerformed(IvyClient client, int id, String regexp);
-public void unbindPerformed(IvyClient client, int id, String regexp);
+void bindPerformed(IvyClient client, int id, String regexp);
+void unbindPerformed(IvyClient client, int id, String regexp);
</programlisting>
-For a code sample, see the Probe utility source code.
+For a code sample, see the Probe utility source code. Note that if you have
+enabled a filter (message classes), you will be notified the subscriptions
+even if they are considered useless. If you want to check if the regexp has a
+chance to match the message you're sending, use the
+<function>boolean Ivy.CheckRegexp(String regexp)</function>.
</para>
</sect2>
@@ -581,6 +585,10 @@ VY_DEBUG property ( java -DIVY_DEBUG fr.dgac.ivy.tools.Probe is the same as java
fr.dgac.ivy.tools.Probe -d )
</para></listitem>
<listitem><para>
+-c MESSAGECLASS uses a message filter (see Ivy.setFilter()), for example
+'Word1,Word2,Word3'
+</para></listitem>
+<listitem><para>
-h dumps the command line options help.
</para></listitem>
</itemizedlist>
@@ -607,6 +615,13 @@ the numeric id
<listitem><para>
.list gives the list of clients seen on the ivy bus
</para></listitem>
+<listitem><para>
+.bound AGENT lists the regexps the AGENT has subscribed to. You can use .bound
+* to get the whole list.
+</para></listitem>
+<listitem><para>
+.time COUNT MSG sends the MSG COUNT times and displays the elapsed time
+</para></listitem>
</itemizedlist>
</para>
</sect2>