DataVaccinator lib

Table of Contents

• Introduction
• Building
  • On Linux
  • On Windows
  • On macOS

Introduction

This is a DataVaccinator Client library which is designed for native use on PC based computer systems running Linux, macOS or Microsoft Windows operating systems. A current Linux version of the API Documentation can be found here.

Building

The project is built using Cmake.

The main dependenies are the following:

• regify-util which also requires ICU

• libcurl and its sub dependencies

• Mbed TLS

• libcheck, optional for running the unit tests

• Doxygen, optional for generating the documentation

The following build instructions assume that the necessary build dependencies can be found under a peer folder named thirdparty.

On Linux

Here is a sample install on Linux

mkdir build
cd build
cmake -DCMAKE_VERBOSE_MAKEFILE=ON \
       -DCMAKE_SYSTEM_NAME=Linux -DDNAME_ARCH=x86_64 \
       -DCMAKE_BUILD_TYPE=Release \
       -DDEPS_BASE=../thirdparty \
       -DINCLUDE_MBEDTLS=ON ..
make install

A package build

mkdir build
cd build
cmake -DCMAKE_VERBOSE_MAKEFILE=ON \
       -DCMAKE_SYSTEM_NAME=Linux -DDNAME_ARCH=x86_64 \
       -DCMAKE_BUILD_TYPE=Release \
       -DDEPS_BASE=../thirdparty \
       -DINCLUDE_MBEDTLS=ON \
       -DSAMPLES=ON -DDOCS=ON ..
make package_source package

On Windows

This is a sample win32 package build with nmake

mkdir build
cd build
cmake.exe -G "NMake Makefiles"-DCMAKE_VERBOSE_MAKEFILE=ON \
       -DCMAKE_SYSTEM_NAME=Windows -DNAME_ARCH=win32 \
       -DCMAKE_BUILD_TYPE=Release \
       -DDEPS_BASE=..\\thirdparty \
       -DINCLUDE_MBEDTLS=ON -DINCLUDE_CURL=ON \
       -DSAMPLES=ON -DDOCS=ON  ..
nmake package

A sample source package build with nmake

mkdir build
cd build
cmake.exe -G "NMake Makefiles"-DCMAKE_VERBOSE_MAKEFILE=ON \
       -DCMAKE_SYSTEM_NAME=Windows -DNAME_ARCH=win32 \
       -DCMAKE_BUILD_TYPE=Release \
       -DDEPS_BASE=..\\thirdparty \
       -DBUILD_SHARED_LIBS=OFF ..
nmake package_source

On macOS

Here is a sample install on Linux

mkdir build
cd build
cmake -DCMAKE_VERBOSE_MAKEFILE=ON \
   -DCMAKE_SYSTEM_NAME=Darwin -DDNAME_ARCH=x86_64 \
   -DCMAKE_BUILD_TYPE=Release \
   -DDEPS_BASE=../thirdparty \
   -DINCLUDE_MBEDTLS=ON ..
make install

A package build

mkdir build
cd build
cmake -DCMAKE_VERBOSE_MAKEFILE=ON \
       -DCMAKE_SYSTEM_NAME=Darwin -DDNAME_ARCH=x86_64 \
       -DCMAKE_BUILD_TYPE=Release \
       -DDEPS_BASE=../thirdparty \
       -DINCLUDE_MBEDTLS=ON \
       -DSAMPLES=ON -DDOCS=ON ..
make package