Skip to content

Latest commit

 

History

History
113 lines (105 loc) · 3.89 KB

README.md

File metadata and controls

113 lines (105 loc) · 3.89 KB
Raw

Welcome to dunenpc!

Table of contents

Introduction

This DUNE-specific client-side library is meant to communicate with NoPayloadDB (https://github.com/bnlnpps/nopayloaddb). It is a simple modification of the more general nopayloadclient (https://github.com/ligerlac/nopayloadclient).

Setup

preface: install nopayloadclient

As this library builds on nopayloadclient, install it first as described here: https://github.com/ligerlac/nopayloadclient. It is assumed that nopayloadclient has been installed under <npc_prefix> in the following.

install dunenpc

In the project folder, configure cmake, compile and install dunenpc

cmake -S . -B build -DCMAKE_PREFIX_PATH=<npc_prefix> -DCMAKE_INSTALL_PREFIX=<install_prefix> -DINCLUDE_DIR_NLOHMANN_JSON=<nlohmann_include_dir>
cmake --build build/
cmake --install build/

Omitting -DCMAKE_PREFIX_PATH=<npc_prefix> will assume nopayloadclient has been installed under the default directory (e.g. /usr/local/). Omitting -DCMAKE_INSTALL_PREFIX=<install_prefix> will install dunenpc under the default directory (e.g. /usr/local/). Omitting -DINCLUDE_DIR_NLOHMANN_JSON=<nlohmann_include_dir> will use the header that ships with this product under contrib/. Make sure to use the same version of the header that was used for nopayloadclient to avoid a version mismatch.

If a custom installation prefix was defined, update the necessary environment variables:

export PATH=<install_prefix>/bin:$PATH
export LD_LIBRARY_PATH=<install_prefix>/lib:$LD_LIBRARY_PATH

Replace LD_LIBRARY_PATH by DYLD_LIBRARY_PATH on MacOS.

Configure the client by specifying the config file in an env variable

export NOPAYLOADCLIENT_CONF=/path/to/config.json

If this is not done, the default parameters of nopayloadclient will be assumed.

Testing

The following command activates testing, reconfigures cmake, recompiles the code and runs the tests

cmake -DBUILD_TESTING=ON -S . -B build && cmake --build build/ && cd build/ && ctest --verbose && cd ..

Usage

To use this library in an independent project, include its header and the widely-spread nlohmann json header-only lib (https://github.com/nlohmann/json)

#include <nlohmann/json.hpp>
#include <dunenpc.hpp>

Payloads can be inserted via

dunenpc::insertPayload(<gt_name>, <gt_type>, <local_url>, <iov>);

and their url can be retrieved via

dunenpc::get(<gt_name>, <gt_type>, <iov>);

Every method returns a nlohmann::json object with a response code and a message body in the following format:

{'code': <code>, 'msg': <message>}

Currently, the following response codes are implemented:

0: ok
1: base error (no further details)
2: error when handling a payload
3: error in the database (server-side)

Examples on how to use this tool in a c++ program can be found in the examples/ folder. To compile standalone.cpp, run the following command

 g++ -std=c++14 standalone.cpp -lnopayloadclient -ldunenpc -lcurl

Usage through command line interface

src/cli_dune.cpp is an implementation of a command line interface. It is compiled and installed along the rest of the project and can be run via

cli_dunenpc <command> <parameters>

The available commands are: get, createGlobalTag, createPayloadType, lockGlobalTag, unlockGlobalTag, deleteGlobalTag, insertPayload (overloaded), getSize, getPayloadTypes, getGlobalTags, checkConnection, and getConfDict. Example workflow:

export NOPAYLOADCLIENT_CONF=/path/to/config.json
cli_dunenpc checkConnection
cli_dunenpc createGlobalTag example_gt
cli_dunenpc getGlobalTags
cli_dunenpc createPayloadType example_pt
cli_dunenpc getPayloadTypes
cli_dunenpc insertPayload example_gt example_pt /tmp/file.dat 7
cli_dunenpc get example_gt example_pt 11
cli_dunenpc getSize