Vortex Library components

Library base library and its extensions

One feature of Vortex Library 1.1 series is it's new module design separating the base core BEEP library from other extensions that may be used independently. This has two main improvements from previous 1.0 design:

Vortex Library has the following components:

vortex-components.png
Vortex base library and extension libraries

One header for the base library and each extension library

Now each library must be used and included explicitly by the developer. For example, to use base library, sasl and tls implementation will require:

// base library
#include <vortex.h>
// include TLS header
#include <vortex_tls.h>
// include SASL header
#include <vortex_sasl.h>
// rest of available libraries with its associated header
// to include its function
#include <vortex_xml_rpc.h>
#include <vortex_tunnel.h>
#include <vortex_http.h>
#include <vortex_pull.h>

In general, the naming convention to follow is:

#include <vortex_EXTENSION.h>

Pkg-config support for each extension

Now each extension provides its own pkg-config file. The following is the list of available pkg-config files included:

For example, if you are using autoconf, you can use the following example to include support for vortex base library and vortex http CONNECT support:

dnl check for vortex
PKG_CHECK_MODULES(VORTEX, vortex-1.1 >= 1.1.0 vortex-http-1.1 >= 1.1.0)
AC_SUBST(VORTEX_CFLAGS)
AC_SUBST(VORTEX_LIBS)