The Ivy C++ and 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 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 and Ivy threads
5.2. Emitting messages
5.3. Subscribing to messages
6. Advanced functions
6.1. fr.dgac.ivy.Probe utility
6.2. fr.dgac.ivy.IvyDaemon utility
6.3. Direct messages
7. Ivy c++ Windows port
7.1. Win32 API
8. programmer's style guide
9. Contacting the authors

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 so ugly. We'll try and improve it.

The Windows ivy-c++ port has been written with the same API. Most of the documentation for the Ivy java library applies to the windows c++ library. There is a section dedicated to the description of the intrinsics. There is also a unix port of this library, which is a C++ wrapper on top of the C library. There is also a section dedicated to this port.