diff options
Diffstat (limited to 'doc/ivy-java.sgml')
| -rw-r--r-- | doc/ivy-java.sgml | 31 |
1 files changed, 15 insertions, 16 deletions
diff --git a/doc/ivy-java.sgml b/doc/ivy-java.sgml index fb94b29..406de91 100644 --- a/doc/ivy-java.sgml +++ b/doc/ivy-java.sgml @@ -32,9 +32,9 @@ <abstract> <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.13 of the library. This document itself is part - of the Java package, available on the <link xlink:href="http://www2.tls.cena.fr/products/ivy/">Ivy web site</link>, and - on the <link xlink:href="http://www.lii-enac.fr/~jestin/ivy-java/">maintainer's + describes version 1.2.17 of the library. This document itself is part + of the Java package, available on the <link xlink:href="http://www.eei.cena.fr/products/ivy/">Ivy web site</link>, and + on the <link xlink:href="http://www.lii-enac.fr/~jestin/">maintainer's web page</link>.</para> </abstract> </info> @@ -50,7 +50,7 @@ incomplete, is quite ugly. </para></sect1> <sect1> <title>What is Ivy?</title> <para> -Ivy is a software bus initially initially designed at <link xlink:href="http://www.cena.fr/">CENA</link>. A software bus is a system that +Ivy is a software bus initially initially designed at CENA. A software bus is a system that allows software applications to exchange information with the illusion of broadcasting that information, selection being performed by the receiving applications. Using a software bus is very similar to dealing with events in a @@ -74,7 +74,7 @@ if you are more interested in other languages, refer to other guides such as <citetitle>The Ivy Perl library guide</citetitle> (not yet written), or <citetitle>The Ivy C library guide</citetitle> - . All those documents should be available from <link xlink:href="http://www2.tls.cena.fr/products/ivy/">the Ivy Web site </link> + . All those documents should be available from <link xlink:href="http://www.eei.cena.fr/products/ivy/">the Ivy Web site </link> . </para> </sect1> @@ -87,20 +87,19 @@ The Ivy Java library (aka fr.dgac.ivy) is a Java package that allows you to connect applications to an Ivy bus. You can also use it to connect any Java application to an Ivy bus. So far, this library has been tested and used on a variety of -Java virtual machines (from 1.1.7 to 1.6.0), a variety of vendors (kaffe+gcj, -sun jdk, blackdown) and on a variety of architectures (GNU/Linux, Solaris, -Windows NT,XP,2000, MacOSX). It used to be developped and maintained on a Debian -GNU/Linux ox, but the maintainer got lazy, and enjoys a MacOSX snow leopard powered macbook. +Java virtual machines (from 1.1.7 to 1.8), a variety of vendors (kaffe+gcj, +sun jdk, blackdown, apple, and now oracle) and on a variety of architectures (GNU/Linux, Windows, MacOSX). It used to be developped and maintained on a Debian +GNU/Linux os, but the maintainer got lazy, and enjoys a MacOSX powered ultimate development machine. </para> <para> The Ivy Java library was originally developed by François-Régis Colin and Yannick Jestin within a group at CENA (Toulouse, France). It is now maintained -by Yannick. +by Yannick and contributors. </para> </sect2> <sect2> <title>Getting and installing the Ivy Java library</title> - <para>You can get the latest versions of the Ivy Java library from <link xlink:href="http://www.tls.cena.fr/products/ivy/">the Ivy web site</link>. It is packaged either as a jar file or as a debian package. We plan to package it according to different distribution formats, such as .msi (Windows) .deb or .rpm package (Debian, Redhat and Mandrake linux). Contributors are welcome for package management.</para> + <para>You can get the latest versions of the Ivy Java library from <link xlink:href="http://www.eei.cena.fr/products/ivy/">the Ivy web site</link>. It is packaged either as a jar file or as a debian package. We used to package it according to different distribution formats, such as .msi (Windows) .deb or .rpm packages, but due to the essence of Java programming, the jar file should be self sufficient.</para> <para>For most people, the simplest way is to install the ivy-java.jar jar file, containing both ivy java and its @@ -115,7 +114,7 @@ by Yannick. </itemizedlist> </para> <para> -The numbered packages (ivy-1.2.14.jar ivy-1.2.14.tar.gz) also contain documentation, sources code alongside with examples and a small set of tools (IvyDaemon, jprobe, jafter). You may need to install the <link xlink:href="http://www.urbanophile.com/arenn/coding/download.html">gnu getopt library</link>, included in the jar file but not in the debian package. +The numbered jar files (ivy-1.2.17.jar) also contain documentation, sources code alongside with examples and a small set of tools (IvyDaemon, jprobe, jafter). You may need to install the <link xlink:href="http://www.urbanophile.com/arenn/coding/download.html">gnu getopt library</link>, included in the jar file but not in the debian package. </para> <para> In order to test the presence of Ivy jar on your system once installed, run the following command: @@ -245,7 +244,7 @@ $ <sect1> <title>Basic functions</title> <para> -The javadoc generated files are available on line on the ivy web site, and should be included in your ivy-1.2.14.jar java package (or in /usr/share/doc/libivy-java, alongside with this very manual, if you used a debian package). Here are more details on those functions. +The javadoc generated files are available on line on the ivy web site, and should be included in your ivy-1.2.17.jar java package (or in /usr/share/doc/libivy-java, alongside with this very manual, if you used a debian package). Here are more details on those functions. </para> <sect2> <title>Initialization an Ivy object and joining the bus</title> @@ -393,7 +392,7 @@ bindMsg("^a*(.*)c*$", new IvyMessageListener() { The processing of the ivy protocol and the execution of the callback are performed within an unique thread per remote client. Thus, the callback will be performed sequentially. If you want an asynchronous handling of callbacks, -see in the advanced functions. +see in the advanced functions. In order to understand the heavily threaded model of a java Ivy agent, feel free to use jvisualvm to see the spawning of threads. </para> </sect2> @@ -502,7 +501,7 @@ won't be much documented, in order to make it harder to use. Swing requires the code to run in the main swing thread. In order to avoid problems, be sure tu use the SwingUtilities.invokeLater() or SwingUtilities.invokeAndWait() methods if you Ivy callbacks impact swing -components. +components. You can also use the new BindType.SWING api. </para> </sect2> <sect2> @@ -1004,7 +1003,7 @@ public class EndApp extends IvyApplicationAdapter { For bug reports or comments on the library itself or about this document, please me an email at <email>yannick.jestin@enac.fr</email> . For comments and ideas about Ivy itself (protocol, applications, etc), please join and use the -<link xlink:href="http://www.tls.cena.fr/products/ivy/contact.html">Ivy mailing list</link> +<link xlink:href="http://www.eei.cena.fr/products/ivy/contact.html">Ivy mailing list</link> </para> <para> If you report a bug, try to identify the causal path leading to the |