Zen API

The Zen API provides classes to support communication with FireSync devices via the FireSync Host Protocol (FHP).

Zen is an open-source library, provided under the MIT license. Some of its classes are intended to be used directly, while others exist to support the implementation or testing of these public classes. Classes that are intended to be used directly by FireSync developers include:

zApi	Zen library initialization/cleanup.
zFireSync	Represents a set of FireSync command connections (upgrade, management, control).
zIndicatorSet	Represents a FireSync result message that contains health or event indicators.
zReceiver	Represents a FireSync result connection (health, events, data).
zResult	Represents a FireSync result message.
zXml	Represents an XML document, typically used for server configuration.

Zen can be built as a static library (.lib, .a) or as a shared library (.dll, .so). Visual Studio project files are included to build Zen for Windows and makefiles are included to build Zen for Linux.

To rebuild Zen as a shared library on Linux and then install it to the system library path:

> cd zApi
> make
> sudo make install

To rebuild Zen as a static library on Linux and then install it to the system library path:

> cd zApi
> make -f Makefile_Static
> sudo make -f Makefile_Static install

The Zen library has been tested on the following operating system editions:

Windows XP (SP3) 32-bit
Windows 7 32-bit
Windows 7 64-bit
Ubuntu 11.10 32-bit
Ubuntu 11.10 64-bit

Topics

Topic	Description
Classes	Zen classes.
Constants	Zen constants.
Functions	Zen functions.
Macros	Zen macros.
Values	Zen structures.

Contents | Reference