ISISClient API Library

Version 2.0

Author:

Richard Pogge, OSU Astronomy Department (pogge@astronomy.ohio-state.edu)

Introduction

The ISISClient API library provides all of the basic utilities needed to create ISIS client applications. These include

• IMPv2 message handling functions (isismessage.c)
• UDP Socket I/O functions (isissocket.c)
• Serial Port I/O functions (isisserial.c)
• Common client string handling and time utilities (isisutils.c)

An ISIS client application needs only include the isisclient.h header and link to the libisis.a library to access these functions.

In addition to the ISIS client library, most client applications make use of a number of common code stubs for loading/parsing runtime config files, keyboard and socket I/O, and command parsing and execution. These are described in a separate document.

Compilation and Dependencies

The Makefile for libisis.a is setup to compile using g++. Applications linking to libisis.a need to also link to the C math library (-lm), but there are no other dependencies in this version.

Notes

Modification History

2003 Sep 15 - First release for beta testing [rwp/osu]
2003 Nov 2  - Cleaned up UDP socket api code, lots-o-bugs [rwp/osu]
2004 Mar 18 - Numerous changes during CTIO 1-m deployment run-up,
              much cleaner ways of handling globals (What was I thinking?)
              and added new functions [rwp/osu]
2004 May 9  - Added comment blocks with Doxygen markup, first crack at
              using Doxygen for this stuff.  Also first compile with g++,
              not as bad as it could have been, but much cleaner now. [rwp/osu]
2004 Jun 9  - Introduced isisclient_t typedef for creating common isisclient
              runtime configuration tables for all client applications. [rwp/osu]
2004 Jul 22 - Overhauled API (v2.0) to correct various problems that emerged
              during testing, and eliminated much clumsiness in v1.x [rwp/osu]

---