The Ivy java library guide

CENA NT02-819

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.6 of the library. This document itself is part of the java package, available on the Ivy web site.


Table of Contents
1. Foreword
2. What is Ivy?
3. The Ivy java library
3.1. What is it?
3.2. Getting and installing the Ivy Java library
4. Your first Ivy application
4.1. The code
4.2. Compiling it
4.3. Testing
5. Basic functions
5.1. Initialization an Ivy object and joining the bus
5.2. Emitting messages
5.3. Subscription to messages
5.4. Subscribing to application events
6. Advanced functions
6.1. Sending to self
6.2. Newline within messages
6.3. Sending direct messages
6.4. Asynchronous Subscription to messages
6.5. Waiting for someone: waitForClient and waitForMsg
6.6. Subscribing to subscriptions
7. Utilities
7.1. Probe
7.2. IvyDaemon
8. programmer's style guide
9. Contacting the author

1. Foreword

This document was written in SGML according to the DocBook DtD, so as to be able to generate PDF and html output. However, the authors have not yet mastered the intricacies of SGML, the DocBook DtD, the DocBook Stylesheets and the related tools, which have achieved the glorious feat of being far more complex than LaTeX and Microsoft Word combined together. This explains why this document, in addition to being incomplete, is quite ugly. We'll try and improve it.