FairMQ/README.md

FairMQ

C++ Message Queuing Library

Dependencies

TODO

Installation

git clone https://github.com/FairRootGroup/FairMQ
mkdir fairmq_build && cd fairmq_build
cmake -DCMAKE_INSTALL_PREFIX=./fairmq_install ../fairmq
cmake --build . --target install

Documentation

Standard FairRoot is running all the different analysis tasks within one process. FairMQ (Message Queue) allows starting tasks on different processes and provides the communication layer between these processes.

1. Device
   1. Topology
   2. Communication Patterns
   3. State Machine
   4. Multiple devices in the same process
2. Transport Interface
   1. Message
      1. Ownership
   2. Channel
   3. Poller
3. Configuration
   1. Device Configuration
   2. Communication Channels Configuration
      1. JSON Parser
      2. SuboptParser
   3. Introspection
4. Development
   1. Testing
5. Logging
   1. Log severity
   2. Log verbosity
   3. Color for console output
   4. File output
   5. Custom sinks
6. Examples

License

GNU Lesser General Public Licence (LGPL) version 3, see LICENSE.

Copyright (C) 2013-2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH