fix: parse errors

```
/test/memory_resources/_memory_resources.cxx: In member function ‘virtual void {anonymous}::MemoryResources_allocator_Test::TestBody()’:
/test/memory_resources/_memory_resources.cxx:104:12: error: parse error in template argument list
  104 |     config.SetProperty<string>("session", to_string(session));
      |            ^~~~~~~~~~~~~~~~~~~
/test/memory_resources/_memory_resources.cxx:104:31: error: no matching function for call to ‘fair::mq::ProgOptions::SetProperty<<expression error> >(const char [8], std::string)’
  104 |     config.SetProperty<string>("session", to_string(session));
      |     ~~~~~~~~~~~~~~~~~~~~~~~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In file included from /home/dklein/projects/FairMQ2/test/memory_resources/_memory_resources.cxx:11:
/fairmq/ProgOptions.h:269:6: note: candidate: ‘template<class T> void fair::mq::ProgOptions::SetProperty(const std::string&, T)’
  269 | void fair::mq::ProgOptions::SetProperty(const std::string& key, T val)
      |      ^~~~
/fairmq/ProgOptions.h:269:6: note:   template argument deduction/substitution failed:
/test/memory_resources/_memory_resources.cxx:104:31: error: template argument 1 is invalid
  104 |     config.SetProperty<string>("session", to_string(session));
      |     ~~~~~~~~~~~~~~~~~~~~~~~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/test/memory_resources/_memory_resources.cxx: In member function ‘virtual void {anonymous}::MemoryResources_getMessage_Test::TestBody()’:
/test/memory_resources/_memory_resources.cxx:132:12: error: parse error in template argument list
  132 |     config.SetProperty<string>("session", to_string(session));
      |            ^~~~~~~~~~~~~~~~~~~
/test/memory_resources/_memory_resources.cxx:132:31: error: no matching function for call to ‘fair::mq::ProgOptions::SetProperty<<expression error> >(const char [8], std::string)’
  132 |     config.SetProperty<string>("session", to_string(session));
      |     ~~~~~~~~~~~~~~~~~~~~~~~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/fairmq/ProgOptions.h:269:6: note: candidate: ‘template<class T> void fair::mq::ProgOptions::SetProperty(const std::string&, T)’
  269 | void fair::mq::ProgOptions::SetProperty(const std::string& key, T val)
      |      ^~~~
/fairmq/ProgOptions.h:269:6: note:   template argument deduction/substitution failed:
/test/memory_resources/_memory_resources.cxx:132:31: error: template argument 1 is invalid
  132 |     config.SetProperty<string>("session", to_string(session));
      |     ~~~~~~~~~~~~~~~~~~~~~~~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
```

.clang-format

@@ -0,0 +1,33 @@
+---
+Language: Cpp
+BasedOnStyle: Mozilla
+
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: true
+AllowShortFunctionsOnASingleLine: true
+AllowShortIfStatementsOnASingleLine: false
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlwaysBreakAfterReturnType: None
+AlwaysBreakAfterDefinitionReturnType: None
+BinPackArguments: false
+BinPackParameters: false
+BreakBeforeBinaryOperators: NonAssignment
+BreakConstructorInitializers: BeforeComma
+ColumnLimit: 100
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: true
+FixNamespaceComments: true
+IndentWidth: 4
+IndentWrappedFunctionNames: true
+IncludeBlocks: Regroup
+NamespaceIndentation: None
+PointerAlignment: Left
+SortIncludes: true
+SpacesBeforeTrailingComments: 3
+Standard: Cpp11
+UseTab: Never
+...

.clang-tidy

@@ -0,0 +1,3 @@
+---
+Checks:            'cppcoreguidelines-*,misc-unused-alias-decls,misc-unused-parameters,modernize-pass-by-value,modernize-deprecated-headers,modernize-raw-string-literal,modernize-redundant-void-arg,modernize-use-bool-literals,modernize-use-default-member-init,modernize-use-emplace,modernize-use-equals-default,modernize-use-equals-delete,modernize-use-noexcept,modernize-use-nullptr,modernize-use-override,modernize-use-using,performance-faster-string-find,performance-for-range-copy,performance-unnecessary-copy-initialization,readability-avoid-const-params-in-decls,readability-braces-around-statements,readability-container-size-empty,readability-delete-null-pointer,readability-redundant-member-init,readability-redundant-string-init,readability-static-accessed-through-instance,readability-string-compare'
+HeaderFilterRegex: '/(fairmq/)'

.devcontainer/devcontainer.json

@@ -0,0 +1,5 @@
+{
+  "image": "ghcr.io/fairrootgroup/fairmq-dev/fedora-38:latest",
+  "features": {
+  }
+}

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Describe environment
+2. Describe compile options used
+3. Give commands you invoked
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs / Screenshots**
+If applicable, add logs or screenshots to help explain your problem.
+
+**System information (please complete the following information):**
+ - OS: [e.g. MacOS 10.13, Fedora 28, Ubuntu 14.04]
+ - Compiler: [e.g. GCC 8.1, Clang 3.5]
+ - Environment: [e.g. FairSoft version, alfadist revision]
+
+**Additional context**
+Add any other context about the problem here.
+
+See [github markdown cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code) on how to format inline codes examples and logs.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,7 @@
+---
+name: Question / Support
+about: Any FairMQ related matter you are interested in
+
+---
+
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+Describe your proposal.
+
+Mention any issue this PR resolves or is related to.
+
+---
+
+Checklist:
+
+* [ ] Rebased against `dev` branch
+* [ ] My name is in the resp. CONTRIBUTORS/AUTHORS file
+* [ ] Followed [the seven rules of great commit messages](https://chris.beams.io/posts/git-commit/#seven-rules)

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    target-branch: "dev"
+    schedule:
+      interval: "monthly"
+  - package-ecosystem: "gitsubmodule"
+    directory: "/"
+    target-branch: "dev"
+    schedule:
+      interval: "monthly"

.github/workflows/check_metadata.yaml

@@ -0,0 +1,29 @@
+# SPDX-FileCopyrightText: 2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH, Darmstadt, Germany
+#
+# SPDX-License-Identifier: CC0-1.0
+
+name: Check AUTHORS and CONTRIBUTORS in metadata
+
+on:
+  push:
+    paths:
+    - AUTHORS
+    - CONTRIBUTORS
+    - codemeta.json
+    - .zenodo.json
+  pull_request:
+    paths:
+    - AUTHORS
+    - CONTRIBUTORS
+    - codemeta.json
+    - .zenodo.json
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Try updating metadata
+        run: python meta_update.py
+      - name: Check for Updates
+        run: git diff --exit-code

.github/workflows/codemeta_validate.yaml

@@ -0,0 +1,21 @@
+name: validate codemeta
+
+on:
+  push:
+    paths:
+    - codemeta.json
+    - .github/workflows/codemeta_validate.yaml
+  pull_request:
+    paths:
+    - codemeta.json
+    - .github/workflows/codemeta_validate.yaml
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    container:
+      image: gitlab-registry.in2p3.fr/escape2020/wp3/eossr:v1.0
+    steps:
+      - uses: actions/checkout@v4
+      - name: validate codemeta
+        run: eossr-metadata-validator codemeta.json

.github/workflows/fair-software.yml

@@ -0,0 +1,16 @@
+name: fair-software
+
+on: push
+
+jobs:
+  verify:
+    name: "fair-software"
+    runs-on: ubuntu-latest
+    if: github.repository == 'FairRootGroup/FairMQ'
+    steps:
+      - uses: fair-software/howfairis-github-action@0.2.1
+        name: Measure compliance with fair-software.eu recommendations
+        env:
+          PYCHARM_HOSTED: "Trick colorama into displaying colored output"
+        with:
+          MY_REPO_URL: "https://github.com/${{ github.repository }}"

.gitignore

@@ -1 +1,8 @@
 build
+install
+.DS_Store
+.vscode
+/compile_commands.json
+.cache
+.spack-env
+spack.lock

.gitlint

@@ -0,0 +1,14 @@
+[general]
+ignore=body-is-missing
+contrib=contrib-title-conventional-commits
+
+ignore-merge-commits=false
+ignore-revert-commits=false
+ignore-fixup-commits=false
+ignore-squash-commits=false
+
+[title-max-length]
+line-length=75
+
+[contrib-title-conventional-commits]
+types=fix,feat,build,ci,docs,style,refactor,perf,test

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "extern/googletest"]
+	path = extern/googletest
+	url = https://github.com/google/googletest
+[submodule "extern/PicoSHA2"]
+	path = extern/PicoSHA2
+	url = https://github.com/okdshin/PicoSHA2
+[submodule "extern/FairCMakeModules"]
+	path = extern/FairCMakeModules
+	url = https://github.com/FairRootGroup/FairCMakeModules

.zenodo.json

@@ -0,0 +1,88 @@
+{
+    "creators": [
+        {
+            "orcid": "0000-0002-8071-4497",
+            "name": "Al-Turany, Mohammad"
+        },
+        {
+            "orcid": "0000-0003-3787-1910",
+            "name": "Klein, Dennis"
+        },
+        {
+            "name": "Kollegger, Thorsten"
+        },
+        {
+            "orcid": "0000-0002-6249-155X",
+            "name": "Rybalchenko, Alexey"
+        },
+        {
+            "name": "Winckler, Nicolas"
+        }
+    ],
+    "contributors": [
+        {
+            "type": "Other",
+            "name": "Aphecetche, Laurent"
+        },
+        {
+            "type": "Other",
+            "name": "Binet, Sebastien"
+        },
+        {
+            "type": "Other",
+            "name": "Eulisse, Giulio"
+        },
+        {
+            "type": "Other",
+            "name": "Karabowicz, Radoslaw"
+        },
+        {
+            "type": "Other",
+            "name": "Kretz, Matthias"
+        },
+        {
+            "type": "Other",
+            "name": "Krzewicki, Mikolaj"
+        },
+        {
+            "type": "Other",
+            "name": "Lebedev, Andrey"
+        },
+        {
+            "type": "Other",
+            "name": "Mrnjavac, Teo"
+        },
+        {
+            "type": "Other",
+            "name": "Neskovic, Gvozden"
+        },
+        {
+            "type": "Other",
+            "name": "Richter, Matthias"
+        },
+        {
+            "type": "Other",
+            "orcid": "0000-0002-5321-8404",
+            "name": "Tacke, Christian"
+        },
+        {
+            "type": "Other",
+            "name": "Uhlig, Florian"
+        },
+        {
+            "type": "Other",
+            "name": "Wenzel, Sandro"
+        }
+    ],
+    "description": "<p>C++ Message Queuing Library and Framework</p>",
+    "related_identifiers": [
+        {
+            "identifier": "https://github.com/FairRootGroup/FairMQ/",
+            "relation": "isSupplementTo",
+            "resource_type": "software",
+            "scheme": "url"
+        }
+    ],
+    "title": "FairMQ",
+    "license": "LGPL-3.0-only"
+}

AUTHORS

@@ -1,5 +1,5 @@
-Al-Turany, Mohammad
-Klein, Dennis
+Al-Turany, Mohammad [https://orcid.org/0000-0002-8071-4497]
+Klein, Dennis [https://orcid.org/0000-0003-3787-1910]
 Kollegger, Thorsten
-Rybalchenko, Alexey
+Rybalchenko, Alexey [https://orcid.org/0000-0002-6249-155X]
 Winckler, Nicolas

CMakeGraphVizOptions.cmake

@@ -0,0 +1,14 @@
+set(GRAPHVIZ_GRAPH_TYPE digraph)
+set(GRAPHVIZ_GRAPH_NAME FairMQ)
+set(GRAPHVIZ_EXECUTABLES ON)
+set(GRAPHVIZ_STATIC_LIBS OFF)
+set(GRAPHVIZ_SHARED_LIBS ON)
+set(GRAPHVIZ_MODULE_LIBS OFF)
+set(GRAPHVIZ_GENERATE_PER_TARGET OFF)
+set(GRAPHVIZ_GENERATE_DEPENDERS OFF)
+set(GRAPHVIZ_IGNORE_TARGETS
+  "fairmq-ex.*"
+  "testsuite_.*"
+  "testhelper_.*"
+  "FairMQPlugin_test_dummy"
+)

CMakeLists.txt

@@ -1,169 +1,131 @@
 ################################################################################
-#    Copyright (C) 2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    #
+# Copyright (C) 2018-2024 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
 #                                                                              #
 #              This software is distributed under the terms of the             #
 #              GNU Lesser General Public Licence (LGPL) version 3,             #
 #                  copied verbatim in the file "LICENSE"                       #
 ################################################################################
 
-cmake_minimum_required(VERSION 3.9.4 FATAL_ERROR)
-
 
 # Project ######################################################################
-set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake)
-include(FairMQLib)
+cmake_minimum_required(VERSION 3.15...3.30 FATAL_ERROR)
 
-set_fairmq_cmake_policies()
+list(PREPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake)
+include(GitHelper)
 get_git_version()
 
 project(FairMQ VERSION ${PROJECT_VERSION} LANGUAGES CXX)
-message(STATUS "${BWhite}${PROJECT_NAME}${CR} ${PROJECT_GIT_VERSION} from ${PROJECT_DATE}")
-
-set_fairmq_defaults()
-
-include(CTest)
+include(FairMQProjectSettings)
 ################################################################################
 
 
 # Build options ################################################################
-option(BUILD_NANOMSG_TRANSPORT "Build nanomsg transport." OFF)
-option(BUILD_OFI_TRANSPORT "Build experimental OFI transport." OFF)
-option(BUILD_DDS_PLUGIN "Build DDS plugin." OFF)
+include(FairMQBuildOption)
+
+fairmq_build_option(BUILD_FAIRMQ        "Build FairMQ library and devices."
+                                         DEFAULT ON)
+fairmq_build_option(BUILD_TESTING       "Build tests."
+                                         DEFAULT OFF REQUIRES "BUILD_FAIRMQ")
+fairmq_build_option(BUILD_EXAMPLES      "Build FairMQ examples."
+                                         DEFAULT ON  REQUIRES "BUILD_FAIRMQ")
+fairmq_build_option(BUILD_TIDY_TOOL     "Build the fairmq-tidy tool."
+                                         DEFAULT OFF)
+fairmq_build_option(BUILD_DOCS          "Build FairMQ documentation."
+                                         DEFAULT OFF)
+fairmq_build_option(USE_EXTERNAL_GTEST  "Do not use bundled GTest. Not recommended."
+                                         DEFAULT OFF)
+fairmq_build_option(FAIRMQ_DEBUG_MODE   "Compile in debug mode (may decrease performance)."
+                                         DEFAULT OFF)
 ################################################################################
 
 
 # Dependencies #################################################################
-find_package2(PUBLIC Boost VERSION 1.64 REQUIRED
-  COMPONENTS program_options thread system filesystem regex date_time signals
-)
-find_package2(PUBLIC FairLogger VERSION 1.0.2 REQUIRED)
-find_package2(PRIVATE ZeroMQ VERSION 4.2.2 REQUIRED)
-
-if(BUILD_NANOMSG_TRANSPORT)
-  find_package2(PRIVATE nanomsg VERSION 1.0.0 REQUIRED)
-  find_package2(PRIVATE msgpack VERSION 2.1.5 REQUIRED)
-endif()
-
-if(BUILD_OFI_TRANSPORT)
-  find_package2(PRIVATE OFI VERSION 1.6.0 REQUIRED COMPONENTS fi_sockets)
-  find_package2(PRIVATE Protobuf VERSION 3.4.0 REQUIRED)
-endif()
-
-if(BUILD_DDS_PLUGIN)
-  find_package2(PRIVATE DDS VERSION 2.0 REQUIRED)
-endif()
-
-if(BUILD_TESTING)
-  find_package2(PRIVATE GTest VERSION 1.7.0 REQUIRED)
-endif()
+include(CTest)
+include(FairMQDependencies)
 ################################################################################
 
 
 # Targets ######################################################################
-configure_file(${PROJECT_NAME_LOWER}/Version.h.in
-  ${CMAKE_BINARY_DIR}/${PROJECT_NAME_LOWER}/Version.h
-  @ONLY
-)
-
-add_subdirectory(fairmq)
+if(BUILD_FAIRMQ)
+  add_subdirectory(fairmq)
+endif()
 
 if(BUILD_TESTING)
   add_subdirectory(test)
 endif()
+
+if(BUILD_EXAMPLES)
+  add_subdirectory(examples)
+endif()
+
+if(BUILD_DOCS)
+  set(DOXYGEN_OUTPUT_DIRECTORY doxygen)
+  set(DOXYGEN_PROJECT_NUMBER ${PROJECT_GIT_VERSION})
+  set(DOXYGEN_PROJECT_BRIEF "C++ Message Queuing Library and Framework")
+  set(DOXYGEN_USE_MDFILE_AS_MAINPAGE README.md)
+  set(DOXYGEN_HTML_FOOTER docs/footer.html)
+  doxygen_add_docs(doxygen README.md fairmq)
+  add_custom_target(docs ALL DEPENDS doxygen)
+endif()
+
+if(BUILD_TIDY_TOOL)
+  add_subdirectory(fairmq/tidy)
+endif()
 ################################################################################
 
 
 # Package components ###########################################################
-list(APPEND PROJECT_PACKAGE_COMPONENTS fairmq)
-list(APPEND PROJECT_PACKAGE_COMPONENTS tests)
-if(BUILD_DDS_PLUGIN)
-  list(APPEND PROJECT_PACKAGE_COMPONENTS dds_plugin)
+if(BUILD_FAIRMQ)
+  list(APPEND PROJECT_PACKAGE_COMPONENTS fairmq)
 endif()
-if(BUILD_NANOMSG_TRANSPORT)
-  list(APPEND PROJECT_PACKAGE_COMPONENTS nanomsg_transport)
+if(BUILD_TESTING)
+  list(APPEND PROJECT_PACKAGE_COMPONENTS tests)
 endif()
-if(BUILD_OFI_TRANSPORT)
-  list(APPEND PROJECT_PACKAGE_COMPONENTS ofi_transport)
+if(BUILD_EXAMPLES)
+  list(APPEND PROJECT_PACKAGE_COMPONENTS examples)
+endif()
+if(BUILD_DOCS)
+  list(APPEND PROJECT_PACKAGE_COMPONENTS docs)
+endif()
+if(BUILD_TIDY_TOOL)
+  list(APPEND PROJECT_PACKAGE_COMPONENTS tidy_tool)
 endif()
 ################################################################################
 
 
 # Installation #################################################################
-install(FILES ${CMAKE_BINARY_DIR}/${PROJECT_NAME_LOWER}/Version.h
-  DESTINATION ${PROJECT_INSTALL_INCDIR}
-)
-
-# Install cmake modules
-install(FILES cmake/FindZeroMQ.cmake
-  DESTINATION ${PROJECT_INSTALL_CMAKEMODDIR}
-)
-if(BUILD_DDS_PLUGIN)
-  install(FILES cmake/FindDDS.cmake
+if(BUILD_FAIRMQ)
+  install(FILES cmake/FindZeroMQ.cmake
     DESTINATION ${PROJECT_INSTALL_CMAKEMODDIR}
   )
 endif()
-if(BUILD_NANOMSG_TRANSPORT)
-  install(FILES cmake/Findnanomsg.cmake
-    DESTINATION ${PROJECT_INSTALL_CMAKEMODDIR}
+if(BUILD_DOCS)
+  install(DIRECTORY ${CMAKE_BINARY_DIR}/doxygen/html
+    DESTINATION ${PROJECT_INSTALL_DATADIR}/docs
   )
 endif()
-if(BUILD_OFI_TRANSPORT)
-  install(FILES cmake/FindOFI.cmake
+if(BUILD_TIDY_TOOL)
+  install(FILES cmake/FairMQTidy.cmake
     DESTINATION ${PROJECT_INSTALL_CMAKEMODDIR}
   )
 endif()
 
+include(FairMQPackage)
 install_cmake_package()
 ################################################################################
 
 
 # Summary ######################################################################
-message(STATUS "  ")
-message(STATUS "  ${Cyan}DEPENDENCY      VERSION              ${CR}")
-foreach(dep IN LISTS PROJECT_PACKAGE_DEPENDENCIES)
-  if(${dep}_VERSION)
-    if(${dep} STREQUAL Boost)
-      set(version_str "${BGreen}${${dep}_MAJOR_VERSION}.${${dep}_MINOR_VERSION}${CR}")
-    else()
-      set(version_str "${BGreen}${${dep}_VERSION}${CR}")
-    endif()
-  else()
-    set(version_str "${BYellow}unknown${CR}")
-  endif()
-  if(PROJECT_${dep}_VERSION)
-    set(version_req_str " (>= ${PROJECT_${dep}_VERSION})")
-  endif()
-  pad(${dep} 15 " " dep_padded)
-  pad("${version_str}${version_req_str}" 20 " " version_padded)
-  message(STATUS "  ${BWhite}${dep_padded}${CR}${version_padded}")
-  unset(version_str)
-endforeach()
-message(STATUS "  ")
-message(STATUS "  ${Cyan}COMPONENT         BUILT?  INFO${CR}")
-message(STATUS "  ${BWhite}fairmq${CR}             ${BGreen}YES${CR}    (default, always built)")
-if(BUILD_TESTING)
-  set(tests_summary "${BGreen}YES${CR}    (default, disable with ${BMagenta}-DBUILD_TESTING=OFF${CR})")
-else()
-  set(tests_summary "${BRed} NO${CR}    (enable with ${BMagenta}-DBUILD_TESTING=ON${CR})")
-endif()
-message(STATUS "  ${BWhite}tests${CR}              ${tests_summary}")
-if(BUILD_NANOMSG_TRANSPORT)
-  set(nn_summary "${BGreen}YES${CR}    (disable with ${BMagenta}-DBUILD_NANOMSG_TRANSPORT=OFF${CR})")
-else()
-  set(nn_summary "${BRed} NO${CR}    (default, enable with ${BMagenta}-DBUILD_NANOMSG_TRANSPORT=ON${CR})")
-endif()
-message(STATUS "  ${BWhite}nanomsg_transport${CR}  ${nn_summary}")
-if(BUILD_OFI_TRANSPORT)
-  set(ofi_summary "${BGreen}YES${CR}    EXPERIMENTAL (disable with ${BMagenta}-DBUILD_OFI_TRANSPORT=OFF${CR})")
-else()
-  set(ofi_summary "${BRed} NO${CR}    EXPERIMENTAL (default, enable with ${BMagenta}-DBUILD_OFI_TRANSPORT=ON${CR})")
-endif()
-message(STATUS "  ${BWhite}ofi_transport${CR}      ${ofi_summary}")
-if(BUILD_DDS_PLUGIN)
-  set(dds_summary "${BGreen}YES${CR}    (disable with ${BMagenta}-DBUILD_DDS_PLUGIN=OFF${CR})")
-else()
-  set(dds_summary "${BRed} NO${CR}    (default, enable with ${BMagenta}-DBUILD_DDS_PLUGIN=ON${CR})")
-endif()
-message(STATUS "  ${BWhite}dds_plugin${CR}         ${dds_summary}")
+include(FairMQSummary)
+
+message(STATUS "${BWhite}${PROJECT_NAME}${CR} ${PROJECT_GIT_VERSION} from ${PROJECT_DATE}")
+fair_summary_global_cxx_flags_standard()
+fair_summary_build_types()
+fair_summary_package_dependencies()
+fairmq_summary_components()
+fairmq_summary_static_analysis()
+fairmq_summary_install_prefix()
+fairmq_summary_debug_mode()
+fairmq_summary_compile_definitions()
 message(STATUS "  ")
 ################################################################################

CONTRIBUTORS

@@ -1,8 +1,13 @@
+Aphecetche, Laurent
 Binet, Sebastien
 Eulisse, Giulio
 Karabowicz, Radoslaw
-Krzewicki, Mikolaj 
+Kretz, Matthias <kretz@kde.org>
+Krzewicki, Mikolaj
+Lebedev, Andrey
+Mrnjavac, Teo <teo.m@cern.ch>
 Neskovic, Gvozden
 Richter, Matthias
+Tacke, Christian [https://orcid.org/0000-0002-5321-8404]
 Uhlig, Florian
 Wenzel, Sandro

COPYRIGHT

@@ -0,0 +1,101 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: FairMQ
+Upstream-Contact: Mohammad Al-Turany <m.al-turany@gsi.de>
+Source: https://github.com/FairRootGroup/FairMQ
+
+Files: *
+Copyright: 2012-2022, GSI Helmholtzzentrum fuer Schwerionenforschung GmbH
+Copyright: 2012-2022, [see AUTHORS file]
+Copyright: 2012-2022, [see CONTRIBUTORS file]
+Comment: The copyright of individual contributors is documented in the
+  Git history.
+License: LGPL-3.0-only
+
+Files: extern/googletest
+Copyright: 2008-2022, Google Inc.
+License: GOOGLE
+
+Files: extern/asio
+Copyright: 2003-2022, Christopher M. Kohlhoff (chris at kohlhoff dot com)
+License: BSL-1.0
+
+Files: extern/PicoSHA2
+Copyright: 2017 okdshin
+License: MIT
+
+License: LGPL-3.0-only
+  [see LICENSE file]
+
+License: GOOGLE
+  Copyright 2008, Google Inc.
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are
+  met:
+
+      * Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+      * Redistributions in binary form must reproduce the above
+  copyright notice, this list of conditions and the following disclaimer
+  in the documentation and/or other materials provided with the
+  distribution.
+      * Neither the name of Google Inc. nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+License: BSL-1.0
+  Boost Software License - Version 1.0 - August 17th, 2003
+
+  Permission is hereby granted, free of charge, to any person or organization
+  obtaining a copy of the software and accompanying documentation covered by
+  this license (the "Software") to use, reproduce, display, distribute,
+  execute, and transmit the Software, and to prepare derivative works of the
+  Software, and to permit third-parties to whom the Software is furnished to
+  do so, all subject to the following:
+
+  The copyright notices in the Software and this entire statement, including
+  the above license grant, this restriction and the following disclaimer,
+  must be included in all copies of the Software, in whole or in part, and
+  all derivative works of the Software, unless such copies or derivative
+  works are solely in the form of machine-executable object code generated by
+  a source language processor.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+  SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+  FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+  ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+  DEALINGS IN THE SOFTWARE.
+
+License: MIT
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.

CTestConfig.cmake

@@ -0,0 +1,3 @@
+set(CTEST_PROJECT_NAME "FairMQ")
+set(CTEST_NIGHTLY_START_TIME "00:00:00 CEST")
+set(CTEST_SUBMIT_URL "https://cdash.gsi.de/submit.php?project=FairMQ")

FairMQTest.cmake

@@ -0,0 +1,93 @@
+################################################################################
+# Copyright (C) 2021-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+cmake_host_system_information(RESULT fqdn QUERY FQDN)
+
+set(CTEST_SOURCE_DIRECTORY .)
+set(CTEST_BINARY_DIRECTORY build)
+set(CTEST_CMAKE_GENERATOR "Ninja")
+set(CTEST_USE_LAUNCHERS ON)
+set(CTEST_CONFIGURATION_TYPE "RelWithDebInfo")
+set(CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE 102400)
+
+if(NOT NCPUS)
+  if(ENV{SLURM_CPUS_PER_TASK})
+    set(NCPUS $ENV{SLURM_CPUS_PER_TASK})
+  else()
+    include(ProcessorCount)
+    ProcessorCount(NCPUS)
+    if(NCPUS EQUAL 0)
+      set(NCPUS 1)
+    endif()
+  endif()
+endif()
+
+if ("$ENV{CTEST_SITE}" STREQUAL "")
+  set(CTEST_SITE "${fqdn}")
+else()
+  set(CTEST_SITE $ENV{CTEST_SITE})
+endif()
+
+if ("$ENV{LABEL}" STREQUAL "")
+  set(CTEST_BUILD_NAME "build")
+else()
+  set(CTEST_BUILD_NAME $ENV{LABEL})
+endif()
+
+ctest_start(Continuous)
+
+list(APPEND options "-DDISABLE_COLOR=ON" "-DBUILD_EXAMPLES=ON" "-DBUILD_TESTING=ON")
+if(RUN_STATIC_ANALYSIS)
+  list(APPEND options "-DRUN_STATIC_ANALYSIS=ON")
+endif()
+if(CMAKE_BUILD_TYPE)
+  set(CTEST_CONFIGURATION_TYPE ${CMAKE_BUILD_TYPE})
+endif()
+if(ENABLE_SANITIZER_ADDRESS)
+  list(APPEND options "-DENABLE_SANITIZER_ADDRESS=ON")
+endif()
+if(ENABLE_SANITIZER_LEAK)
+  list(APPEND options "-DENABLE_SANITIZER_LEAK=ON")
+endif()
+if(ENABLE_SANITIZER_UNDEFINED_BEHAVIOR)
+  list(APPEND options "-DENABLE_SANITIZER_UNDEFINED_BEHAVIOR=ON")
+endif()
+if(ENABLE_SANITIZER_MEMORY)
+  list(APPEND options "-DENABLE_SANITIZER_MEMORY=ON")
+endif()
+if(ENABLE_SANITIZER_THREAD)
+  list(APPEND options "-DENABLE_SANITIZER_THREAD=ON")
+endif()
+if(CMAKE_CXX_COMPILER)
+  list(APPEND options "-DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}")
+endif()
+if(CMAKE_CXX_FLAGS)
+  list(APPEND options "-DCMAKE_CXX_FLAGS=${CMAKE_CXX_FLAGS}")
+endif()
+list(REMOVE_DUPLICATES options)
+list(JOIN options ";" optionsstr)
+ctest_configure(OPTIONS "${optionsstr}")
+
+ctest_submit()
+
+ctest_build(FLAGS "-j${NCPUS}")
+
+ctest_submit()
+
+if(NOT RUN_STATIC_ANALYSIS)
+  ctest_test(BUILD "${CTEST_BINARY_DIRECTORY}"
+             PARALLEL_LEVEL ${NCPUS}
+             SCHEDULE_RANDOM ON
+             RETURN_VALUE _ctest_test_ret_val)
+
+  ctest_submit()
+endif()
+
+if(_ctest_test_ret_val)
+  Message(FATAL_ERROR "Some tests failed.")
+endif()

Jenkinsfile

@@ -0,0 +1,118 @@
+#!groovy
+
+def jobMatrix(String type, List specs) {
+  def nodes = [:]
+  for (spec in specs) {
+    def job = ""
+    def selector = "slurm"
+    def os = ""
+    def ver = ""
+
+    if (type == 'build') {
+      job = "${spec.os}-${spec.ver}-${spec.arch}-${spec.compiler}"
+      if (spec.os =~ /^macos/) {
+        selector = "${spec.os}-${spec.ver}-${spec.arch}"
+      }
+      os = spec.os
+      ver = spec.ver
+    } else { // == 'check'
+      job = "${spec.name}"
+      os = 'fedora'
+      ver = '36'
+    }
+
+    def label = "${job}"
+    def extra = spec.extra
+
+    nodes[label] = {
+      node(selector) {
+        githubNotify(context: "${label}", description: 'Building ...', status: 'PENDING')
+        try {
+          deleteDir()
+          checkout scm
+
+          def jobscript = 'job.sh'
+          def ctestcmd = "ctest ${extra} -S FairMQTest.cmake -V --output-on-failure"
+          sh "echo \"set -e\" >> ${jobscript}"
+          sh "echo \"export LABEL=\\\"\${JOB_BASE_NAME} ${label}\\\"\" >> ${jobscript}"
+          if (selector =~ /^macos/) {
+            sh """\
+              echo \"${ctestcmd}\" >> ${jobscript}
+            """
+            sh "cat ${jobscript}"
+            sh "bash ${jobscript}"
+          } else { // selector == "slurm"
+            def imageurl = "oras://ghcr.io/fairrootgroup/fairmq-dev/${os}-${ver}-sif:latest"
+            def execopts = "--ipc --uts --pid -B/shared"
+            def containercmd = "singularity exec ${execopts} ${imageurl} bash -l -c \\\"${ctestcmd} ${extra}\\\""
+            sh """\
+              echo \"echo \\\"*** Job started at .......: \\\$(date -R)\\\"\" >> ${jobscript}
+              echo \"echo \\\"*** Job ID ...............: \\\${SLURM_JOB_ID}\\\"\" >> ${jobscript}
+              echo \"echo \\\"*** Compute node .........: \\\$(hostname -f)\\\"\" >> ${jobscript}
+              echo \"unset http_proxy\" >> ${jobscript}
+              echo \"unset HTTP_PROXY\" >> ${jobscript}
+              echo \"${containercmd}\" >> ${jobscript}
+            """
+            sh "cat ${jobscript}"
+            sh "test/ci/slurm-submit.sh \"FairMQ \${JOB_BASE_NAME} ${label}\" ${jobscript}"
+
+            if (job == "static-analyzers") {
+              recordIssues(enabledForFailure: true,
+                           tools: [gcc(pattern: 'build/Testing/Temporary/*.log')],
+                           filters: [excludeFile('extern/*'), excludeFile('usr/*')],
+                           skipBlames: true,
+                           skipPublishingChecks: true)
+            }
+          }
+
+          deleteDir()
+          githubNotify(context: "${label}", description: 'Success', status: 'SUCCESS')
+        } catch (e) {
+          deleteDir()
+          githubNotify(context: "${label}", description: 'Error', status: 'ERROR')
+          throw e
+        }
+      }
+    }
+  }
+  return nodes
+}
+
+pipeline{
+  agent none
+  stages {
+    stage("CI") {
+      steps{
+        script {
+          def builds = jobMatrix('build', [
+            [os: 'ubuntu', ver: '20.04', arch: 'x86_64', compiler: 'gcc-9'],
+            [os: 'ubuntu', ver: '22.04', arch: 'x86_64', compiler: 'gcc-11'],
+            [os: 'ubuntu', ver: '24.04', arch: 'x86_64', compiler: 'gcc-13'],
+            [os: 'fedora', ver: '33',    arch: 'x86_64', compiler: 'gcc-10'],
+            [os: 'fedora', ver: '34',    arch: 'x86_64', compiler: 'gcc-11'],
+            [os: 'fedora', ver: '35',    arch: 'x86_64', compiler: 'gcc-11'],
+            [os: 'fedora', ver: '36',    arch: 'x86_64', compiler: 'gcc-12'],
+            [os: 'fedora', ver: '37',    arch: 'x86_64', compiler: 'gcc-12'],
+            [os: 'fedora', ver: '38',    arch: 'x86_64', compiler: 'gcc-13'],
+            [os: 'fedora', ver: '39',    arch: 'x86_64', compiler: 'gcc-13'],
+            [os: 'fedora', ver: '40',    arch: 'x86_64', compiler: 'gcc-14'],
+            [os: 'macos',  ver: '14',    arch: 'x86_64', compiler: 'apple-clang-16'],
+            [os: 'macos',  ver: '15',    arch: 'x86_64', compiler: 'apple-clang-16'],
+            [os: 'macos',  ver: '15',    arch: 'arm64',  compiler: 'apple-clang-16'],
+          ])
+
+          def all_debug = "-DCMAKE_BUILD_TYPE=Debug"
+
+          def checks = jobMatrix('check', [
+            [name: 'static-analyzers', extra: "${all_debug} -DRUN_STATIC_ANALYSIS=ON"],
+            [name: '{address,leak,ub}-sanitizers',
+             extra: "${all_debug} -DENABLE_SANITIZER_ADDRESS=ON -DENABLE_SANITIZER_LEAK=ON -DENABLE_SANITIZER_UNDEFINED_BEHAVIOUR=ON -DCMAKE_CXX_FLAGS='-O1 -fno-omit-frame-pointer'"],
+            [name: 'thread-sanitizer', extra: "${all_debug} -DENABLE_SANITIZER_THREAD=ON -DCMAKE_CXX_COMPILER=clang++"],
+          ])
+
+          parallel(builds + checks)
+        }
+      }
+    }
+  }
+}

LICENSE

@@ -1,5 +1,3 @@
-GPL text after LGPL text in this file:
-
                    GNU LESSER GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
@@ -165,679 +163,3 @@ whether future versions of the GNU Lesser General Public License shall
 apply, that proxy's public statement of acceptance of any version is
 permanent authorization for you to choose that version for the
 Library.
-
-
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.

README.md

@@ -1,78 +1,112 @@
+<!-- {#mainpage} -->
 # FairMQ
 
-C++ Message Queuing Library
+[![license](https://alfa-ci.gsi.de/shields/badge/license-LGPL--3.0-orange.svg)](COPYRIGHT)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1689985.svg)](https://doi.org/10.5281/zenodo.1689985)
+[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/6915/badge)](https://bestpractices.coreinfrastructure.org/projects/6915)
+[![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B%20%20%E2%97%8F%20%20%E2%97%8F-yellow)](https://github.com/FairRootGroup/FairMQ/actions/workflows/fair-software.yml)
+[![Spack package](https://repology.org/badge/version-for-repo/spack/fairmq.svg)](https://repology.org/project/fairmq/versions)
 
-## Dependencies
+C++ Message Queuing Library and Framework
 
-  * **Boost** (PUBLIC)
-  * **FairLogger** (PUBLIC)
-  * CMake
-  * dl
-  * pthread
-  * rt (Linux)
-  * ZeroMQ
-  * GTest (optional, `tests`)
-  * Msgpack (optional, `nanomsg_transport`)
-  * nanomsg (optional, `nanomsg_transport`)
-  * OFI (optional, `ofi_transport`)
-  * Protobuf (optional, `ofi_transport`)
-  * DDS (optional, `dds_plugin`)
+Docs: [Book](https://github.com/FairRootGroup/FairMQ/blob/dev/README.md#documentation)
 
-## Installation
+Find all FairMQ releases [here](https://github.com/FairRootGroup/FairMQ/releases).
+
+## Introduction
+
+FairMQ is designed to help implementing large-scale data processing workflows needed in next-generation Particle Physics experiments. FairMQ is written in C++ and aims to
+  * provide **an asynchronous message passing abstraction** of different data transport technologies,
+  * provide a reasonably **efficient data transport** service (zero-copy, high throughput),
+  * be **data format agnostic**, and
+  * provide **basic building blocks** that can be used to implement higher level data processing workflows.
+
+The core of FairMQ provides an abstract asynchronous message passing API with scalability protocols
+inspired by [ZeroMQ](https://github.com/zeromq/libzmq) (e.g. PUSH/PULL, PUB/SUB).
+FairMQ provides multiple implementations for its API (so-called "transports",
+e.g. `zeromq` and `shmem` (latest release of the `ofi` transport in v1.4.56, removed since v1.5+)) to cover
+a variety of use cases
+(e.g. inter-thread, inter-process, inter-node communication) and machines (e.g. Ethernet, Infiniband).
+In addition to this core functionality FairMQ provides a framework for creating "devices" - actors which
+are communicating through message passing. FairMQ does not only allow the user to use different transport
+but also to mix them; i.e: A Device can communicate using different transport on different channels at the
+same time. Device execution is modelled as a simple state machine that shapes the integration points for
+the user task. Devices also incorporate a plugin system for runtime configuration and control.
+Next to the provided [devices](https://github.com/FairRootGroup/FairMQ/tree/master/fairmq/devices) and
+[plugins](https://github.com/FairRootGroup/FairMQ/tree/master/fairmq/plugins) the user can extend FairMQ
+by developing his own plugins to integrate his devices with external configuration and control services.
+
+FairMQ has been developed in the context of its mother project [FairRoot](https://github.com/FairRootGroup/FairRoot) -
+a simulation, reconstruction and analysis framework.
+
+## Installation from Source
+
+Recommended:
 
 ```bash
-git clone https://github.com/FairRootGroup/FairMQ
-mkdir fairmq_build && cd fairmq_build
-cmake -DCMAKE_INSTALL_PREFIX=./fairmq_install ../fairmq
-cmake --build . --target install
+git clone https://github.com/FairRootGroup/FairMQ fairmq_source
+cmake -S fairmq_source -B fairmq_build -GNinja -DCMAKE_BUILD_TYPE=Release [-DBUILD_TESTING=ON]
+cmake --build fairmq_build
+[ctest --test-dir fairmq_build --output-on-failure --schedule-random -j<ncpus>] # needs -DBUILD_TESTING=ON
+cmake --install fairmq_build --prefix $(pwd)/fairmq_install
 ```
 
-If dependencies are not installed in standard system
-directories, you can hint the installation location
-via `-DCMAKE_PREFIX_PATH=...` or per dependency via
-`-D{DEPENDENCY}_ROOT=...`. `{DEPENDENCY}` can be `GTEST`,
-`BOOST`, `FAIRLOGGER`, `ZEROMQ`, `MSGPACK`, `NANOMSG`,
-`OFI`, `PROTOBUF`, or `DDS` (`*_ROOT` variables can also
-be environment variables).
+Please consult the [manpages of your CMake version](https://cmake.org/cmake/help/latest/manual/cmake.1.html) for more options.
+
+If dependencies are not installed in standard system directories, you can hint the installation location via
+`-DCMAKE_PREFIX_PATH=...` or per dependency via `-D{DEPENDENCY}_ROOT=...` (`*_ROOT` variables can also be environment variables).
+
+## Installation via Spack
+
+Prerequisite: [Spack](https://spack.readthedocs.io/en/latest/getting_started.html)
+
+```bash
+spack info fairmq # inspect build options
+spack install fairmq # build latest packaged version with default options
+```
+
+Build FairMQ's dependencies via Spack for development:
+```bash
+git clone -b dev https://github.com/FairRootGroup/FairMQ fairmq_source
+spack --env fairmq_source install # installs deps declared in fairmq_source/spack.yaml
+spack env activate fairmq_source # sets $CMAKE_PREFIX_PATH which is used by CMake to find FairMQ's deps
+cmake -S fairmq_source -B fairmq_build -GNinja -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON
+# develop, compile, test
+spack env deactivate # at end of dev session, or simply close the shell
+```
 
 ## Usage
 
 FairMQ ships as a CMake package, so in your `CMakeLists.txt` you can discover it like this:
 
 ```cmake
-find_package(FairMQ)
+find_package(FairCMakeModules 1.0 REQUIRED)
+include(FairFindPackage2)
+find_package2(FairMQ)
+find_package2_implicit_dependencies()
 ```
 
+The [`FairFindPackage2` module](https://fairrootgroup.github.io/FairCMakeModules/latest/module/FairFindPackage2.html) is part of the [`FairCMakeModules` package](https://fairrootgroup.github.io/FairCMakeModules).
+
 If FairMQ is not installed in system directories, you can hint the installation:
 
 ```cmake
-set(CMAKE_PREFIX_PATH /path/to/FairMQ_install_prefix ${CMAKE_PREFIX_PATH})
-find_package(FairMQ)
+list(PREPEND CMAKE_PREFIX_PATH /path/to/fairmq_install)
 ```
 
-`find_package(FairMQ)` will define an imported target `FairMQ::FairMQ` (An alias `FairRoot::FairMQ`
-is also defined for backwards compatibility, but it is deprecated).
+## Dependencies
 
-In order to succesfully compile and link against the `FairMQ::FairMQ` target,
-you need to discover its public package dependencies, too.
+  * [Boost](https://www.boost.org/)
+  * [CMake](https://cmake.org/)
+  * [Doxygen](http://www.doxygen.org/)
+  * [FairCMakeModules](https://github.com/FairRootGroup/FairCMakeModules) (optionally bundled)
+  * [FairLogger](https://github.com/FairRootGroup/FairLogger)
+  * [GTest](https://github.com/google/googletest) (optionally bundled)
+  * [ZeroMQ](http://zeromq.org/)
 
-```cmake
-find_package(FairMQ)
-find_package(FairLogger ${FairMQ_FairLogger_VERSION})
-find_package(Boost ${FairMQ_Boost_VERSION} COMPONENTS ${FairMQ_BOOST_COMPONENTS})
-```
+  Which dependencies are required depends on which components are built.
 
-Of course, feel free to customize the above commands to your needs.
-
-Optionally, you can require certain FairMQ package components and a minimum version:
-
-```cmake
-find_package(FairMQ 1.1.0 COMPONENTS nanomsg_transport dds_plugin)
-find_package(FairLogger ${FairMQ_FairLogger_VERSION})
-find_package(Boost ${FairMQ_Boost_VERSION} COMPONENTS ${FairMQ_BOOST_COMPONENTS})
-```
-
-When building FairMQ, CMake will print a summary table of all available package components.
+  Supported platform is Linux. macOS is supported on a best-effort basis.
 
 ## CMake options
 
@@ -80,22 +114,33 @@ On command line:
 
   * `-DDISABLE_COLOR=ON` disables coloured console output.
   * `-DBUILD_TESTING=OFF` disables building of tests.
-  * `-DBUILD_NANOMSG_TRANSPORT=ON` enables building of nanomsg transport.
-  * `-DBUILD_OFI_TRANSPORT=ON` enables building of the experimental OFI transport.
-  * `-DBUILD_DDS_PLUGIN=ON` enables building of the DDS plugin.
-  * You can hint non-system installations for dependent packages, see the #Installation section above
+  * `-DBUILD_EXAMPLES=OFF` disables building of examples.
+  * `-DBUILD_DOCS=ON` enables building of API docs.
+  * `-DFAIRMQ_CHANNEL_DEFAULT_AUTOBIND=OFF` disable channel `autoBind` by default
+  * You can hint non-system installations for dependent packages, see the #installation-from-source section above
 
 After the `find_package(FairMQ)` call the following CMake variables are defined:
 
-  * `${FairMQ_Boost_VERSION}` contains the minimum Boost version FairMQ requires.
-  * `${FairMQ_Boost_COMPONENTS}` contains the list of Boost components FairMQ depends on.
-  * `${FairMQ_FairLogger_VERSION}` contains the minimum FairLogger version FairMQ requires.
-  * ... TODO
+| Variable | Info |
+| --- | --- |
+| `${FairMQ_PACKAGE_DEPENDENCIES}` | the list of public package dependencies |
+| `${FairMQ_<dep>_VERSION}` | the minimum `<dep>` version FairMQ requires |
+| `${FairMQ_<dep>_COMPONENTS}` | the list of `<dep>` components FairMQ depends on |
+| `${FairMQ_PACKAGE_COMPONENTS}` | the list of components FairMQ consists of |
+| `${FairMQ_#COMPONENT#_FOUND}` | `TRUE` if this component was built |
+| `${FairMQ_VERSION}` | the version in format `MAJOR.MINOR.PATCH` |
+| `${FairMQ_GIT_VERSION}` | the version in the format returned by `git describe --tags --dirty --match "v*"` |
+| `${FairMQ_PREFIX}` | the actual installation prefix |
+| `${FairMQ_BINDIR}` | the installation bin directory |
+| `${FairMQ_INCDIR}` | the installation include directory |
+| `${FairMQ_LIBDIR}` | the installation lib directory |
+| `${FairMQ_DATADIR}` | the installation data directory (`../share/fairmq`) |
+| `${FairMQ_CMAKEMODDIR}` | the installation directory of shipped CMake find modules |
+| `${FairMQ_BUILD_TYPE}` | the value of `CMAKE_BUILD_TYPE` at build-time |
+| `${FairMQ_CXX_FLAGS}` | the values of `CMAKE_CXX_FLAGS` and `CMAKE_CXX_FLAGS_${CMAKE_BUILD_TYPE}` at build-time |
 
 ## Documentation
 
-Standard [FairRoot](https://github.com/FairRootGroup/FairRoot) is running all the different analysis tasks within one process. FairMQ ([Message Queue](http://en.wikipedia.org/wiki/Message_queue)) allows starting tasks on different processes and provides the communication layer between these processes.
-
 1. [Device](docs/Device.md#1-device)
    1. [Topology](docs/Device.md#11-topology)
    2. [Communication Patterns](docs/Device.md#12-communication-patterns)
@@ -114,6 +159,9 @@ Standard [FairRoot](https://github.com/FairRootGroup/FairRoot) is running all th
     3. [Introspection](docs/Configuration.md#33-introspection)
 4. [Development](docs/Development.md#4-development)
    1. [Testing](docs/Development.md#41-testing)
+   2. [Static Analysis](docs/Development.md#42-static-analysis)
+      1. [CMake Integration](docs/Development.md#421-cmake-integration)
+      2. [Extra Compiler Arguments](docs/Development.md#422-extra-compiler-arguments)
 5. [Logging](docs/Logging.md#5-logging)
    1. [Log severity](docs/Logging.md#51-log-severity)
    2. [Log verbosity](docs/Logging.md#52-log-verbosity)
@@ -121,9 +169,8 @@ Standard [FairRoot](https://github.com/FairRootGroup/FairRoot) is running all th
    4. [File output](docs/Logging.md#54-file-output)
    5. [Custom sinks](docs/Logging.md#55-custom-sinks)
 6. [Examples](docs/Examples.md#6-examples)
-
-## License
-
-GNU Lesser General Public Licence (LGPL) version 3, see [LICENSE](LICENSE).
-
-Copyright (C) 2013-2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH
+7. [Plugins](docs/Plugins.md#7-plugins)
+   1. [Usage](docs/Plugins.md#71-usage)
+   2. [Development](docs/Plugins.md#72-development)
+   3. [Provided Plugins](docs/Plugins.md#73-provided-plugins)
+       1. [PMIx](docs/Plugins.md#731-pmix)

cmake/FairCMakeModules.cmake

@@ -0,0 +1,19 @@
+################################################################################
+#    Copyright (C) 2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+include_guard(GLOBAL)
+
+include(FairMQBundlePackageHelper)
+
+set(PROJECT_FairCMakeModules_VERSION 0.2)
+find_package(FairCMakeModules ${PROJECT_FairCMakeModules_VERSION} QUIET)
+
+if(NOT FairCMakeModules_FOUND AND NOT FairCMakeModules_BUNDLED)
+  build_bundled(FairCMakeModules extern/FairCMakeModules)
+  find_package(FairCMakeModules REQUIRED)
+endif()

cmake/FairMQBuildOption.cmake

@@ -0,0 +1,50 @@
+################################################################################
+# Copyright (C) 2018-2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+include_guard(GLOBAL)
+
+include(CMakeDependentOption)
+
+macro(fairmq_build_option option description)
+  cmake_parse_arguments(ARGS "" "DEFAULT" "REQUIRES" ${ARGN})
+
+  if(ARGS_DEFAULT)
+    set(__default__ ON)
+  else()
+    set(__default__ OFF)
+  endif()
+
+  if(ARGS_REQUIRES)
+    set(__requires__ ${ARGS_REQUIRES})
+    foreach(d ${__requires__})
+      string(REGEX REPLACE " +" ";" __requires_condition__ "${d}")
+      if(${__requires_condition__})
+      else()
+        if(${option})
+          message(FATAL_ERROR "Cannot enable build option ${option}, depending option is not set: ${__requires_condition__}")
+        endif()
+      endif()
+    endforeach()
+  else()
+    set(__requires__)
+  endif()
+
+  if(__requires__)
+    cmake_dependent_option(${option} ${description} ${__default__} "${__requires__}" OFF)
+  else()
+    option(${option} ${description} ${__default__})
+  endif()
+
+  set(__default__)
+  set(__requires__)
+  set(__requires_condition__)
+  set(ARGS_DEFAULT)
+  set(ARGS_REQUIRES)
+  set(option)
+  set(description)
+endmacro()

cmake/FairMQBundlePackageHelper.cmake

@@ -0,0 +1,92 @@
+################################################################################
+# Copyright (C) 2018-2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+include_guard(GLOBAL)
+
+if(NOT DEFINED ${GIT_EXECUTABLE})
+  find_program(GIT_EXECUTABLE NAMES git)
+endif()
+
+# TODO Deduplicate code
+
+macro(exec cmd)
+  list(JOIN ARGN " " args)
+  file(APPEND ${${package}_BUILD_LOGFILE} ">>> ${cmd} ${args}\n")
+
+  execute_process(COMMAND ${cmd} ${ARGN}
+    WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+    OUTPUT_VARIABLE log
+    ERROR_VARIABLE log
+    RESULT_VARIABLE res
+  )
+  file(APPEND ${${package}_BUILD_LOGFILE} ${log})
+
+  if(res)
+    message(FATAL_ERROR "${res} \nSee also \"${${package}_BUILD_LOGFILE}\"")
+  endif()
+endmacro()
+
+macro(exec_source cmd)
+  list(JOIN ARGN " " args)
+  file(APPEND ${${package}_BUILD_LOGFILE} ">>> ${cmd} ${args}\n")
+
+  execute_process(COMMAND ${cmd} ${ARGN}
+    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+    OUTPUT_VARIABLE log
+    ERROR_VARIABLE log
+    RESULT_VARIABLE res
+  )
+  file(APPEND ${${package}_BUILD_LOGFILE} ${log})
+
+  if(res)
+    message(FATAL_ERROR "${res} \nSee also \"${${package}_BUILD_LOGFILE}\"")
+  endif()
+endmacro()
+
+function(build_bundled package bundle)
+  message(STATUS "Building bundled ${package}")
+
+  set(${package}_SOURCE_DIR ${CMAKE_SOURCE_DIR}/${bundle})
+  set(${package}_BINARY_DIR ${CMAKE_BINARY_DIR}/${bundle})
+  file(MAKE_DIRECTORY ${${package}_BINARY_DIR})
+  set(${package}_BUILD_LOGFILE ${${package}_BINARY_DIR}/build.log)
+  file(REMOVE ${${package}_BUILD_LOGFILE})
+
+  if(GIT_EXECUTABLE)
+    exec_source(${GIT_EXECUTABLE} submodule update --init -- ${${package}_SOURCE_DIR})
+  endif()
+
+  if(${package} STREQUAL GTest)
+    set(${package}_INSTALL_DIR ${CMAKE_BINARY_DIR}/${bundle}_install)
+    file(MAKE_DIRECTORY ${${package}_INSTALL_DIR})
+    set(${package}_PREFIX ${${package}_INSTALL_DIR})
+
+    exec(${CMAKE_COMMAND} -S ${${package}_SOURCE_DIR} -B ${${package}_BINARY_DIR} -G ${CMAKE_GENERATOR}
+      -DCMAKE_INSTALL_PREFIX=${${package}_INSTALL_DIR} -DBUILD_GMOCK=OFF
+    )
+    exec(${CMAKE_COMMAND} --build ${${package}_BINARY_DIR})
+    exec(${CMAKE_COMMAND} --build ${${package}_BINARY_DIR} --target install)
+  elseif(${package} STREQUAL FairCMakeModules)
+    set(${package}_INSTALL_DIR ${CMAKE_BINARY_DIR}/${bundle}_install)
+    file(MAKE_DIRECTORY ${${package}_INSTALL_DIR})
+    set(${package}_PREFIX ${${package}_INSTALL_DIR})
+
+    exec(${CMAKE_COMMAND} -S ${${package}_SOURCE_DIR} -B ${${package}_BINARY_DIR} -G ${CMAKE_GENERATOR}
+      -DCMAKE_INSTALL_PREFIX=${${package}_INSTALL_DIR}
+    )
+    exec(${CMAKE_COMMAND} --build ${${package}_BINARY_DIR})
+    exec(${CMAKE_COMMAND} --build ${${package}_BINARY_DIR} --target install)
+  elseif(${package} STREQUAL PicoSHA2)
+    set(${package}_PREFIX ${${package}_SOURCE_DIR})
+  endif()
+
+  set(${package}_ROOT ${${package}_PREFIX} CACHE PATH "Location of bundle package ${package}")
+  set(${package}_BUNDLED ON CACHE BOOL "Whether bundled ${package} was used")
+
+  message(STATUS "Building bundled ${package} - done")
+endfunction()

cmake/FairMQConfig.cmake.in

@@ -1,5 +1,5 @@
 ################################################################################
-#    Copyright (C) 2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    #
+# Copyright (C) 2018-2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
 #                                                                              #
 #              This software is distributed under the terms of the             #
 #              GNU Lesser General Public Licence (LGPL) version 3,             #
@@ -13,16 +13,17 @@ set(@PROJECT_NAME@_VERSION @PROJECT_VERSION@)
 set(@PROJECT_NAME@_GIT_VERSION @PROJECT_GIT_VERSION@)
 set(@PROJECT_NAME@_GIT_DATE @PROJECT_GIT_DATE@)
 
-set_and_check(@PROJECT_NAME@_ROOT @PACKAGE_CMAKE_INSTALL_PREFIX@)
-set_and_check(@PROJECT_NAME@_BINDIR @PACKAGE_CMAKE_INSTALL_PREFIX@/@PROJECT_INSTALL_BINDIR@)
-set_and_check(@PROJECT_NAME@_INCDIR @PACKAGE_CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_INCLUDEDIR@)
-set_and_check(@PROJECT_NAME@_LIBDIR @PACKAGE_CMAKE_INSTALL_PREFIX@/@PROJECT_INSTALL_LIBDIR@)
-set_and_check(@PROJECT_NAME@_DATADIR @PACKAGE_CMAKE_INSTALL_PREFIX@/@PROJECT_INSTALL_DATADIR@)
-set_and_check(@PROJECT_NAME@_CMAKEMODDIR @PACKAGE_CMAKE_INSTALL_PREFIX@/@PROJECT_INSTALL_CMAKEMODDIR@)
+set(@PROJECT_NAME@_PREFIX @PACKAGE_CMAKE_INSTALL_PREFIX@)
+set(@PROJECT_NAME@_BINDIR @PACKAGE_CMAKE_INSTALL_PREFIX@/@PROJECT_INSTALL_BINDIR@)
+set(@PROJECT_NAME@_INCDIR @PACKAGE_CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_INCLUDEDIR@)
+set(@PROJECT_NAME@_LIBDIR @PACKAGE_CMAKE_INSTALL_PREFIX@/@PROJECT_INSTALL_LIBDIR@)
+set(@PROJECT_NAME@_DATADIR @PACKAGE_CMAKE_INSTALL_PREFIX@/@PROJECT_INSTALL_DATADIR@)
+set(@PROJECT_NAME@_CMAKEMODDIR @PACKAGE_CMAKE_INSTALL_PREFIX@/@PROJECT_INSTALL_CMAKEMODDIR@)
 
-set(@PROJECT_NAME@_CXX_STANDARD_REQUIRED @CMAKE_CXX_STANDARD_REQUIRED@)
-set(@PROJECT_NAME@_CXX_STANDARD @CMAKE_CXX_STANDARD@)
-set(@PROJECT_NAME@_CXX_EXTENSIONS @CMAKE_CXX_EXTENSIONS@)
+set(@PROJECT_NAME@_VERSION_HOTFIX @PROJECT_VERSION_HOTFIX@)
+set(@PROJECT_NAME@_BUILD_TYPE @CMAKE_BUILD_TYPE@)
+set(@PROJECT_NAME@_BUILD_TYPE_UPPER @PROJECT_BUILD_TYPE_UPPER@)
+set(@PROJECT_NAME@_CXX_FLAGS @PROJECT_CXX_FLAGS@)
 
 ### Import cmake modules
 set(CMAKE_MODULE_PATH ${@PROJECT_NAME@_CMAKEMODDIR} ${CMAKE_MODULE_PATH})
@@ -32,9 +33,4 @@ set(CMAKE_MODULE_PATH ${@PROJECT_NAME@_CMAKEMODDIR} ${CMAKE_MODULE_PATH})
 ### Import targets
 include(@PACKAGE_CMAKE_INSTALL_PREFIX@/@PACKAGE_INSTALL_DESTINATION@/@PROJECT_EXPORT_SET@.cmake)
 
-### Alias target for backwards compat (DEPRECATED)
-if(NOT TARGET FairRoot::@PROJECT_NAME@)
-  add_library(FairRoot::@PROJECT_NAME@ ALIAS @PROJECT_NAME@::@PROJECT_NAME@)
-endif()
-
 @PACKAGE_COMPONENTS@

cmake/FairMQDependencies.cmake

@@ -0,0 +1,107 @@
+################################################################################
+# Copyright (C) 2018-2025 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+include_guard(GLOBAL)
+
+include(FairCMakeModules)
+include(FairFindPackage2)
+include(FairMQBundlePackageHelper)
+
+if(BUILD_FAIRMQ)
+  set(THREADS_PREFER_PTHREAD_FLAG TRUE)
+  find_package2(PUBLIC Threads REQUIRED)
+  set(Threads_PREFIX "<system>")
+endif()
+
+if(BUILD_FAIRMQ OR BUILD_TIDY_TOOL)
+  find_package2(PUBLIC FairLogger REQUIRED VERSION 1.6.0)
+  find_package2(PUBLIC Boost REQUIRED VERSION 1.66
+    COMPONENTS container program_options filesystem date_time regex
+  )
+endif()
+
+if(BUILD_FAIRMQ)
+  find_package2(PRIVATE ZeroMQ REQUIRED VERSION 4.1.4)
+  if(NOT PicoSHA2_BUNDLED)
+    build_bundled(PicoSHA2 extern/PicoSHA2)
+  endif()
+  find_package2(BUNDLED PicoSHA2 REQUIRED)
+  set(PicoSHA2_VERSION "1.0.0")
+  set(PicoSHA2_PREFIX "<bundled>")
+endif()
+
+if(BUILD_TESTING)
+  if(NOT GTest_FOUND AND NOT GTest_BUNDLED AND NOT USE_EXTERNAL_GTEST)
+    build_bundled(GTest extern/googletest)
+  endif()
+  find_package2(BUNDLED GTest REQUIRED)
+  if(GTest_BUNDLED)
+    set(GTest_VERSION "Dec 26 2024 @7d76a23")
+    set(GTest_PREFIX "<bundled>")
+  endif()
+endif()
+
+if(BUILD_DOCS)
+  find_package2(PRIVATE Doxygen REQUIRED VERSION 1.8.8
+    COMPONENTS dot
+  )
+endif()
+
+if(BUILD_TIDY_TOOL)
+  find_package2(PRIVATE LLVM REQUIRED)
+  find_package2(PRIVATE Clang REQUIRED)
+  set(Clang_VERSION ${LLVM_VERSION})
+  find_package2(PRIVATE CLI11 REQUIRED)
+endif()
+
+find_package2_implicit_dependencies() # Always call last after latest find_package2
+
+if(PROJECT_PACKAGE_DEPENDENCIES)
+  foreach(dep IN LISTS PROJECT_PACKAGE_DEPENDENCIES)
+    string(TOUPPER ${dep} dep_upper)
+    if(${dep}_BUNDLED)
+      set(${dep}_PREFIX "<bundled>")
+    elseif(${dep} STREQUAL FairLogger)
+      if(NOT FairLogger_PREFIX AND FairLogger_ROOT)
+        set(FairLogger_PREFIX ${FairLogger_ROOT})
+      endif()
+    elseif(${dep} STREQUAL Boost)
+      if(TARGET Boost::headers)
+        get_target_property(boost_include Boost::headers INTERFACE_INCLUDE_DIRECTORIES)
+      else()
+        get_target_property(boost_include Boost::boost INTERFACE_INCLUDE_DIRECTORIES)
+      endif()
+      get_filename_component(Boost_PREFIX ${boost_include}/.. ABSOLUTE)
+      unset(boost_include)
+    elseif(${dep} STREQUAL Doxygen)
+      get_target_property(doxygen_bin Doxygen::doxygen INTERFACE_LOCATION)
+      get_filename_component(Doxygen_PREFIX ${doxygen_bin} DIRECTORY)
+      get_filename_component(Doxygen_PREFIX ${Doxygen_PREFIX}/.. ABSOLUTE)
+      unset(doxygen_bin)
+    elseif(NOT ${dep}_PREFIX)
+      # try to guess
+      if(TARGET ${dep}::${dep})
+        get_target_property(${dep}_include ${dep}::${dep} INTERFACE_INCLUDE_DIRECTORIES)
+        get_filename_component(${dep}_PREFIX ${${dep}_include}/.. ABSOLUTE)
+        unset(${dep}_include)
+      elseif(${dep}_INCLUDE_DIR)
+        get_filename_component(${dep}_PREFIX ${${dep}_INCLUDE_DIR}/.. ABSOLUTE)
+      elseif(${dep_upper}_INCLUDE_DIR)
+        get_filename_component(${dep}_PREFIX ${${dep_upper}_INCLUDE_DIR}/.. ABSOLUTE)
+      elseif(${dep}_INCLUDE_DIRS)
+        list(GET ${dep}_INCLUDE_DIRS 0 ${dep}_include)
+        get_filename_component(${dep}_PREFIX ${${dep}_include}/.. ABSOLUTE)
+        unset(${dep}_include)
+      elseif(${dep_upper}_INCLUDE_DIRS)
+        list(GET ${dep_upper}_INCLUDE_DIRS 0 ${dep}_include)
+        get_filename_component(${dep}_PREFIX ${${dep}_include}/.. ABSOLUTE)
+        unset(${dep}_include)
+      endif()
+    endif()
+  endforeach()
+endif()

cmake/FairMQLib.cmake

@@ -1,287 +0,0 @@
-################################################################################
-#    Copyright (C) 2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    #
-#                                                                              #
-#              This software is distributed under the terms of the             #
-#              GNU Lesser General Public Licence (LGPL) version 3,             #
-#                  copied verbatim in the file "LICENSE"                       #
-################################################################################
-
-### PUBLIC
-
-# Defines some variables with console color escape sequences
-if(NOT WIN32 AND NOT DISABLE_COLOR)
-  string(ASCII 27 Esc)
-  set(CR       "${Esc}[m")
-  set(CB       "${Esc}[1m")
-  set(Red      "${Esc}[31m")
-  set(Green    "${Esc}[32m")
-  set(Yellow   "${Esc}[33m")
-  set(Blue     "${Esc}[34m")
-  set(Magenta  "${Esc}[35m")
-  set(Cyan     "${Esc}[36m")
-  set(White    "${Esc}[37m")
-  set(BRed     "${Esc}[1;31m")
-  set(BGreen   "${Esc}[1;32m")
-  set(BYellow  "${Esc}[1;33m")
-  set(BBlue    "${Esc}[1;34m")
-  set(BMagenta "${Esc}[1;35m")
-  set(BCyan    "${Esc}[1;36m")
-  set(BWhite   "${Esc}[1;37m")
-endif()
-
-# set_fairmq_cmake_policies()
-#
-# Sets CMake policies.
-macro(set_fairmq_cmake_policies)
-  # Find more details to each policy with cmake --help-policy CMPXXXX
-  foreach(policy
-    CMP0025 # Compiler id for Apple Clang is now AppleClang.
-    CMP0028 # Double colon in target name means ALIAS or IMPORTED target.
-    CMP0042 # MACOSX_RPATH is enabled by default.
-    CMP0048 # The ``project()`` command manages VERSION variables.
-    CMP0054 # Only interpret ``if()`` arguments as variables or keywords when unquoted.
-  )
-    if(POLICY ${policy})
-      cmake_policy(SET ${policy} NEW)
-    endif()
-  endforeach()
-endmacro()
-
-
-find_package(Git)
-# get_git_version([DEFAULT_VERSION version] [DEFAULT_DATE date] [OUTVAR_PREFIX prefix])
-#
-# Sets variables #prefix#_VERSION, #prefix#_GIT_VERSION, #prefix#_DATE, #prefix#_GIT_DATE
-function(get_git_version)
-  cmake_parse_arguments(ARGS "" "DEFAULT_VERSION;DEFAULT_DATE;OUTVAR_PREFIX" "" ${ARGN})
-
-  if(NOT ARGS_OUTVAR_PREFIX)
-    set(ARGS_OUTVAR_PREFIX PROJECT)
-  endif()
-
-  if(GIT_FOUND AND EXISTS ${CMAKE_SOURCE_DIR}/.git)
-    execute_process(COMMAND ${GIT_EXECUTABLE} describe --tags --dirty --match "v*"
-      OUTPUT_VARIABLE ${ARGS_OUTVAR_PREFIX}_GIT_VERSION
-      OUTPUT_STRIP_TRAILING_WHITESPACE
-      WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-    )
-    if(${ARGS_OUTVAR_PREFIX}_GIT_VERSION)
-      # cut first two characters "v-"
-      string(SUBSTRING ${${ARGS_OUTVAR_PREFIX}_GIT_VERSION} 1 -1 ${ARGS_OUTVAR_PREFIX}_GIT_VERSION)
-    endif()
-    execute_process(COMMAND ${GIT_EXECUTABLE} log -1 --format=%cd
-      OUTPUT_VARIABLE ${ARGS_OUTVAR_PREFIX}_GIT_DATE
-      OUTPUT_STRIP_TRAILING_WHITESPACE
-      WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-    )
-  endif()
-
-  if(NOT ${ARGS_OUTVAR_PREFIX}_GIT_VERSION)
-    if(ARGS_DEFAULT_VERSION)
-      set(${ARGS_OUTVAR_PREFIX}_GIT_VERSION ${ARGS_DEFAULT_VERSION})
-    else()
-      set(${ARGS_OUTVAR_PREFIX}_GIT_VERSION 0.0.0.0)
-    endif()
-  endif()
-
-  if(NOT ${ARGS_OUTVAR_PREFIX}_GIT_DATE)
-    if(ARGS_DEFAULT_DATE)
-      set(${ARGS_OUTVAR_PREFIX}_GIT_DATE ${ARGS_DEFAULT_DATE})
-    else()
-      set(${ARGS_OUTVAR_PREFIX}_GIT_DATE "Thu Jan 1 00:00:00 1970 +0000")
-    endif()
-  endif()
-
-  string(REGEX MATCH "^([^-]*)" blubb ${${ARGS_OUTVAR_PREFIX}_GIT_VERSION})
-
-  # return values
-  set(${ARGS_OUTVAR_PREFIX}_VERSION ${CMAKE_MATCH_0} PARENT_SCOPE)
-  set(${ARGS_OUTVAR_PREFIX}_DATE ${${ARGS_OUTVAR_PREFIX}_GIT_DATE} PARENT_SCOPE)
-  set(${ARGS_OUTVAR_PREFIX}_GIT_VERSION ${${ARGS_OUTVAR_PREFIX}_GIT_VERSION} PARENT_SCOPE)
-  set(${ARGS_OUTVAR_PREFIX}_GIT_DATE ${${ARGS_OUTVAR_PREFIX}_GIT_DATE} PARENT_SCOPE)
-endfunction()
-
-
-# Set defaults
-macro(set_fairmq_defaults)
-  string(TOLOWER ${PROJECT_NAME} PROJECT_NAME_LOWER)
-  string(TOUPPER ${PROJECT_NAME} PROJECT_NAME_UPPER)
-
-  # Set a default build type
-  if(NOT CMAKE_BUILD_TYPE)
-    set(CMAKE_BUILD_TYPE RelWithDebInfo)
-  endif()
-
-  # Handle C++ standard level
-  set(CMAKE_CXX_STANDARD_REQUIRED ON)
-  if(NOT CMAKE_CXX_STANDARD)
-    set(CMAKE_CXX_STANDARD 11)
-  elseif(${CMAKE_CXX_STANDARD} LESS 11)
-    message(FATAL_ERROR "A minimum CMAKE_CXX_STANDARD of 11 is required.")
-  endif()
-  if(NOT CMAKE_CXX_EXTENSIONS)
-    set(CMAKE_CXX_EXTENSIONS OFF)
-  endif()
-
-  # Set -fpic as default for all library types
-  set(CMAKE_POSITION_INDEPENDENT_CODE ON)
-
-  # Generate compile_commands.json file (https://clang.llvm.org/docs/JSONCompilationDatabase.html)
-  set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
-
-  # Define CMAKE_INSTALL_*DIR family of variables
-  include(GNUInstallDirs)
-
-  # Define install dirs
-  set(PROJECT_INSTALL_BINDIR ${CMAKE_INSTALL_BINDIR})
-  set(PROJECT_INSTALL_LIBDIR ${CMAKE_INSTALL_LIBDIR})
-  set(PROJECT_INSTALL_INCDIR ${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME_LOWER})
-  set(PROJECT_INSTALL_DATADIR ${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME_LOWER})
-  set(PROJECT_INSTALL_CMAKEMODDIR ${PROJECT_INSTALL_DATADIR}/cmake)
-
-  # https://cmake.org/Wiki/CMake_RPATH_handling
-  set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
-  list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_LIBDIR}" isSystemDir)
-  if("${isSystemDir}" STREQUAL "-1")
-    if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
-      set(CMAKE_EXE_LINKER_FLAGS ${CMAKE_EXE_LINKER_FLAGS} "-Wl,--enable-new-dtags")
-      set(CMAKE_SHARED_LINKER_FLAGS ${CMAKE_SHARED_LINKER_FLAGS} "-Wl,--enable-new-dtags")
-      set(CMAKE_INSTALL_RPATH "$ORIGIN/../${PROJECT_INSTALL_LIBDIR}")
-    elseif(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
-      set(CMAKE_INSTALL_RPATH "@loader_path/../${PROJECT_INSTALL_LIBDIR}")
-    else()
-      set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_LIBDIR}")
-    endif()
-  endif()
-
-  # Define export set, only one for now
-  set(PROJECT_EXPORT_SET ${PROJECT_NAME}Targets)
-endmacro()
-
-function(join VALUES GLUE OUTPUT)
-  string(REGEX REPLACE "([^\\]|^);" "\\1${GLUE}" _TMP_STR "${VALUES}")
-  string(REGEX REPLACE "[\\](.)" "\\1" _TMP_STR "${_TMP_STR}") #fixes escaping
-  set(${OUTPUT} "${_TMP_STR}" PARENT_SCOPE)
-endfunction()
-
-function(pad str width char out)
-  string(LENGTH ${str} length)
-  math(EXPR padding "${width}-${length}")
-  if(padding GREATER 0)
-    foreach(i RANGE ${padding})
-      set(str "${str}${char}")
-    endforeach()
-  endif()
-  set(${out} ${str} PARENT_SCOPE)
-endfunction()
-
-function(generate_package_dependencies)
-  join("${PROJECT_INTERFACE_PACKAGE_DEPENDENCIES}" " " DEPS)
-  set(PACKAGE_DEPENDENCIES "\
-####### Expanded from @PACKAGE_DEPENDENCIES@ by configure_package_config_file() #######
-
-set(${PROJECT_NAME}_PACKAGE_DEPENDENCIES ${DEPS})
-
-")
-  foreach(dep IN LISTS PROJECT_INTERFACE_PACKAGE_DEPENDENCIES)
-    join("${PROJECT_INTERFACE_${dep}_COMPONENTS}" " " COMPS)
-    if(COMPS)
-      string(CONCAT PACKAGE_DEPENDENCIES ${PACKAGE_DEPENDENCIES} "\
-set(${PROJECT_NAME}_${dep}_COMPONENTS ${COMPS})
-")
-    endif()
-    if(PROJECT_INTERFACE_${dep}_VERSION)
-      string(CONCAT PACKAGE_DEPENDENCIES ${PACKAGE_DEPENDENCIES} "\
-set(${PROJECT_NAME}_${dep}_VERSION ${PROJECT_INTERFACE_${dep}_VERSION})
-")
-    endif()
-  endforeach()
-  string(CONCAT PACKAGE_DEPENDENCIES ${PACKAGE_DEPENDENCIES} "\
-
-#######################################################################################
-")
-set(PACKAGE_DEPENDENCIES ${PACKAGE_DEPENDENCIES} PARENT_SCOPE)
-endfunction()
-
-function(generate_package_components)
-  join("${PROJECT_PACKAGE_COMPONENTS}" " " COMPS)
-  set(PACKAGE_COMPONENTS "\
-####### Expanded from @PACKAGE_COMPONENTS@ by configure_package_config_file() #########
-
-set(${PROJECT_NAME}_PACKAGE_COMPONENTS ${COMPS})
-
-")
-  foreach(comp IN LISTS PROJECT_PACKAGE_COMPONENTS)
-    string(CONCAT PACKAGE_COMPONENTS ${PACKAGE_COMPONENTS} "\
-set(${PROJECT_NAME}_${comp}_FOUND TRUE)
-")
-  endforeach()
-  string(CONCAT PACKAGE_COMPONENTS ${PACKAGE_COMPONENTS} "\
-
-check_required_components(${PROJECT_NAME})
-")
-set(PACKAGE_COMPONENTS ${PACKAGE_COMPONENTS} PARENT_SCOPE)
-endfunction()
-
-# Configure/Install CMake package
-macro(install_cmake_package)
-  include(CMakePackageConfigHelpers)
-  set(PACKAGE_INSTALL_DESTINATION
-    ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}-${PROJECT_VERSION}
-  )
-  install(EXPORT ${PROJECT_EXPORT_SET}
-    NAMESPACE ${PROJECT_NAME}::
-    DESTINATION ${PACKAGE_INSTALL_DESTINATION}
-    EXPORT_LINK_INTERFACE_LIBRARIES
-  )
-  write_basic_package_version_file(
-    ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake
-    VERSION ${PROJECT_VERSION}
-    COMPATIBILITY AnyNewerVersion
-  )
-  generate_package_dependencies() # fills ${PACKAGE_DEPENDENCIES}
-  generate_package_components() # fills ${PACKAGE_COMPONENTS}
-  configure_package_config_file(
-    ${CMAKE_SOURCE_DIR}/cmake/${PROJECT_NAME}Config.cmake.in
-    ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake
-    INSTALL_DESTINATION ${PACKAGE_INSTALL_DESTINATION}
-    PATH_VARS CMAKE_INSTALL_PREFIX
-  )
-  install(FILES
-    ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake
-    ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake
-    DESTINATION ${PACKAGE_INSTALL_DESTINATION}
-  )
-endmacro()
-
-function(find_package2 qualifier pkgname)
-  cmake_parse_arguments(ARGS "" "VERSION" "COMPONENTS" ${ARGN})
-
-  string(TOUPPER ${pkgname} pkgname_upper)
-  set(CMAKE_PREFIX_PATH ${${pkgname_upper}_ROOT} $ENV{${pkgname_upper}_ROOT} ${CMAKE_PREFIX_PATH})
-  if(ARGS_COMPONENTS)
-    find_package(${pkgname} ${ARGS_VERSION} QUIET COMPONENTS ${ARGS_COMPONENTS} ${ARGS_UNPARSED_ARGUMENTS})
-  else()
-    find_package(${pkgname} ${ARGS_VERSION} QUIET ${ARGS_UNPARSED_ARGUMENTS})
-  endif()
-
-  set(${pkgname}_VERSION ${${pkgname}_VERSION} PARENT_SCOPE)
-  set(${pkgname}_MAJOR_VERSION ${${pkgname}_MAJOR_VERSION} PARENT_SCOPE)
-  set(${pkgname}_MINOR_VERSION ${${pkgname}_MINOR_VERSION} PARENT_SCOPE)
-  if(qualifier STREQUAL PRIVATE)
-    set(PROJECT_${pkgname}_VERSION ${ARGS_VERSION} PARENT_SCOPE)
-    set(PROJECT_${pkgname}_COMPONENTS ${ARGS_COMPONENTS} PARENT_SCOPE)
-    set(PROJECT_PACKAGE_DEPENDENCIES ${PROJECT_PACKAGE_DEPENDENCIES} ${pkgname} PARENT_SCOPE)
-  elseif(qualifier STREQUAL PUBLIC)
-    set(PROJECT_${pkgname}_VERSION ${ARGS_VERSION} PARENT_SCOPE)
-    set(PROJECT_${pkgname}_COMPONENTS ${ARGS_COMPONENTS} PARENT_SCOPE)
-    set(PROJECT_PACKAGE_DEPENDENCIES ${PROJECT_PACKAGE_DEPENDENCIES} ${pkgname} PARENT_SCOPE)
-    set(PROJECT_INTERFACE_${pkgname}_VERSION ${ARGS_VERSION} PARENT_SCOPE)
-    set(PROJECT_INTERFACE_${pkgname}_COMPONENTS ${ARGS_COMPONENTS} PARENT_SCOPE)
-    set(PROJECT_INTERFACE_PACKAGE_DEPENDENCIES ${PROJECT_INTERFACE_PACKAGE_DEPENDENCIES} ${pkgname} PARENT_SCOPE)
-  elseif(qualifier STREQUAL INTERFACE)
-    set(PROJECT_INTERFACE_${pkgname}_VERSION ${ARGS_VERSION} PARENT_SCOPE)
-    set(PROJECT_INTERFACE_${pkgname}_COMPONENTS ${ARGS_COMPONENTS} PARENT_SCOPE)
-    set(PROJECT_INTERFACE_PACKAGE_DEPENDENCIES ${PROJECT_INTERFACE_PACKAGE_DEPENDENCIES} ${pkgname} PARENT_SCOPE)
-  endif()
-endfunction()

cmake/FairMQPackage.cmake

@@ -0,0 +1,68 @@
+################################################################################
+# Copyright (C) 2018-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+include_guard(GLOBAL)
+
+include(FairCMakeModules)
+include(FairFindPackage2)
+include(FairMQBundlePackageHelper)
+
+function(generate_package_components)
+  list(JOIN PROJECT_PACKAGE_COMPONENTS} " " COMPS)
+  set(PACKAGE_COMPONENTS "\
+####### Expanded from @PACKAGE_COMPONENTS@ by configure_package_config_file() #########
+
+set(${PROJECT_NAME}_PACKAGE_COMPONENTS ${COMPS})
+
+")
+  foreach(comp IN LISTS PROJECT_PACKAGE_COMPONENTS)
+    string(CONCAT PACKAGE_COMPONENTS ${PACKAGE_COMPONENTS} "\
+set(${PROJECT_NAME}_${comp}_FOUND TRUE)
+")
+  endforeach()
+  string(CONCAT PACKAGE_COMPONENTS ${PACKAGE_COMPONENTS} "\
+
+check_required_components(${PROJECT_NAME})
+")
+set(PACKAGE_COMPONENTS ${PACKAGE_COMPONENTS} PARENT_SCOPE)
+endfunction()
+
+# Configure/Install CMake package
+macro(install_cmake_package)
+  include(CMakePackageConfigHelpers)
+  set(PACKAGE_INSTALL_DESTINATION
+    ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}-${PROJECT_VERSION}
+  )
+  if(BUILD_FAIRMQ)
+    install(EXPORT ${PROJECT_EXPORT_SET}
+      NAMESPACE ${PROJECT_NAME}::
+      DESTINATION ${PACKAGE_INSTALL_DESTINATION}
+      EXPORT_LINK_INTERFACE_LIBRARIES
+    )
+  endif()
+  write_basic_package_version_file(
+    ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake
+    VERSION ${PROJECT_VERSION}
+    COMPATIBILITY AnyNewerVersion
+  )
+  fair_generate_package_dependencies() # fills ${PACKAGE_DEPENDENCIES}
+  generate_package_components() # fills ${PACKAGE_COMPONENTS}
+  string(TOUPPER ${CMAKE_BUILD_TYPE} PROJECT_BUILD_TYPE_UPPER)
+  set(PROJECT_CXX_FLAGS ${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_${PROJECT_BUILD_TYPE_UPPER}})
+  configure_package_config_file(
+    ${CMAKE_SOURCE_DIR}/cmake/${PROJECT_NAME}Config.cmake.in
+    ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake
+    INSTALL_DESTINATION ${PACKAGE_INSTALL_DESTINATION}
+    PATH_VARS CMAKE_INSTALL_PREFIX
+  )
+  install(FILES
+    ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake
+    ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake
+    DESTINATION ${PACKAGE_INSTALL_DESTINATION}
+  )
+endmacro()

cmake/FairMQProjectSettings.cmake

@@ -0,0 +1,189 @@
+################################################################################
+# Copyright (C) 2018-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+include_guard(GLOBAL)
+
+include(GNUInstallDirs)
+
+string(TOLOWER ${PROJECT_NAME} PROJECT_NAME_LOWER)
+string(TOUPPER ${PROJECT_NAME} PROJECT_NAME_UPPER)
+
+# Set a default build type
+if(NOT CMAKE_BUILD_TYPE)
+  set(CMAKE_BUILD_TYPE RelWithDebInfo)
+endif()
+
+set(PROJECT_MIN_CXX_STANDARD 17)
+
+# Handle C++ standard level
+if(CMAKE_CXX_STANDARD AND CMAKE_CXX_STANDARD VERSION_LESS PROJECT_MIN_CXX_STANDARD)
+  message(FATAL_ERROR "A minimum CMAKE_CXX_STANDARD of ${PROJECT_MIN_CXX_STANDARD} is required.")
+endif()
+if(NOT DEFINED CMAKE_CXX_EXTENSIONS)
+  set(CMAKE_CXX_EXTENSIONS OFF)
+endif()
+
+if(NOT BUILD_SHARED_LIBS)
+  set(BUILD_SHARED_LIBS ON CACHE BOOL "Whether to build shared libraries or static archives")
+endif()
+
+# Set -fPIC as default for all library types
+if(NOT CMAKE_POSITION_INDEPENDENT_CODE)
+  set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+endif()
+
+# Generate compile_commands.json file (https://clang.llvm.org/docs/JSONCompilationDatabase.html)
+set(CMAKE_EXPORT_COMPILE_COMMANDS "ON")
+
+# Define install dirs
+set(PROJECT_INSTALL_BINDIR ${CMAKE_INSTALL_BINDIR})
+set(PROJECT_INSTALL_LIBDIR ${CMAKE_INSTALL_LIBDIR})
+set(PROJECT_INSTALL_INCDIR ${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME_LOWER})
+set(PROJECT_INSTALL_DATADIR ${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME_LOWER})
+set(PROJECT_INSTALL_CMAKEMODDIR ${PROJECT_INSTALL_DATADIR}/cmake)
+
+# https://cmake.org/Wiki/CMake_RPATH_handling
+if(NOT DEFINED CMAKE_INSTALL_RPATH_USE_LINK_PATH)
+  set(CMAKE_INSTALL_RPATH_USE_LINK_PATH ON)
+endif()
+list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_LIBDIR}" isSystemDir)
+if("${isSystemDir}" STREQUAL "-1")
+  if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
+    list(APPEND CMAKE_EXE_LINKER_FLAGS "-Wl,--enable-new-dtags")
+    list(APPEND CMAKE_SHARED_LINKER_FLAGS "-Wl,--enable-new-dtags")
+    list(PREPEND CMAKE_INSTALL_RPATH "$ORIGIN/../${PROJECT_INSTALL_LIBDIR}")
+  elseif(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
+    list(PREPEND CMAKE_INSTALL_RPATH "@loader_path/../${PROJECT_INSTALL_LIBDIR}")
+  else()
+    list(PREPEND CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_LIBDIR}")
+  endif()
+endif()
+
+# Define export set, only one for now
+set(PROJECT_EXPORT_SET ${PROJECT_NAME}Targets)
+
+# Sanitizers
+set(_sanitizers "")
+
+option(ENABLE_SANITIZER_ADDRESS "Enable address sanitizer" FALSE)
+if(ENABLE_SANITIZER_ADDRESS)
+  list(APPEND _sanitizers "address")
+endif()
+
+option(ENABLE_SANITIZER_LEAK "Enable leak sanitizer" FALSE)
+if(ENABLE_SANITIZER_LEAK)
+  list(APPEND _sanitizers "leak")
+endif()
+
+option(ENABLE_SANITIZER_UNDEFINED_BEHAVIOR "Enable undefined behavior sanitizer" FALSE)
+if(ENABLE_SANITIZER_UNDEFINED_BEHAVIOR)
+  list(APPEND _sanitizers "undefined")
+endif()
+
+option(ENABLE_SANITIZER_THREAD "Enable thread sanitizer" FALSE)
+if(ENABLE_SANITIZER_THREAD)
+  if("address" IN_LIST _sanitizers OR "leak" IN_LIST _sanitizers)
+    message(WARNING "Thread sanitizer does not work with Address and Leak sanitizer enabled")
+  else()
+    list(APPEND _sanitizers "thread")
+  endif()
+endif()
+
+option(ENABLE_SANITIZER_MEMORY "Enable memory sanitizer" FALSE)
+if(ENABLE_SANITIZER_MEMORY AND CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
+  if("address" IN_LIST _sanitizers
+     OR "thread" IN_LIST _sanitizers
+     OR "leak" IN_LIST _sanitizers)
+    message(WARNING "Memory sanitizer does not work with Address, Thread and Leak sanitizer enabled")
+  else()
+    list(APPEND _sanitizers "memory")
+  endif()
+endif()
+
+list(JOIN _sanitizers "," _sanitizers)
+if(_sanitizers)
+  set(_sanitizers "-fsanitize=${_sanitizers}")
+endif()
+
+# Configure build types
+set(CMAKE_CONFIGURATION_TYPES "Debug" "Release" "RelWithDebInfo")
+set(_warnings "-Wshadow -Wall -Wextra -Wpedantic")
+set(CMAKE_CXX_FLAGS_DEBUG          "-Og -g ${_warnings} ${_sanitizers}")
+set(CMAKE_CXX_FLAGS_RELEASE        "-O3 -DNDEBUG")
+set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "-O3 -g ${_warnings} -DNDEBUG ${_sanitizers}")
+unset(_warnings)
+unset(_sanitizers)
+
+if(DISABLE_COLOR)
+  set(CMAKE_COLOR_MAKEFILE OFF)
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fdiagnostics-color=never")
+else()
+  set(CMAKE_COLOR_MAKEFILE ON)
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fdiagnostics-color=always")
+endif()
+
+if(NOT DEFINED PROJECT_VERSION_TWEAK)
+  set(PROJECT_VERSION_HOTFIX 0)
+else()
+  set(PROJECT_VERSION_HOTFIX ${PROJECT_VERSION_TWEAK})
+endif()
+
+if(NOT DEFINED RUN_STATIC_ANALYSIS)
+  set(RUN_STATIC_ANALYSIS OFF)
+endif()
+
+unset(PROJECT_STATIC_ANALYSERS)
+if(RUN_STATIC_ANALYSIS)
+  set(analyser "clang-tidy")
+  find_program(${analyser}_FOUND "${analyser}")
+  if(${analyser}_FOUND)
+    set(CMAKE_CXX_CLANG_TIDY ${analyser} "--extra-arg=-std=c++17")
+  endif()
+  list(APPEND PROJECT_STATIC_ANALYSERS "${analyser}")
+
+  set(analyser "iwyu")
+  find_program(${analyser}_FOUND "${analyser}")
+  if(${analyser}_FOUND)
+    set(CMAKE_CXX_IWYU "${${analyser}_FOUND}")
+  endif()
+  list(APPEND PROJECT_STATIC_ANALYSERS "${analyser}")
+
+  set(analyser "cpplint")
+  find_program(${analyser}_FOUND "${analyser}")
+  if(${analyser}_FOUND)
+    set(CMAKE_CXX_CPPLINT "${${analyser}_FOUND}")
+  endif()
+  list(APPEND PROJECT_STATIC_ANALYSERS "${analyser}")
+endif()
+
+if(CMAKE_GENERATOR STREQUAL Ninja AND ENABLE_CCACHE)
+  find_program(CCACHE ccache)
+  if(CCACHE)
+    set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ${CCACHE})
+  endif()
+endif()
+
+if(NOT DEFINED FAIRMQ_HAS_STD_FILESYSTEM)
+  if(   (    CMAKE_CXX_COMPILER_ID STREQUAL "GNU"
+         AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS 9)
+     OR (    CMAKE_CXX_COMPILER_ID STREQUAL "Clang"
+         AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS 9))
+    set(FAIRMQ_HAS_STD_FILESYSTEM 0)
+  else()
+    set(FAIRMQ_HAS_STD_FILESYSTEM 1)
+  endif()
+endif()
+
+if(NOT DEFINED FAIRMQ_HAS_STD_PMR)
+  if(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+    # Clang (to be more precise: libc++) currently does not implement <memory_resource>
+    set(FAIRMQ_HAS_STD_PMR 0)
+  else()
+    set(FAIRMQ_HAS_STD_PMR 1)
+  endif()
+endif()

cmake/FairMQSummary.cmake

@@ -0,0 +1,105 @@
+################################################################################
+# Copyright (C) 2018-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+include_guard(GLOBAL)
+
+include(FairCMakeModules)
+include(FairFormattedOutput)
+include(FairSummary)
+
+macro(fairmq_summary_components)
+  message(STATUS "  ")
+  message(STATUS "  ${Cyan}COMPONENT         BUILT?  INFO${CR}")
+  if(BUILD_FAIRMQ)
+    set(fairmq_summary "${BGreen}YES${CR}    (default, disable with ${BMagenta}-DBUILD_FAIRMQ=OFF${CR})")
+  else()
+    set(fairmq_summary "${BRed} NO${CR}    (enable with ${BMagenta}-DBUILD_FAIRMQ=ON${CR})")
+  endif()
+  message(STATUS "  ${BWhite}fairmq${CR}             ${fairmq_summary}")
+  if(BUILD_TESTING)
+    set(tests_summary "${BGreen}YES${CR}    (disable with ${BMagenta}-DBUILD_TESTING=OFF${CR})")
+  else()
+    set(tests_summary "${BRed} NO${CR}    (default, enable with ${BMagenta}-DBUILD_TESTING=ON${CR})")
+  endif()
+  message(STATUS "  ${BWhite}tests${CR}              ${tests_summary}")
+  if(BUILD_EXAMPLES)
+    set(examples_summary "${BGreen}YES${CR}    (default, disable with ${BMagenta}-DBUILD_EXAMPLES=OFF${CR})")
+  else()
+    set(examples_summary "${BRed} NO${CR}    (enable with ${BMagenta}-DBUILD_EXAMPLES=ON${CR})")
+  endif()
+  message(STATUS "  ${BWhite}examples${CR}           ${examples_summary}")
+  if(BUILD_DOCS)
+    set(docs_summary "${BGreen}YES${CR}    (disable with ${BMagenta}-DBUILD_DOCS=OFF${CR})")
+  else()
+    set(docs_summary "${BRed} NO${CR}    (default, enable with ${BMagenta}-DBUILD_DOCS=ON${CR})")
+  endif()
+  message(STATUS "  ${BWhite}docs${CR}               ${docs_summary}")
+  if(BUILD_TIDY_TOOL)
+    set(sdk_tidy_summary "${BGreen}YES${CR}    EXPERIMENTAL (disable with ${BMagenta}-DBUILD_TIDY_TOOL=OFF${CR})")
+  else()
+    set(sdk_tidy_summary "${BRed} NO${CR}    EXPERIMENTAL (default, enable with ${BMagenta}-DBUILD_TIDY_TOOL=ON${CR})")
+  endif()
+  message(STATUS "  ${BWhite}tidy_tool${CR}          ${sdk_tidy_summary}")
+endmacro()
+
+macro(fairmq_summary_static_analysis)
+  message(STATUS "  ")
+  if(RUN_STATIC_ANALYSIS)
+    list(LENGTH PROJECT_STATIC_ANALYSERS size)
+    unset(analyser_list)
+    set(count 0)
+    foreach(analyser IN LISTS PROJECT_STATIC_ANALYSERS)
+      if(${analyser}_FOUND)
+        set(${analyser}_status "${analyser} ${BGreen}YES${CR}")
+      else()
+        set(${analyser}_status "${analyser} ${BRed}NO${CR}")
+      endif()
+      math(EXPR count "${count} + 1")
+      string(APPEND analyser_list "${${analyser}_status}")
+      if(count LESS size)
+        string(APPEND analyser_list "${BWhite},${CR} ")
+      endif()
+    endforeach()
+    set(static_ana_summary "${BWhite}(${CR}${analyser_list}${BWhite})${CR}  (disable with ${BMagenta}-DRUN_STATIC_ANALYSIS=OFF${CR})")
+  else()
+    set(static_ana_summary "${BRed} NO${CR}  (default, enable with ${BMagenta}-DRUN_STATIC_ANALYSIS=ON${CR})")
+  endif()
+  message(STATUS "  ${Cyan}RUN STATIC ANALYSIS  ${static_ana_summary}")
+  if(BUILD_TIDY_TOOL)
+    if(RUN_FAIRMQ_TIDY)
+      set(tidy_summary "${BGreen}YES${CR}  (disable with ${BMagenta}-DRUN_FAIRMQ_TIDY=OFF${CR})")
+    else()
+      set(tidy_summary "${BRed} NO${CR}  (default, enable with ${BMagenta}-DRUN_FAIRMQ_TIDY=ON${CR})")
+    endif()
+    message(STATUS "  ${Cyan}RUN fairmq-tidy      ${tidy_summary}")
+  endif()
+endmacro()
+
+macro(fairmq_summary_install_prefix)
+  message(STATUS "  ")
+  message(STATUS "  ${Cyan}INSTALL PREFIX${CR}     ${BGreen}${CMAKE_INSTALL_PREFIX}${CR} (change with ${BMagenta}-DCMAKE_INSTALL_PREFIX=...${CR})")
+endmacro()
+
+macro(fairmq_summary_debug_mode)
+  message(STATUS "  ")
+  if(FAIRMQ_DEBUG_MODE)
+    message(STATUS "  ${Cyan}DEBUG MODE${CR}         ${BGreen}${FAIRMQ_DEBUG_MODE}${CR} (disable with ${BMagenta}-DFAIRMQ_DEBUG_MODE=OFF${CR})")
+  else()
+    message(STATUS "  ${Cyan}DEBUG MODE${CR}         ${BRed}${FAIRMQ_DEBUG_MODE}${CR} (enable with ${BMagenta}-DFAIRMQ_DEBUG_MODE=ON${CR})")
+  endif()
+endmacro()
+
+macro(fairmq_summary_compile_definitions)
+  message(STATUS "  ")
+  message(STATUS "  ${Cyan}COMPILE DEFINITION               VALUE${CR}")
+  message(STATUS "  ${BWhite}FAIRMQ_HAS_STD_FILESYSTEM${CR}        ${FAIRMQ_HAS_STD_FILESYSTEM}  (overridable with ${BMagenta}-DFAIRMQ_HAS_STD_FILESYSTEM=0|1${CR})")
+  message(STATUS "  ${BWhite}FAIRMQ_HAS_STD_PMR${CR}               ${FAIRMQ_HAS_STD_PMR}  (overridable with ${BMagenta}-DFAIRMQ_HAS_STD_PMR=0|1${CR})")
+  if(DEFINED FAIRMQ_CHANNEL_DEFAULT_AUTOBIND)
+    message(STATUS "  ${BWhite}FAIRMQ_CHANNEL_DEFAULT_AUTOBIND${CR}  ${FAIRMQ_CHANNEL_DEFAULT_AUTOBIND}")
+  endif()
+endmacro()

cmake/FairMQTidy.cmake

@@ -0,0 +1,103 @@
+################################################################################
+#    Copyright (C) 2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+include_guard(GLOBAL)
+
+#[=======================================================================[.rst:
+
+``fairmq_target_tidy()``
+========================
+
+Runs the FairMQ static analyzer ``fairmq-tidy`` on source files in given
+target.
+
+.. code-block:: cmake
+
+  fairmq_target_tidy(TARGET <target> [EXTRA_ARGS <args>]
+                    [CLANG_EXECUTABLE <clang>])
+
+Registers a custom command that depends on ``<target>`` which runs ``fairmq-tidy``
+on the source files that belong to ``<target>``. Optional extra arguments
+``<args>`` are passed to the ``fairmq-tidy`` command-line.
+
+Requires ``CMAKE_EXPORT_COMPILE_COMMANDS`` to be enabled.
+
+#]=======================================================================]
+
+function(fairmq_target_tidy)
+  cmake_parse_arguments(PARSE_ARGV 0 ARG "" "TARGET;EXTRA_ARGS;CLANG_EXECUTABLE" "")
+
+  if(NOT CMAKE_EXPORT_COMPILE_COMMANDS)
+    message(AUTHOR_WARNING "CMAKE_EXPORT_COMPILE_COMMANDS is not enabled. Skipping.")
+    return()
+  endif()
+
+  if(NOT ARG_TARGET)
+    message(AUTHOR_WARNING "TARGET argument is required. Skipping.")
+    return()
+  endif()
+
+  if(NOT TARGET ${ARG_TARGET})
+    message(AUTHOR_WARNING "Given TARGET argument `${ARG_TARGET}` is not a target. Skipping.")
+    return()
+  endif()
+
+  if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+    if(NOT fairmq_tidy_clang_resource_dir)
+      if(ARG_CLANG_EXECUTABLE)
+        set(clang_exe ${ARG_CLANG_EXECUTABLE})
+      else()
+        if(TARGET clang)
+          get_property(clang_exe TARGET clang PROPERTY LOCATION)
+        else()
+          set(clang_exe "clang")
+        endif()
+      endif()
+      execute_process(
+        COMMAND ${clang_exe} -print-resource-dir
+        OUTPUT_VARIABLE clang_resource_dir
+        OUTPUT_STRIP_TRAILING_WHITESPACE
+      )
+      set(fairmq_tidy_clang_resource_dir ${clang_resource_dir}
+        CACHE PATH "fairmq_target_tidy() internal state" FORCE)
+    endif()
+    list(APPEND ARG_EXTRA_ARGS
+      "--extra-arg-before=-I${fairmq_tidy_clang_resource_dir}/include")
+  endif()
+
+  if(ARG_EXTRA_ARGS)
+    set(extra 1)
+  else()
+    set(extra 0)
+  endif()
+
+  get_target_property(sources ${ARG_TARGET} SOURCES)
+  list(FILTER sources INCLUDE REGEX "\.(cpp|cxx)$")
+  string(REPLACE ":" "-" target_nocolon "${ARG_TARGET}")
+
+  set(src_deps)
+  foreach(source IN LISTS sources)
+    string(REPLACE "\/" "-" source_noslash "${source}")
+    set(src_stamp "${CMAKE_CURRENT_BINARY_DIR}/${target_nocolon}-${source_noslash}.fairmq-tidy")
+    add_custom_command(
+      OUTPUT ${src_stamp}
+      COMMAND $<TARGET_FILE:FairMQ::fairmq-tidy> -p=${CMAKE_BINARY_DIR}
+              $<${extra}:${ARG_EXTRA_ARGS}> ${source}
+      COMMAND ${CMAKE_COMMAND} -E touch ${src_stamp}
+      COMMENT "fairmq-tidy: Analyzing source file '${source}' of target '${ARG_TARGET}'"
+      DEPENDS ${ARG_TARGET}
+      WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+      COMMAND_EXPAND_LISTS VERBATIM
+    )
+    list(APPEND src_deps ${src_stamp})
+  endforeach()
+
+  if(src_deps)
+    add_custom_target("fairmq-tidy-${target_nocolon}" ALL DEPENDS ${src_deps})
+  endif()
+endfunction()

cmake/FindDDS.cmake

@@ -1,88 +0,0 @@
-################################################################################
-# Copyright (C) 2014-2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
-#                                                                              #
-#              This software is distributed under the terms of the             #
-#              GNU Lesser General Public Licence (LGPL) version 3,             #
-#                  copied verbatim in the file "LICENSE"                       #
-################################################################################
-
-find_path(DDS_INCLUDE_DIR
-  NAMES dds_intercom.h
-  HINTS ${DDS_ROOT} $ENV{DDS_ROOT}
-  PATH_SUFFIXES include
-)
-
-find_path(DDS_LIBRARY_DIR
-  NAMES libdds_intercom_lib.dylib libdds_intercom_lib.so
-  HINTS ${DDS_ROOT} $ENV{DDS_ROOT}
-  PATH_SUFFIXES lib
-)
-
-find_library(DDS_INTERCOM_LIBRARY_SHARED
-  NAMES libdds_intercom_lib.dylib libdds_intercom_lib.so
-  HINTS ${DDS_ROOT} $ENV{DDS_ROOT}
-  PATH_SUFFIXES lib
-  DOC "Path to libdds_intercom_lib.dylib libdds_intercom_lib.so."
-)
-
-find_library(DDS_PROTOCOL_LIBRARY_SHARED
-  NAMES libdds_protocol_lib.dylib libdds_protocol_lib.so
-  HINTS ${DDS_ROOT} $ENV{DDS_ROOT}
-  PATH_SUFFIXES lib
-  DOC "Path to libdds_protocol_lib.dylib libdds_protocol_lib.so."
-)
-
-find_library(DDS_USER_DEFAULTS_LIBRARY_SHARED
-  NAMES libdds-user-defaults.dylib libdds-user-defaults.so
-  HINTS ${DDS_ROOT} $ENV{DDS_ROOT}
-  PATH_SUFFIXES lib
-  DOC "Path to libdds-user-defaults.dylib libdds-user-defaults.so."
-)
-
-find_file(DDS_VERSION_FILE
-  NAMES version
-  HINTS ${DDS_ROOT} $ENV{DDS_ROOT}
-  PATH_SUFFIXES etc
-)
-
-if(DDS_VERSION_FILE AND NOT DDS_VERSION)
-  file(READ ${DDS_VERSION_FILE} DDS_VERSION)
-  string(STRIP "${DDS_VERSION}" DDS_VERSION)
-  set(DDS_VERSION ${DDS_VERSION} CACHE string "DDS version.")
-endif()
-
-include(FindPackageHandleStandardArgs)
-find_package_handle_standard_args(DDS
-  REQUIRED_VARS
-  DDS_INCLUDE_DIR
-  DDS_LIBRARY_DIR
-  DDS_INTERCOM_LIBRARY_SHARED
-  DDS_PROTOCOL_LIBRARY_SHARED
-  DDS_USER_DEFAULTS_LIBRARY_SHARED
-
-  VERSION_VAR DDS_VERSION
-)
-
-if(NOT TARGET DDS::dds_intercom_lib AND DDS_FOUND)
-  add_library(DDS::dds_intercom_lib SHARED IMPORTED)
-  set_target_properties(DDS::dds_intercom_lib PROPERTIES
-    IMPORTED_LOCATION ${DDS_INTERCOM_LIBRARY_SHARED}
-    INTERFACE_INCLUDE_DIRECTORIES ${DDS_INCLUDE_DIR}
-  )
-endif()
-
-if(NOT TARGET DDS::dds_protocol_lib AND DDS_FOUND)
-  add_library(DDS::dds_protocol_lib SHARED IMPORTED)
-  set_target_properties(DDS::dds_protocol_lib PROPERTIES
-    IMPORTED_LOCATION ${DDS_PROTOCOL_LIBRARY_SHARED}
-    INTERFACE_INCLUDE_DIRECTORIES ${DDS_INCLUDE_DIR}
-  )
-endif()
-
-if(NOT TARGET DDS::dds-user-defaults AND DDS_FOUND)
-  add_library(DDS::dds-user-defaults SHARED IMPORTED)
-  set_target_properties(DDS::dds-user-defaults PROPERTIES
-    IMPORTED_LOCATION ${DDS_USER_DEFAULTS_LIBRARY_SHARED}
-    INTERFACE_INCLUDE_DIRECTORIES ${DDS_INCLUDE_DIR}
-  )
-endif()

cmake/FindFlatBuffers.cmake

@@ -1,67 +0,0 @@
-################################################################################
-# Copyright (C) 2014-2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
-#                                                                              #
-#              This software is distributed under the terms of the             #
-#              GNU Lesser General Public Licence (LGPL) version 3,             #
-#                  copied verbatim in the file "LICENSE"                       #
-################################################################################
-
-find_path(FLATBUFFERS_INCLUDE_DIR
-  NAMES flatbuffers/flatbuffers.h
-  HINTS ${FLATBUFFERS_ROOT} $ENV{FLATBUFFERS_ROOT}
-  PATH_SUFFIXES include
-)
-
-find_path(FLATBUFFERS_LIBRARY_DIR
-  NAMES libflatbuffers.a
-  HINTS ${FLATBUFFERS_ROOT} $ENV{FLATBUFFERS_ROOT}
-  PATH_SUFFIXES lib
-)
-
-find_library(FLATBUFFERS_STATIC_LIBRARY
-  NAMES libflatbuffers.a
-  HINTS ${FLATBUFFERS_ROOT} $ENV{FLATBUFFERS_ROOT}
-  PATH_SUFFIXES lib
-)
-
-find_path(FLATBUFFERS_BINARY_DIR
-  NAMES flatc
-  HINTS ${FLATBUFFERS_ROOT} $ENV{FLATBUFFERS_ROOT}
-  PATH_SUFFIXES bin
-)
-
-find_program(FLATBUFFERS_BINARY_FLATC
-  NAMES flatc
-  HINTS ${FLATBUFFERS_ROOT} $ENV{FLATBUFFERS_ROOT}
-  PATH_SUFFIXES bin
-)
-
-include(FindPackageHandleStandardArgs)
-find_package_handle_standard_args(FlatBuffers
-  REQUIRED_VARS
-  FLATBUFFERS_INCLUDE_DIR
-  FLATBUFFERS_LIBRARY_DIR
-  FLATBUFFERS_BINARY_DIR
-)
-
-# idempotently import targets
-if(NOT TARGET FlatBuffers)
-  if(FLATBUFFERS_FOUND)
-    # import target
-    add_library(FlatBuffers STATIC IMPORTED)
-    set_target_properties(FlatBuffers PROPERTIES
-      INTERFACE_INCLUDE_DIRECTORIES ${FLATBUFFERS_INCLUDE_DIR}
-      IMPORTED_LOCATION ${FLATBUFFERS_STATIC_LIBRARY}
-    )
-  endif()
-endif()
-
-if(NOT TARGET FlatBuffers::flatc)
-  if(FLATBUFFERS_FOUND)
-  # import target
-  add_executable(FlatBuffers::flatc IMPORTED)
-  set_target_properties(FlatBuffers::flatc PROPERTIES
-    IMPORTED_LOCATION ${FLATBUFFERS_BINARY_FLATC}
-  )
-  endif()
-endif()

cmake/FindOFI.cmake

@@ -1,89 +0,0 @@
-################################################################################
-#    Copyright (C) 2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    #
-#                                                                              #
-#              This software is distributed under the terms of the             #
-#              GNU Lesser General Public Licence (LGPL) version 3,             #
-#                  copied verbatim in the file "LICENSE"                       #
-################################################################################
-
-# According to the docs the modification of the PKG_CONFIG_PATH environment should
-# not be necessary, but it does not work otherwise.
-if(OFI_ROOT)
-  list(APPEND CMAKE_PREFIX_PATH "${OFI_ROOT}/lib/pkgconfig")
-  set(ENV{PKG_CONFIG_PATH} "${OFI_ROOT}/lib/pkgconfig:" $ENV{PKG_CONFIG_PATH})
-endif()
-
-if(ENV{OFI_ROOT})
-  list(APPEND CMAKE_PREFIX_PATH "$ENV{OFI_ROOT}/lib/pkgconfig")
-  set(ENV{PKG_CONFIG_PATH} "$ENV{OFI_ROOT}/lib/pkgconfig:" $ENV{PKG_CONFIG_PATH})
-endif()
-
-# This should be the default as of CMake 3.1, but it is not set. BUG? Also, it does not work
-set(PKG_CONFIG_USE_CMAKE_PREFIX_PATH 1)
-find_package(PkgConfig QUIET)
-
-if(PKG_CONFIG_FOUND)
-  # Find include dir and dependencies from pkgconfig
-  pkg_check_modules(_OFI libfabric QUIET)
-
-  # Retrieve version from pkgconfig
-  execute_process(
-    COMMAND ${PKG_CONFIG_EXECUTABLE} libfabric --modversion
-    OUTPUT_VARIABLE OFI_VERSION
-    OUTPUT_STRIP_TRAILING_WHITESPACE
-  )
-
-  # The IMPORTED_TARGET option of the pkg_check_modules() function is useless,
-  # so let's build it ourselves
-  find_library(OFI_LIBFABRIC
-    NAMES libfabric.so libfabric.dylib
-    HINTS ${OFI_ROOT} $ENV{OFI_ROOT}
-    PATH_SUFFIXES lib
-  )
-
-  # Just take the include dirs found by the PkgConfig module
-  set(OFI_INCLUDE_DIRS ${_OFI_INCLUDE_DIRS})
-
-  # Find fi_info command to be able to check required features of the OFI installation
-  find_program(OFI_INFO_EXECUTABLE
-    NAMES fi_info
-    HINTS ${OFI_ROOT} $ENV{OFI_ROOT}
-    PATH_SUFFIXES bin
-  )
-
-  # Detect ofi providers, they can be required via the COMPONENTS argument of find_package
-  if(OFI_INFO_EXECUTABLE)
-    execute_process(
-      COMMAND ${OFI_INFO_EXECUTABLE} -l
-      OUTPUT_VARIABLE output
-    )
-    string(REPLACE "\n" ";" lines ${output})
-    foreach(line IN LISTS lines)
-      string(REGEX
-        MATCH "^([a-zA-Z0-9_]+):"
-        found "${line}"
-      )
-      if(found)
-        string(TOLOWER "${CMAKE_MATCH_1}" provider)
-        set(OFI_fi_${provider}_FOUND TRUE)
-      endif()
-    endforeach()
-  endif()
-
-  # Check search result, check version constraints and print status
-  include(FindPackageHandleStandardArgs)
-  find_package_handle_standard_args(OFI
-    REQUIRED_VARS OFI_LIBFABRIC OFI_INCLUDE_DIRS OFI_INFO_EXECUTABLE
-    VERSION_VAR OFI_VERSION
-    HANDLE_COMPONENTS
-  )
-endif()
-
-if(NOT TARGET OFI::libfabric AND OFI_FOUND)
-  # Define an imported target
-  add_library(OFI::libfabric SHARED IMPORTED GLOBAL)
-  set_target_properties(OFI::libfabric PROPERTIES
-    IMPORTED_LOCATION ${OFI_LIBFABRIC}
-    INTERFACE_INCLUDE_DIRECTORIES ${OFI_INCLUDE_DIRS}
-  )
-endif()

cmake/FindPicoSHA2.cmake

@@ -0,0 +1,21 @@
+################################################################################
+#    Copyright (C) 2020 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+find_path(PicoSHA2_INCLUDE_DIR NAMES picosha2.h)
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(PicoSHA2
+  REQUIRED_VARS PicoSHA2_INCLUDE_DIR
+)
+
+if(PicoSHA2_FOUND)
+  add_library(PicoSHA2 INTERFACE IMPORTED)
+  set_target_properties(PicoSHA2 PROPERTIES
+    INTERFACE_INCLUDE_DIRECTORIES "${PicoSHA2_INCLUDE_DIR}"
+  )
+endif()

cmake/FindZeroMQ.cmake

@@ -89,15 +89,16 @@ endif()
 
 include(FindPackageHandleStandardArgs)
 find_package_handle_standard_args(ZeroMQ
-    REQUIRED_VARS ZeroMQ_LIBRARY_SHARED ZeroMQ_INCLUDE_DIR ZeroMQ_LIBRARY_STATIC
+    REQUIRED_VARS ZeroMQ_LIBRARY_SHARED ZeroMQ_INCLUDE_DIR
     VERSION_VAR ZeroMQ_VERSION
 )
 
-if(ZeroMQ_FOUND AND NOT TARGET ZeroMQ)
-  add_library(ZeroMQ SHARED IMPORTED)
-  set_target_properties(ZeroMQ PROPERTIES
+if(ZeroMQ_FOUND AND NOT TARGET libzmq)
+  add_library(libzmq SHARED IMPORTED)
+  set_target_properties(libzmq PROPERTIES
     IMPORTED_LOCATION ${ZeroMQ_LIBRARY_SHARED}
     INTERFACE_INCLUDE_DIRECTORIES ${ZeroMQ_INCLUDE_DIR}
+    INTERFACE_LINK_LIBRARIES "$<$<PLATFORM_ID:Linux>:rt>;pthread"
   )
 endif()
 

cmake/Findasio.cmake

@@ -0,0 +1,46 @@
+################################################################################
+# Copyright (C) 2019-2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+find_path(asio_INCLUDE_DIR
+  NAMES asio.hpp
+  PATH_SUFFIXES include
+)
+
+if(asio_INCLUDE_DIR)
+  find_file(asio_VERSION_HEADER "asio/version.hpp"
+    ${asio_INCLUDE_DIR}
+    NO_DEFAULT_PATH
+  )
+endif()
+
+if(asio_VERSION_HEADER)
+  file(READ "${asio_VERSION_HEADER}" _asio_VERSION_HEADER_CONTENT)
+  string(REGEX MATCH "#define ASIO_VERSION ([0-9]+)" _MATCH "${_asio_VERSION_HEADER_CONTENT}")
+  set(asio_VERSION_MACRO ${CMAKE_MATCH_1})
+  math(EXPR asio_VERSION_MAJOR "${asio_VERSION_MACRO} / 100000")
+  math(EXPR asio_VERSION_MINOR "${asio_VERSION_MACRO} / 100 % 1000")
+  math(EXPR asio_VERSION_PATCH "${asio_VERSION_MACRO} % 100")
+  set(asio_VERSION "${asio_VERSION_MAJOR}.${asio_VERSION_MINOR}.${asio_VERSION_PATCH}")
+endif()
+
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(asio
+  REQUIRED_VARS asio_INCLUDE_DIR
+  VERSION_VAR asio_VERSION
+  HANDLE_COMPONENTS
+)
+
+if(asio_FOUND AND NOT TARGET asio::asio)
+  add_library(asio::asio INTERFACE IMPORTED)
+  set_target_properties(asio::asio PROPERTIES
+    INTERFACE_COMPILE_DEFINITIONS "ASIO_STANDALONE"
+    INTERFACE_INCLUDE_DIRECTORIES "${asio_INCLUDE_DIR}"
+  )
+endif()
+

cmake/Findnanomsg.cmake

@@ -1,34 +0,0 @@
-################################################################################
-# Copyright (C) 2014-2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
-#                                                                              #
-#              This software is distributed under the terms of the             #
-#              GNU Lesser General Public Licence (LGPL) version 3,             #
-#                  copied verbatim in the file "LICENSE"                       #
-################################################################################
-
-find_path(NANOMSG_INCLUDE_DIR
-  NAMES nanomsg/nn.h
-  HINTS ${NANOMSG_ROOT} $ENV{NANOMSG_ROOT}
-  PATH_SUFFIXES include
-  DOC "Path to nanomsg include header files."
-)
-
-find_library(NANOMSG_LIBRARY_SHARED
-  NAMES libnanomsg.dylib libnanomsg.so
-  HINTS ${NANOMSG_ROOT} $ENV{NANOMSG_ROOT}
-  PATH_SUFFIXES lib
-  DOC "Path to libnanomsg.dylib libnanomsg.so."
-)
-
-include(FindPackageHandleStandardArgs)
-find_package_handle_standard_args(nanomsg
-  REQUIRED_VARS NANOMSG_LIBRARY_SHARED NANOMSG_INCLUDE_DIR
-)
-
-if(NOT TARGET nanomsg AND nanomsg_FOUND)
-  add_library(nanomsg SHARED IMPORTED)
-  set_target_properties(nanomsg PROPERTIES
-    IMPORTED_LOCATION ${NANOMSG_LIBRARY_SHARED}
-    INTERFACE_INCLUDE_DIRECTORIES ${NANOMSG_INCLUDE_DIR}
-  )
-endif()

cmake/GTestHelper.cmake

@@ -1,5 +1,5 @@
 ################################################################################
-# Copyright (C) 2017-2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+# Copyright (C) 2017-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
 #                                                                              #
 #              This software is distributed under the terms of the             #
 #              GNU Lesser General Public Licence (LGPL) version 3,             #
@@ -20,6 +20,7 @@
 #                        [DEPENDS dep1 [dep2 ...]]
 #                        [LINKS linklib1 [linklib2 ...]
 #                        [INCLUDES dir1 [dir2 ...]
+#                        [ENVIRONMENT var1=op:val1[;var2=op:val2 ...]]
 #                        [TIMEOUT seconds]
 #                        [RUN_SERIAL ON/OFF])
 #
@@ -47,11 +48,16 @@
 #
 #
 
+include(GoogleTest)
+if(BUILD_TIDY_TOOL)
+  include(FairMQTidy)
+endif()
+
 function(add_testsuite suitename)
     cmake_parse_arguments(testsuite
         ""
         "TIMEOUT;RUN_SERIAL"
-        "SOURCES;LINKS;DEPENDS;INCLUDES"
+        "SOURCES;LINKS;DEPENDS;INCLUDES;DEFINITIONS;ENVIRONMENT"
         ${ARGN}
     )
 
@@ -69,14 +75,34 @@ function(add_testsuite suitename)
     if(testsuite_INCLUDES)
         target_include_directories(${target} PUBLIC ${testsuite_INCLUDES})
     endif()
+    if(testsuite_DEFINITIONS)
+        target_compile_definitions("${target}" PUBLIC ${testsuite_DEFINITIONS})
+    endif()
+    if(testsuite_ENVIRONMENT AND CMAKE_VERSION VERSION_GREATER_EQUAL 3.22)
+        set(env "ENVIRONMENT_MODIFICATION" ${testsuite_ENVIRONMENT})
+    endif()
+    if(BUILD_TIDY_TOOL AND RUN_FAIRMQ_TIDY)
+      fairmq_target_tidy(TARGET ${target})
+    endif()
 
-    add_test(NAME "${suitename}" WORKING_DIRECTORY ${CMAKE_BINARY_DIR} COMMAND ${target})
+    # add_test(NAME "${suitename}" WORKING_DIRECTORY ${CMAKE_BINARY_DIR} COMMAND ${target})
     if(testsuite_TIMEOUT)
-        set_tests_properties("${suitename}" PROPERTIES TIMEOUT ${testsuite_TIMEOUT})
+        # set_tests_properties("${suitename}" PROPERTIES TIMEOUT ${testsuite_TIMEOUT})
+    else()
+        set(testsuite_TIMEOUT 10)
     endif()
     if(testsuite_RUN_SERIAL)
-        set_tests_properties("${suitename}" PROPERTIES RUN_SERIAL ${testsuite_RUN_SERIAL})
+        # set_tests_properties("${suitename}" PROPERTIES RUN_SERIAL ${testsuite_RUN_SERIAL})
+    else()
+        set(testsuite_RUN_SERIAL OFF)
     endif()
+    gtest_discover_tests(${target}
+      WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+      TEST_PREFIX ${suitename}.
+      PROPERTIES RUN_SERIAL ${testsuite_RUN_SERIAL}
+                 TIMEOUT ${testsuite_TIMEOUT}
+                 ${env}
+    )
 
     list(APPEND ALL_TEST_TARGETS ${target})
     set(ALL_TEST_TARGETS ${ALL_TEST_TARGETS} PARENT_SCOPE)
@@ -86,7 +112,7 @@ function(add_testhelper helpername)
     cmake_parse_arguments(testhelper
         ""
         ""
-        "SOURCES;LINKS;DEPENDS;INCLUDES"
+        "SOURCES;LINKS;DEPENDS;INCLUDES;DEFINITIONS"
         ${ARGN}
     )
 
@@ -102,6 +128,12 @@ function(add_testhelper helpername)
     if(testhelper_INCLUDES)
         target_include_directories(${target} PUBLIC ${testhelper_INCLUDES})
     endif()
+    if(testhelper_DEFINITIONS)
+        target_compile_definitions(${target} PUBLIC ${testhelper_DEFINITIONS})
+    endif()
+    if(BUILD_TIDY_TOOL AND RUN_FAIRMQ_TIDY)
+      fairmq_target_tidy(TARGET ${target})
+    endif()
 
     list(APPEND ALL_TEST_TARGETS ${target})
     set(ALL_TEST_TARGETS ${ALL_TEST_TARGETS} PARENT_SCOPE)
@@ -111,7 +143,7 @@ function(add_testlib libname)
     cmake_parse_arguments(testlib
         "HIDDEN"
         "VERSION"
-        "SOURCES;LINKS;DEPENDS;INCLUDES"
+        "SOURCES;LINKS;DEPENDS;INCLUDES;DEFINITIONS"
         ${ARGN}
     )
 
@@ -133,6 +165,12 @@ function(add_testlib libname)
     if(testlib_VERSION)
         set_target_properties(${target} PROPERTIES VERSION ${testlib_VERSION})
     endif()
+    if(testlib_DEFINITIONS)
+        target_compile_definitions(${target} PUBLIC ${testlib_DEFINITIONS})
+    endif()
+    if(BUILD_TIDY_TOOL AND RUN_FAIRMQ_TIDY)
+      fairmq_target_tidy(TARGET ${target})
+    endif()
 
     list(APPEND ALL_TEST_TARGETS ${target})
     set(ALL_TEST_TARGETS ${ALL_TEST_TARGETS} PARENT_SCOPE)

cmake/GitHelper.cmake

@@ -0,0 +1,65 @@
+################################################################################
+# Copyright (C) 2018-2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+include_guard(GLOBAL)
+
+if(NOT DEFINED ${GIT_EXECUTABLE})
+  find_program(GIT_EXECUTABLE NAMES git)
+endif()
+
+# get_git_version([DEFAULT_VERSION version] [DEFAULT_DATE date] [OUTVAR_PREFIX prefix])
+#
+# Sets variables #prefix#_VERSION, #prefix#_GIT_VERSION, #prefix#_DATE, #prefix#_GIT_DATE
+function(get_git_version)
+  cmake_parse_arguments(ARGS "" "DEFAULT_VERSION;DEFAULT_DATE;OUTVAR_PREFIX" "" ${ARGN})
+
+  if(NOT ARGS_OUTVAR_PREFIX)
+    set(ARGS_OUTVAR_PREFIX PROJECT)
+  endif()
+
+  if(GIT_EXECUTABLE AND EXISTS ${CMAKE_SOURCE_DIR}/.git)
+    execute_process(COMMAND ${GIT_EXECUTABLE} describe --tags --dirty --match "v*"
+      OUTPUT_VARIABLE ${ARGS_OUTVAR_PREFIX}_GIT_VERSION
+      OUTPUT_STRIP_TRAILING_WHITESPACE
+      WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+    )
+    if(${ARGS_OUTVAR_PREFIX}_GIT_VERSION)
+      # cut first two characters "v-"
+      string(SUBSTRING ${${ARGS_OUTVAR_PREFIX}_GIT_VERSION} 1 -1 ${ARGS_OUTVAR_PREFIX}_GIT_VERSION)
+    endif()
+    execute_process(COMMAND ${GIT_EXECUTABLE} log -1 --format=%cd
+      OUTPUT_VARIABLE ${ARGS_OUTVAR_PREFIX}_GIT_DATE
+      OUTPUT_STRIP_TRAILING_WHITESPACE
+      WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+    )
+  endif()
+
+  if(NOT ${ARGS_OUTVAR_PREFIX}_GIT_VERSION)
+    if(ARGS_DEFAULT_VERSION)
+      set(${ARGS_OUTVAR_PREFIX}_GIT_VERSION ${ARGS_DEFAULT_VERSION})
+    else()
+      set(${ARGS_OUTVAR_PREFIX}_GIT_VERSION 0.0.0.0)
+    endif()
+  endif()
+
+  if(NOT ${ARGS_OUTVAR_PREFIX}_GIT_DATE)
+    if(ARGS_DEFAULT_DATE)
+      set(${ARGS_OUTVAR_PREFIX}_GIT_DATE ${ARGS_DEFAULT_DATE})
+    else()
+      set(${ARGS_OUTVAR_PREFIX}_GIT_DATE "Thu Jan 1 00:00:00 1970 +0000")
+    endif()
+  endif()
+
+  string(REGEX MATCH "^([^-]*)" blubb ${${ARGS_OUTVAR_PREFIX}_GIT_VERSION})
+
+  # return values
+  set(${ARGS_OUTVAR_PREFIX}_VERSION ${CMAKE_MATCH_0} PARENT_SCOPE)
+  set(${ARGS_OUTVAR_PREFIX}_DATE ${${ARGS_OUTVAR_PREFIX}_GIT_DATE} PARENT_SCOPE)
+  set(${ARGS_OUTVAR_PREFIX}_GIT_VERSION ${${ARGS_OUTVAR_PREFIX}_GIT_VERSION} PARENT_SCOPE)
+  set(${ARGS_OUTVAR_PREFIX}_GIT_DATE ${${ARGS_OUTVAR_PREFIX}_GIT_DATE} PARENT_SCOPE)
+endfunction()

codemeta.json

@@ -0,0 +1,122 @@
+{
+  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
+  "@type": "SoftwareSourceCode",
+  "name": "FairMQ",
+  "description": "C++ Message Queuing Library and Framework",
+  "license": "./COPYRIGHT",
+  "datePublished": "2018-04-15",
+  "developmentStatus": "active",
+  "softwareVersion": "master",
+  "releaseNotes": "https://github.com/FairRootGroup/FairMQ/releases",
+  "codeRepository": "https://github.com/FairRootGroup/FairMQ/",
+  "readme": "https://github.com/FairRootGroup/FairMQ/#readme",
+  "issueTracker": "https://github.com/FairRootGroup/FairMQ/issues",
+  "identifier": "https://doi.org/10.5281/zenodo.1689985",
+  "maintainer": [
+    {
+      "@type": "ResearchOrganisation",
+      "@id": "https://ror.org/02k8cbn47",
+      "name": "GSI Helmholtz Centre for Heavy Ion Research"
+    }
+  ],
+  "author": [
+    {
+      "@type": "Person",
+      "@id": "https://orcid.org/0000-0002-8071-4497",
+      "givenName": "Mohammad",
+      "familyName": "Al-Turany"
+    },
+    {
+      "@type": "Person",
+      "@id": "https://orcid.org/0000-0003-3787-1910",
+      "givenName": "Dennis",
+      "familyName": "Klein"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Thorsten",
+      "familyName": "Kollegger"
+    },
+    {
+      "@type": "Person",
+      "@id": "https://orcid.org/0000-0002-6249-155X",
+      "givenName": "Alexey",
+      "familyName": "Rybalchenko"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Nicolas",
+      "familyName": "Winckler"
+    }
+  ],
+  "contributor": [
+    {
+      "@type": "Person",
+      "givenName": "Laurent",
+      "familyName": "Aphecetche"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Sebastien",
+      "familyName": "Binet"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Giulio",
+      "familyName": "Eulisse"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Radoslaw",
+      "familyName": "Karabowicz"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Matthias",
+      "familyName": "Kretz",
+      "email": "kretz@kde.org"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Mikolaj",
+      "familyName": "Krzewicki"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Andrey",
+      "familyName": "Lebedev"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Teo",
+      "familyName": "Mrnjavac",
+      "email": "teo.m@cern.ch"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Gvozden",
+      "familyName": "Neskovic"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Matthias",
+      "familyName": "Richter"
+    },
+    {
+      "@type": "Person",
+      "@id": "https://orcid.org/0000-0002-5321-8404",
+      "givenName": "Christian",
+      "familyName": "Tacke"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Florian",
+      "familyName": "Uhlig"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Sandro",
+      "familyName": "Wenzel"
+    }
+  ]
+}

docs/Configuration.md

@@ -4,7 +4,35 @@
 
 ## 3.1 Device Configuration
 
-Devices receive configuration primarily via provided command line options (that can be extended per device).
+Device Configuration is stored in configuration object - `fair::mq::ProgOptions`. It is accessible by the device, plugins or from DeviceRunner/main:
+
+Plugins <---read/write---> ProgOptions <---read/write---> Device
+
+Whenever a configuration property is set, it is set in ProgOptions. Device/Channels/User code read this value and apply it as necessary at different stages:
+ - apply it immidiately
+ - apply it in device/channels during InitializingDevice/Binding/Connecting states
+
+Here is an overview of the device/channel options and when they are applied:
+
+| Property | Applied in |
+| --- | --- |
+| `severity` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<fairmq/runDevice.h>`)) |
+| `file-severity` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<fairmq/runDevice.h>`)) |
+| `verbosity` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<fairmq/runDevice.h>`)) |
+| `color` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<fairmq/runDevice.h>`)) |
+| `log-to-file` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<fairmq/runDevice.h>`)) |
+| `id` | at the end of `fair::mq::State::InitializingDevice` |
+| `io-threads` | at the end of `fair::mq::State::InitializingDevice` |
+| `transport` | at the end of `fair::mq::State::InitializingDevice` |
+| `network-interface` | at the end of `fair::mq::State::InitializingDevice` |
+| `init-timeout` | at the end of `fair::mq::State::InitializingDevice` |
+| `shm-segment-size` | at the end of `fair::mq::State::InitializingDevice` |
+| `shm-monitor` | at the end of `fair::mq::State::InitializingDevice` |
+| `rate` | at the end of `fair::mq::State::InitializingDevice` |
+| `session` | at the end of `fair::mq::State::InitializingDevice` |
+| `chan.*` | at the end of `fair::mq::State::InitializingDevice` (channel addresses can be also applied during `fair::mq::State::Binding`/`fair::mq::State::Connecting`) |
+
+## 3.2 Configuration options
 
 ## 3.2 Communication Channels Configuration
 
@@ -32,6 +60,14 @@ This parser reads channel configuration from a JSON file. Example:
                                 "address": "tcp://*:5555",
                                 "sndBufSize": 1000,
                                 "rcvBufSize": 1000,
+                                "sndKernelSize" : 0,
+                                "rcvKernelSize" : 0,
+                                "transport": "shmem",
+                                "linger": "500",
+                                "portRangeMin": "22000",
+                                "portRangeMax": "23000",
+                                "autoBind": false,
+                                "numSockets": 0,
                                 "rateLogging": 1
                             }
                         ]
@@ -48,9 +84,7 @@ This parser reads channel configuration from a JSON file. Example:
                                 "type": "pull",
                                 "method": "connect",
                                 "address": "tcp://localhost:5555",
-                                "sndBufSize": 1000,
-                                "rcvBufSize": 1000,
-                                "rateLogging": 1
+                                "transport": "shmem"
                             }
                         ]
                     }

docs/Development.md

@@ -6,8 +6,53 @@
 
 For unit testing it is often not feasible to boot up a full-blown distributed system with dozens of processes.
 
-In some scenarios it is useful to not even instantiate a `FairMQDevice` at all. Please see [this example](../test/protocols/_push_pull_multipart.cxx) for single and multi threaded unit test without a device instance. If you store your transport factories and channels on the heap, pls make sure, you destroy the channels before you destroy the related transport factory for proper shutdown. Channels provide all the `Send/Receive` and `New*Message/New*Poller` APIs provided by the device too.
+In some scenarios it is useful to not even instantiate a `fair::mq::Device` at all. Please see [this example](../test/protocols/_push_pull_multipart.cxx) for single and multi threaded unit test without a device instance. If you store your transport factories and channels on the heap, pls make sure, you destroy the channels before you destroy the related transport factory for proper shutdown. Channels provide all the `Send/Receive` and `New*Message/New*Poller` APIs provided by the device too.
 
-TODO Multiple devices in one process.
+## 4.2 Static Analysis
+
+With `-DBUILD_TIDY_TOOL=ON` you can build the `fairmq-tidy` tool that implements static checks on your source code. To use it, enable the generation of a [compilation database](https://clang.llvm.org/docs/JSONCompilationDatabase.html) in your project via `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` (generates a file `<builddir>/compile_commands.json`):
+
+```
+fairmq-tidy -p <builddir> mysourcefile.cpp
+```
+
+If you find any issue (e.g. false positives) with this tool, please tell us by opening an issue on github.
+
+### 4.2.1 CMake Integration
+
+When discovering a FairMQ installation in your project, explicitely state, that you want one with the `fairmq-tidy` tool included:
+
+```
+find_package(FairMQ COMPONENTS tidy_tool)
+```
+
+Now the CMake module [`FairMQTidy.cmake`](../cmake/FairMQTidy.cmake) is available for inclusion:
+
+```
+include(FairMQTidy)
+```
+
+It provides the CMake function `fairmq_target_tidy()` which attaches appropriate `fairmq-tidy` build rules to each source file contained in the passed library or executable target, e.g. if you have an executable that uses FairMQ:
+
+```
+add_executable(myexe mysource1.cpp mysource2.cpp)
+target_link_libraries(myexe PRIVATE FairMQ::FairMQ)
+fairmq_target_tidy(TARGET myexe)
+```
+
+### 4.2.2 Extra Compiler Arguments
+
+On most Linux distros you are likely to use GCC to compile your projects, so the resulting `compile_commands.json` contains the command-line tuned for GCC which might be missing options needed to successfully invoke the Clang frontend which is used internally by `fairmq-tidy`. In general, you can pass extra `clang` options via the following options:
+
+```
+  --extra-arg=<string>        - Additional argument to append to the compiler command line
+  --extra-arg-before=<string> - Additional argument to prepend to the compiler command line
+```
+
+E.g. if standard headers are not found, you can hint the location like this:
+
+```
+fairmq-top -p <builddir> --extra-arg-before=-I$(clang -print-resource-dir)/include mysourcefile.cpp
+```
 
 ← [Back](../README.md)

docs/Device.md

@@ -2,7 +2,7 @@
 
 # 1. Device
 
-The components encapsulating the tasks are called **devices** and derive from the common base class `FairMQDevice`. FairMQ provides ready to use devices to organize the dataflow between the components (without touching the contents of a message), providing functionality like merging and splitting of the data stream (see subdirectory `devices`).
+The components encapsulating the tasks are called **devices** and derive from the common base class `fair::mq::Device`. FairMQ provides ready to use devices to organize the dataflow between the components (without touching the contents of a message), providing functionality like merging and splitting of the data stream (see subdirectory `devices`).
 
 ## 1.1 Topology
 
@@ -18,27 +18,28 @@ Topology configuration is currently happening via setup scripts. This is very ru
 
 ## 1.2 Communication Patterns
 
-FairMQ devices communicate via the communication patterns offered by ZeroMQ (or nanomsg): PUSH-PULL, PUB-SUB, REQ-REP, PAIR, [more info here](http://api.zeromq.org/4-0:zmq-socket). Each transport may provide further patterns.
+FairMQ devices communicate via the communication patterns offered by ZeroMQ: PUSH-PULL, PUB-SUB, REQ-REP, PAIR, [more info here](http://api.zeromq.org/4-0:zmq-socket). Each transport may provide further patterns.
 
 ## 1.3 State Machine
 
 Each FairMQ device has an internal state machine:
 
-![FairMQ state machine](images/device_states.png?raw=true "FairMQ state machine")
+![FairMQ state machine](images/device_states.svg "FairMQ state machine")
 
 The state machine can be querried and controlled via `GetCurrentStateName()` and `ChangeState("<state name>")` methods. Only legal state transitions are allowed (see image above). Illegal transitions will fail with an error.
 
 If the device is running in interactive mode (default), states can be changed via keyboard input:
 
  - `'h'` - help
- - `'p'` - pause
  - `'r'` - run
  - `'s'` - stop
  - `'t'` - reset task
  - `'d'` - reset device
  - `'q'` - end
  - `'j'` - init task
- - `'i'` - init device
+ - `'i'` - initialize
+ - `'b'` - bind
+ - `'x'` - connect
 
 Without the interactive mode, for example for a run in background, two other control mechanisms are available:
 
@@ -47,6 +48,6 @@ Without the interactive mode, for example for a run in background, two other con
 
 ## 1.4 Multiple devices in the same process
 
-Technically one can create two or more devices within the same process without any conflicts. However the configuration (FairMQProgOptions) currently assumes the supplied configuration values are for one device/process.
+Technically one can create two or more devices within the same process without any conflicts. However the configuration (fair::mq::ProgOptions) currently assumes the supplied configuration values are for one device/process.
 
 ← [Back](../README.md)

docs/Plugins.md

@@ -0,0 +1,61 @@
+← [Back](../README.md)
+
+# 7. Plugins
+
+FairMQ devices can be integrated with external configuration and control systems through its plugin system. FairMQ plugins are special dynamic libraries that can be loaded at runtime. Plugins have access to the Plugin API which includes the capability to control/monitor the device [state machine](Device.md#13-state-machine) and change/monitor configuration properties.
+
+A simple plugin may add the feature to read configuration from a certain desired file format once at the start of a device. A more complex plugin may create a long-running thread that integrates a network client to an external API of a central experiment control system.
+
+Because plugins are loaded dynamically, they can be developed in separate repositories/projects and also have their own set of runtime dependency that are not needed to be known at compile-time of the FairMQ device.
+
+## 7.1 Usage
+
+To load a plugin pass the `-P <name>[,<name>]` (or long `--plugin`) command line option. Multiple plugins can be loaded at the same time. The load order is as specified at the command line. This determines the order in which the plugins are instantiated (ctor call order) and in which order they are notified, should they subscribe to any notifications.
+
+When passing `-h/--help` on the command line one can find more detailed information:
+
+```
+Plugin Manager:
+  -S [ --plugin-search-path ] arg       List of plugin search paths.
+                                        * Override default search path, e.g.
+                                          -S /home/user/lib /lib
+                                        * Append(>) or prepend(<) to default
+                                        search path, e.g.
+                                          -S >/lib </home/user/lib
+                                        * If you mix the overriding and
+                                        appending/prepending syntaxes, the
+                                        overriding paths act as default search
+                                        path, e.g.
+                                          -S /usr/lib >/lib </home/user/lib
+                                        /usr/local/lib results in
+                                        /home/user/lib,/usr/local/lib,/usr/lib/
+                                        ,/lib
+                                        If nothing is found, the default
+                                        dynamic library lookup is performed,
+                                        see man ld.so(8) for details.
+  -P [ --plugin ] arg                   List of plugin names to load in
+                                        order,e.g. if the file is called
+                                        'libfairmq-plugin-example.so', just list
+                                        'example' or 'd:example' here.To load a
+                                        prelinked plugin, list 'p:example'
+                                        here.
+```
+
+## 7.2 Development
+
+To develop a custom FairMQ plugin, one simply needs to inherit from the `fair::mq::Plugin` base class (`#include <fairmq/Plugin.h>`) and call the `REGISTER_FAIRMQ_PLUGIN` macro. It is possible to introduce new command line option together with a plugin.
+
+The Plugin API includes:
+  * `Take/Steal/ReleaseDeviceControl()`/`GetCurrent/ChangeDeviceState()`/`SubscribeTo/UnsubscribeFromDeviceStateChange()` APIs enable controlling the device state machine. Only one plugin is authorized to control at the same time. Which one is determined by which plugin calls `TakeDeviceControl()` first.
+  * `Set/GetProperty()`/`GetPropertyKeys()`/`SubscribeTo/UnsubscribeFromPropertyChange()` APIs enable configuration of device properties.
+See [`<fairmq/Plugin.h>`](/fairmq/Plugin.h) for the full API.
+
+A more complete example which may serve as a start including example CMake code can be found here: [FairRootGroup/FairMQPlugin_example](https://github.com/FairRootGroup/FairMQPlugin_example).
+
+## 7.3 Provided Plugins
+
+### 7.3.1 PMIx
+
+The [PMIx](https://pmix.org/) plugin enables launching a FairMQ topology with any PMIx capable launcher, e.g. the [Open Run-Time Environment (ORTE) of OpenMPI](https://www.open-mpi.org/doc/v4.0/man1/mpirun.1.php) or the [Slurm workload manager](https://slurm.schedmd.com/srun.html). This experimental plugin has been last released in v1.4.56 and is removed in v1.5+. For now there are no plans to pick up development of it again.
+
+← [Back](../README.md)

docs/Transport.md

@@ -2,7 +2,7 @@
 
 # 2. Transport Interface
 
-The communication layer is available through the transport interface. Three interface implementations are currently available. Main implementation uses the [ZeroMQ](http://zeromq.org) library. Alternative implementation relies on the [nanomsg](http://nanomsg.org) library. Third transport implementation is using shared memory via boost::interprocess & ZeroMQ combination.
+The communication layer is available through the transport interface. Three interface implementations are currently available. Main implementation uses the [ZeroMQ](http://zeromq.org) library. Second transport implementation is using shared memory via boost::interprocess & ZeroMQ combination.
 
 Here is an overview to give an idea how the interface is implemented:
 
@@ -10,51 +10,51 @@ Here is an overview to give an idea how the interface is implemented:
 
 Currently, the transports have been tested to work with these communication patterns:
 
-|               | zeromq | nanomsg | shmem |
-| ------------- |--------| ------- | ----- |
-| PAIR          | yes    | yes     | yes   |
-| PUSH/PULL     | yes    | yes     | yes   |
-| PUB/SUB       | yes    | yes     | no    |
-| REQ/REP       | yes    | yes     | yes   |
+|               | zeromq | shmem |
+| ------------- |--------| ----- |
+| PAIR          | yes    | yes   |
+| PUSH/PULL     | yes    | yes   |
+| PUB/SUB       | yes    | no    |
+| REQ/REP       | yes    | yes   |
 
 The next table shows the supported address types for each transport implementation:
 
-|             | zeromq | nanomsg | shmem | comment                                       |
-| ----------- | ------ | ------- | ----- | --------------------------------------------- |
-| `inproc://` | yes    | yes     | yes   | in process: useful for unit testing           |
-| `ipc://`    | yes    | yes     | yes   | inter process comm: useful on single machine  |
-| `tcp://`    | yes    | yes     | yes   | useful for any communication, local or remote |
+|             | zeromq | shmem | comment                                       |
+| ----------- | ------ | ----- | --------------------------------------------- |
+| `inproc://` | yes    | yes   | in process: useful for unit testing           |
+| `ipc://`    | yes    | yes   | inter process comm: useful on single machine  |
+| `tcp://`    | yes    | yes   | useful for any communication, local or remote |
 
 ## 2.1 Message
 
-Devices transport data between each other in form of `FairMQMessage`s. These can be filled with arbitrary content. Message can be initialized in three different ways by calling `NewMessage()`:
+Devices transport data between each other in form of `fair::mq::Message`s. These can be filled with arbitrary content. Message can be initialized in three different ways by calling `NewMessage()`:
 
 ```cpp
-FairMQMessagePtr NewMessage() const;
+fair::mq::MessagePtr NewMessage() const;
 ```
 **with no parameters**: Initializes an empty message (typically used for receiving).
 
 ```cpp
-FairMQMessagePtr NewMessage(const size_t size) const;
+fair::mq::MessagePtr NewMessage(const size_t size) const;
 ```
 **given message size**: Initializes message body with a given size. Fill the created contents via buffer pointer.
 
 ```cpp
 using fairmq_free_fn = void(void* data, void* hint);
-FairMQMessagePtr NewMessage(void* data, const size_t size, fairmq_free_fn* ffn, void* hint = nullptr) const;
+fair::mq::MessagePtr NewMessage(void* data, const size_t size, fairmq_free_fn* ffn, void* hint = nullptr) const;
 ```
 **given existing buffer and a size**: Initialize the message from an existing buffer. In case of ZeroMQ this is a zero-copy operation.
 
 Additionally, FairMQ provides two more message factories for convenience:
 ```cpp
 template<typename T>
-FairMQMessagePtr NewSimpleMessage(const T& data) const
+fair::mq::MessagePtr NewSimpleMessage(const T& data) const
 ```
 **copy and own**: Copy the `data` argument into the returned message and take ownership (free memory after message is sent). This interface is useful for small, [trivially copyable](http://en.cppreference.com/w/cpp/concept/TriviallyCopyable) data.
 
 ```cpp
 template<typename T>
-FairMQMessagePtr NewStaticMessage(const T& data) const
+fair::mq::MessagePtr NewStaticMessage(const T& data) const
 ```
 **point to existing memory**: The returned message will point to the `data` argument, but not take ownership (someone else must destruct this variable). Make sure that `data` lives long enough to be successfully sent. This interface is most useful for third party managed, contiguous memory (Be aware of shallow types with internal pointer references! These will not be sent.)
 
@@ -65,19 +65,19 @@ The component of a program, that is reponsible for the allocation or destruction
 After queuing a message for sending in FairMQ, the transport takes ownership over the message body and will free it with `free()` after it is no longer used. A callback can be passed to the message object, to be called instead of the destruction with `free()` (for initialization via buffer+size).
 
 ```cpp
-static void FairMQNoCleanup(void* /*data*/, void* /*obj*/) {}
+static void fair::mq::NoCleanup(void* /*data*/, void* /*obj*/) {}
 
 template<typename T>
-static void FairMQSimpleMsgCleanup(void* /*data*/, void* obj) { delete static_cast<T*>(obj); }
+static void fair::mq::SimpleMsgCleanup(void* /*data*/, void* obj) { delete static_cast<T*>(obj); }
 ```
-For convenience, two common deleter callbacks are already defined in the `FairMQTransportFactory` class to aid the user in controlling ownership of the data.
+For convenience, two common deleter callbacks are already defined in the `fair::mq::TransportFactory` class to aid the user in controlling ownership of the data.
 
 ## 2.2 Channel
 
 A channel represents a communication endpoint in FairMQ. Usage is similar to a traditional Unix network socket. A device usually contains a number of channels that can either listen for incoming connections from channels of other devices or they can connect to other listening channels. Channels are organized by a channel name and a subchannel index.
 
 ```cpp
-const FairMQChannel& GetChannel(const std::string& channelName, const int index = 0) const;
+const fair::mq::Channel& GetChannel(const std::string& channelName, const int index = 0) const;
 ```
 
 All subchannels with a common channel name need to be of the same transport type.
@@ -87,7 +87,7 @@ All subchannels with a common channel name need to be of the same transport type
 A poller allows to wait on multiple channels either to receive or send a message.
 
 ```cpp
-FairMQPollerPtr NewPoller(const std::vector<const FairMQChannel*>& channels)
+fair::mq::PollerPtr NewPoller(const std::vector<const fair::mq::Channel*>& channels)
 ```
 **list channels**: This poller waits on all supplied channels. Currently, it is limited to channels of the same transport type only.
 

docs/footer.html

@@ -0,0 +1 @@
+<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>

examples/1-1/CMakeLists.txt

@@ -0,0 +1,9 @@
+################################################################################
+# Copyright (C) 2014-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+add_example(NAME 1-1 DEVICE sampler sink)

examples/1-1/README.md

@@ -0,0 +1,10 @@
+1-1: Sampler -> Sink
+====================
+
+A simple topology of two devices - **Sampler** and **Sink**. **Sampler** sends data to **Sink** via the **PUSH-PULL** pattern.
+
+`sampler.cxx` and `sink.cxx` configure and run the devices.
+
+The executables take two command line parameters: `--id` and `--channel-config`. The value of `--id` should be a unique identifier and the value for `--channel-config` is the configuration of the communication channel. .
+
+For this and the following example, all the commands needed to start the device are contained in the `fairmq-start-ex-*.sh` script (that can also be used for starting the example).

examples/1-1/fairmq-start-ex-1-1.sh.in

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+SAMPLER="fairmq-ex-1-1-sampler"
+SAMPLER+=" --id sampler1"
+SAMPLER+=" --rate 1"
+SAMPLER+=" --channel-config name=data,type=push,method=bind,address=tcp://*:5555,rateLogging=0"
+xterm -geometry 80x23+0+0 -hold -e @EX_BIN_DIR@/$SAMPLER &
+
+SINK="fairmq-ex-1-1-sink"
+SINK+=" --id sink1"
+SINK+=" --channel-config name=data,type=pull,method=connect,address=tcp://localhost:5555,rateLogging=0"
+xterm -geometry 80x23+500+0 -hold -e @EX_BIN_DIR@/$SINK &

examples/1-1/sampler.cxx

@@ -0,0 +1,69 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include <fairmq/Device.h>
+#include <fairmq/runDevice.h>
+
+#include <string>
+
+namespace bpo = boost::program_options;
+
+struct Sampler : fair::mq::Device
+{
+    void InitTask() override
+    {
+        // Get the fText and fMaxIterations values from the command line options (via fConfig)
+        fText = fConfig->GetProperty<std::string>("text");
+        fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
+    }
+
+    bool ConditionalRun() override
+    {
+        // create a copy of the data with new(), that will be deleted after the transfer is complete
+        std::string* text = new std::string(fText);
+
+        // create message object with a pointer to the data buffer, its size,
+        // custom deletion function (called when transfer is done),
+        // and pointer to the object managing the data buffer
+        fair::mq::MessagePtr msg(NewMessage(
+            const_cast<char*>(text->c_str()),
+            text->length(),
+            [](void* /*data*/, void* object) { delete static_cast<std::string*>(object); },
+            text));
+
+        LOG(info) << "Sending \"" << fText << "\"";
+
+        // in case of error or transfer interruption, return false to go to the Ready state
+        // successfull transfer will return number of bytes transfered (can be 0 if sending an empty message).
+        if (Send(msg, "data") < 0) {
+            return false;
+        } else if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations) {
+            LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+            return false;
+        }
+
+        return true;
+    }
+
+  private:
+    std::string fText;
+    uint64_t fMaxIterations = 0;
+    uint64_t fNumIterations = 0;
+};
+
+void addCustomOptions(bpo::options_description& options)
+{
+    options.add_options()
+        ("text", bpo::value<std::string>()->default_value("Hello"), "Text to send out")
+        ("max-iterations", bpo::value<uint64_t>()->default_value(0), "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)");
+}
+
+std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& /*config*/)
+{
+    return std::make_unique<Sampler>();
+}

examples/1-1/sink.cxx

@@ -0,0 +1,58 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include <fairmq/Device.h>
+#include <fairmq/runDevice.h>
+
+#include <string>
+
+namespace bpo = boost::program_options;
+
+struct Sink : fair::mq::Device
+{
+    Sink()
+    {
+        // register a handler for data arriving on "data" channel
+        OnData("data", &Sink::HandleData);
+    }
+
+    void InitTask() override
+    {
+        // Get the fMaxIterations value from the command line options (via fConfig)
+        fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
+    }
+
+    bool HandleData(fair::mq::MessagePtr& msg, int)
+    {
+        LOG(info) << "Received: \"" << std::string(static_cast<char*>(msg->GetData()), msg->GetSize()) << "\"";
+
+        if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations) {
+            LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+            return false;
+        }
+
+        // return true if you want the handler to be called again (otherwise return false go to the
+        // Ready state)
+        return true;
+    }
+
+  private:
+    uint64_t fMaxIterations = 0;
+    uint64_t fNumIterations = 0;
+};
+
+void addCustomOptions(bpo::options_description& options)
+{
+    options.add_options()
+        ("max-iterations", bpo::value<uint64_t>()->default_value(0), "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)");
+}
+
+std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& /*config*/)
+{
+    return std::make_unique<Sink>();
+}

examples/1-1/test-ex-1-1.sh.in

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+set -e
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+transport="zeromq"
+
+if [[ $1 =~ ^[a-z]+$ ]]; then
+    transport=$1
+fi
+
+session="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
+chan="data"
+chanAddr="/tmp/fmq_$session""_""$chan""_""$transport"
+
+# setup a trap to kill everything if the test fails/timeouts
+trap 'set +e; kill -TERM $SAMPLER_PID; kill -TERM $SINK_PID; wait $SAMPLER_PID; wait $SINK_PID; rm $chanAddr; exit 0' TERM
+
+SAMPLER="fairmq-ex-1-1-sampler"
+SAMPLER+=" --id sampler1"
+SAMPLER+=" --rate 1"
+SAMPLER+=" --transport $transport"
+SAMPLER+=" --verbosity veryhigh"
+SAMPLER+=" --session $session"
+SAMPLER+=" --shm-segment-size 100000000"
+SAMPLER+=" --shm-monitor true"
+SAMPLER+=" --control static --color false"
+SAMPLER+=" --max-iterations 1"
+SAMPLER+=" --channel-config name=$chan,type=push,method=bind,address=ipc://$chanAddr,rateLogging=0"
+@CMAKE_CURRENT_BINARY_DIR@/$SAMPLER &
+SAMPLER_PID=$!
+
+SINK="fairmq-ex-1-1-sink"
+SINK+=" --id sink1"
+SINK+=" --transport $transport"
+SINK+=" --verbosity veryhigh"
+SINK+=" --session $session"
+SINK+=" --shm-segment-size 100000000"
+SINK+=" --shm-monitor true"
+SINK+=" --control static --color false"
+SINK+=" --max-iterations 1"
+SINK+=" --channel-config name=$chan,type=pull,method=connect,address=ipc://$chanAddr,rateLogging=0"
+@CMAKE_CURRENT_BINARY_DIR@/$SINK &
+SINK_PID=$!
+
+# wait for sampler and sink to finish
+wait $SAMPLER_PID
+wait $SINK_PID
+
+set +e
+rm $chanAddr
+exit 0

examples/1-n-1/CMakeLists.txt

@@ -0,0 +1,9 @@
+################################################################################
+# Copyright (C) 2014-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+add_example(NAME 1-n-1 DEVICE sampler processor sink CONFIG)

examples/1-n-1/README.md

@@ -0,0 +1,12 @@
+1-n-1: Sampler -> Processor(s) -> Sink
+======================================
+
+A simple topology of three devices - **Sampler**, **Processor** and **Sink**. **Sampler** sends data to one or more **Processor**s, who modify the data and send it to one **Sink**. Transport with the **PUSH-PULL** pattern.
+
+The communication channels for this example are configured via a JSON file. The matching between device and config entry is done either via id, or the config key. For this example both processor devices share same configuration, and can therefore use same setting from the JSON file. But since their ID still has to be unique, additional command line argument must be used to allow them to share configuration. This parameter is `--config-key`.
+
+In this example the Sampler is configured to **bind** its output and the Sink is configured to also **bind** its input. This allows us run any number of processors with the same configuration, because they all connect to same Sampler and Sink addresses. Furthermore, it allows adding of processors dynamically during run-time. The PUSH and PULL sockets will handle the data distribution to/from the new devices according to their distribution strategies ([Round-robin output for PUSH](http://api.zeromq.org/4-0:zmq-socket#toc14) and [Fair-queued input for PULL](http://api.zeromq.org/4-0:zmq-socket#toc15)).
+
+The Sampler sends out a simple text string (its content configurable with `--text` command line parameter, defaul is "Hello"). Each Processor modifies the string by appending its ID to it and send it to the Sink.
+
+The provided configuration file contains two Processors. To add more Processors, you can either extend the configuration file, or create a separate file only for new processors. Or combine JSON config with `--channel-config` from other examples.

examples/1-n-1/ex-1-n-1.json

@@ -2,39 +2,49 @@
     "fairMQOptions": {
         "devices": [
             {
-                "id": "merger1",
+                "id": "sampler1",
                 "channels": [
                     {
-                        "name": "two_inputs_channel",
+                        "name": "data1",
+                        "sockets": [
+                            {
+                                "type": "push",
+                                "method": "bind",
+                                "address": "tcp://*:5555",
+                                "sndBufSize": 1000,
+                                "rcvBufSize": 1000,
+                                "rateLogging": 0
+                            }
+                        ]
+                    }
+                ]
+            },
+            {
+                "key": "processor",
+                "channels": [
+                    {
+                        "name": "data1",
                         "sockets": [
                             {
                                 "type": "pull",
-                                "method": "",
-                                "address": "tcp://*:5569",
+                                "method": "connect",
+                                "address": "tcp://localhost:5555",
                                 "sndBufSize": 1000,
                                 "rcvBufSize": 1000,
-                                "rateLogging": 1
-                            },
-                            {
-                                "type": "pull",
-                                "method": "bind",
-                                "address": "tcp://*:5570",
-                                "sndBufSize": 1000,
-                                "rcvBufSize": 1000,
-                                "rateLogging": 1
+                                "rateLogging": 0
                             }
                         ]
                     },
                     {
-                        "name": "one_output_channel",
+                        "name": "data2",
                         "sockets": [
                             {
                                 "type": "push",
                                 "method": "connect",
-                                "address": "tcp://*:5571",
+                                "address": "tcp://localhost:5556",
                                 "sndBufSize": 1000,
                                 "rcvBufSize": 1000,
-                                "rateLogging": 1
+                                "rateLogging": 0
                             }
                         ]
                     }
@@ -44,15 +54,15 @@
                 "id": "sink1",
                 "channels": [
                     {
-                        "name": "one_input",
+                        "name": "data2",
                         "sockets": [
                             {
                                 "type": "pull",
                                 "method": "bind",
-                                "address": "tcp://localhost:5571",
+                                "address": "tcp://*:5556",
                                 "sndBufSize": 1000,
                                 "rcvBufSize": 1000,
-                                "rateLogging": 1
+                                "rateLogging": 0
                             }
                         ]
                     }

examples/1-n-1/fairmq-start-ex-1-n-1.sh.in

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+ex2config="@EX_CONF_DIR@/ex-1-n-1.json"
+
+SAMPLER="fairmq-ex-1-n-1-sampler"
+SAMPLER+=" --id sampler1"
+SAMPLER+=" --mq-config $ex2config"
+xterm -geometry 80x23+0+0 -hold -e @EX_BIN_DIR@/$SAMPLER &
+
+PROCESSOR1="fairmq-ex-1-n-1-processor"
+PROCESSOR1+=" --id processor1"
+PROCESSOR1+=" --mq-config $ex2config"
+PROCESSOR1+=" --config-key processor"
+xterm -geometry 80x23+500+0 -hold -e @EX_BIN_DIR@/$PROCESSOR1 &
+
+PROCESSOR2="fairmq-ex-1-n-1-processor"
+PROCESSOR2+=" --id processor2"
+PROCESSOR2+=" --mq-config $ex2config"
+PROCESSOR2+=" --config-key processor"
+xterm -geometry 80x23+500+330 -hold -e @EX_BIN_DIR@/$PROCESSOR2 &
+
+SINK="fairmq-ex-1-n-1-sink"
+SINK+=" --id sink1"
+SINK+=" --mq-config $ex2config"
+xterm -geometry 80x23+1000+0 -hold -e @EX_BIN_DIR@/$SINK &

examples/1-n-1/processor.cxx

@@ -0,0 +1,56 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include <fairmq/Device.h>
+#include <fairmq/runDevice.h>
+
+#include <string>
+
+namespace bpo = boost::program_options;
+
+struct Processor : fair::mq::Device
+{
+    Processor()
+    {
+        OnData("data1", &Processor::HandleData);
+    }
+
+    bool HandleData(fair::mq::MessagePtr& msg, int)
+    {
+        LOG(info) << "Received data, processing...";
+
+        // Modify the received string
+        std::string* text = new std::string(static_cast<char*>(msg->GetData()), msg->GetSize());
+        *text += " (modified by " + fId + ")";
+
+        // create message object with a pointer to the data buffer,
+        // its size,
+        // custom deletion function (called when transfer is done),
+        // and pointer to the object managing the data buffer
+        fair::mq::MessagePtr msg2(NewMessage(const_cast<char*>(text->c_str()),
+                                        text->length(),
+                                        [](void* /*data*/, void* object) { delete static_cast<std::string*>(object); },
+                                        text));
+
+        // Send out the output message
+        if (Send(msg2, "data2") < 0) {
+            return false;
+        }
+
+        return true;
+    }
+};
+
+void addCustomOptions(bpo::options_description& /*options*/)
+{
+}
+
+std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& /*config*/)
+{
+    return std::make_unique<Processor>();
+}

examples/1-n-1/sampler.cxx

@@ -0,0 +1,65 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include <fairmq/Device.h>
+#include <fairmq/runDevice.h>
+
+#include <string>
+#include <thread> // this_thread::sleep_for
+#include <chrono>
+
+namespace bpo = boost::program_options;
+
+struct Sampler : fair::mq::Device
+{
+    void InitTask() override
+    {
+        // Get the fText and fMaxIterations values from the command line options (via fConfig)
+        fText = fConfig->GetProperty<std::string>("text");
+        fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
+    }
+
+    bool ConditionalRun() override
+    {
+        // Initializing message with NewStaticMessage will avoid copy
+        // but won't delete the data after the sending is completed.
+        fair::mq::MessagePtr msg(NewStaticMessage(fText));
+
+        LOG(info) << "Sending \"" << fText << "\"";
+
+        // in case of error or transfer interruption, return false to go to IDLE state
+        // successfull transfer will return number of bytes transfered (can be 0 if sending an empty message).
+        if (Send(msg, "data1") < 0) {
+            return false;
+        } else if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations) {
+            LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+            return false;
+        }
+
+        std::this_thread::sleep_for(std::chrono::seconds(1));
+
+        return true;
+    }
+
+  private:
+    std::string fText;
+    uint64_t fMaxIterations = 0;
+    uint64_t fNumIterations = 0;
+};
+
+void addCustomOptions(bpo::options_description& options)
+{
+    options.add_options()
+        ("text", bpo::value<std::string>()->default_value("Hello"), "Text to send out")
+        ("max-iterations", bpo::value<uint64_t>()->default_value(0), "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)");
+}
+
+std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& /*config*/)
+{
+    return std::make_unique<Sampler>();
+}

examples/1-n-1/sink.cxx

@@ -0,0 +1,57 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include <fairmq/Device.h>
+#include <fairmq/runDevice.h>
+
+#include <string>
+
+namespace bpo = boost::program_options;
+
+struct Sink : fair::mq::Device
+{
+    Sink()
+    {
+        // register a handler for data arriving on "data2" channel
+        OnData("data2", &Sink::HandleData);
+    }
+
+    void InitTask() override
+    {
+        // Get the fMaxIterations value from the command line options (via fConfig)
+        fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
+    }
+
+    bool HandleData(fair::mq::MessagePtr& msg, int)
+    {
+        LOG(info) << "Received: \"" << std::string(static_cast<char*>(msg->GetData()), msg->GetSize()) << "\"";
+
+        if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations) {
+            LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+            return false;
+        }
+
+        // return true if want to be called again (otherwise return false go to IDLE state)
+        return true;
+    }
+
+  private:
+    uint64_t fMaxIterations = 0;
+    uint64_t fNumIterations = 0;
+};
+
+void addCustomOptions(bpo::options_description& options)
+{
+    options.add_options()
+        ("max-iterations", bpo::value<uint64_t>()->default_value(0), "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)");
+}
+
+std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& /*config*/)
+{
+    return std::make_unique<Sink>();
+}

examples/1-n-1/test-ex-1-n-1.sh.in

@@ -0,0 +1,92 @@
+#!/bin/bash
+
+set -e
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+transport="zeromq"
+
+if [[ $1 =~ ^[a-z]+$ ]]; then
+    transport=$1
+fi
+
+session="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
+chan1="data1"
+chan2="data2"
+chan1Addr="/tmp/fmq_$session""_""$chan1""_""$transport"
+chan2Addr="/tmp/fmq_$session""_""$chan2""_""$transport"
+
+# setup a trap to kill everything if the test fails/timeouts
+trap 'set +e; kill -TERM $SAMPLER_PID; kill -TERM $SINK_PID; kill -TERM $PROCESSOR1_PID; kill -TERM $PROCESSOR2_PID; wait $SAMPLER_PID; wait $SINK_PID; wait $PROCESSOR1_PID; wait $PROCESSOR2_PID; rm $chan1Addr; rm $chan2Addr; exit 0' TERM
+
+SAMPLER="fairmq-ex-1-n-1-sampler"
+SAMPLER+=" --id sampler1"
+SAMPLER+=" --transport $transport"
+SAMPLER+=" --verbosity veryhigh"
+SAMPLER+=" --session $session"
+SAMPLER+=" --severity debug"
+SAMPLER+=" --shm-segment-size 100000000"
+SAMPLER+=" --shm-monitor true"
+SAMPLER+=" --control static --color false"
+SAMPLER+=" --max-iterations 2"
+SAMPLER+=" --channel-config name=$chan1,type=push,method=bind,address=ipc://$chan1Addr,rateLogging=0"
+@CMAKE_CURRENT_BINARY_DIR@/$SAMPLER &
+SAMPLER_PID=$!
+
+PROCESSOR1="fairmq-ex-1-n-1-processor"
+PROCESSOR1+=" --id processor1"
+PROCESSOR1+=" --transport $transport"
+PROCESSOR1+=" --verbosity veryhigh"
+PROCESSOR1+=" --session $session"
+PROCESSOR1+=" --severity debug"
+PROCESSOR1+=" --shm-segment-size 100000000"
+PROCESSOR1+=" --shm-monitor true"
+PROCESSOR1+=" --control static --color false"
+PROCESSOR1+=" --channel-config name=$chan1,type=pull,method=connect,address=ipc://$chan1Addr,rateLogging=0"
+PROCESSOR1+="                  name=$chan2,type=push,method=connect,address=ipc://$chan2Addr,rateLogging=0"
+@CMAKE_CURRENT_BINARY_DIR@/$PROCESSOR1 &
+PROCESSOR1_PID=$!
+
+PROCESSOR2="fairmq-ex-1-n-1-processor"
+PROCESSOR2+=" --id processor2"
+PROCESSOR2+=" --transport $transport"
+PROCESSOR2+=" --verbosity veryhigh"
+PROCESSOR2+=" --session $session"
+PROCESSOR2+=" --severity debug"
+PROCESSOR2+=" --shm-segment-size 100000000"
+PROCESSOR2+=" --shm-monitor true"
+PROCESSOR2+=" --control static --color false"
+PROCESSOR2+=" --channel-config name=$chan1,type=pull,method=connect,address=ipc://$chan1Addr,rateLogging=0"
+PROCESSOR2+="                  name=$chan2,type=push,method=connect,address=ipc://$chan2Addr,rateLogging=0"
+@CMAKE_CURRENT_BINARY_DIR@/$PROCESSOR2 &
+PROCESSOR2_PID=$!
+
+SINK="fairmq-ex-1-n-1-sink"
+SINK+=" --id sink1"
+SINK+=" --transport $transport"
+SINK+=" --verbosity veryhigh"
+SINK+=" --session $session"
+SINK+=" --severity debug"
+SINK+=" --shm-segment-size 100000000"
+SINK+=" --shm-monitor true"
+SINK+=" --control static --color false"
+SINK+=" --max-iterations 2"
+SINK+=" --channel-config name=$chan2,type=pull,method=bind,address=ipc://$chan2Addr,rateLogging=0"
+@CMAKE_CURRENT_BINARY_DIR@/$SINK &
+SINK_PID=$!
+
+# wait for sampler and sink to finish
+wait $SAMPLER_PID
+wait $SINK_PID
+
+# stop processors
+kill -SIGINT $PROCESSOR1_PID
+kill -SIGINT $PROCESSOR2_PID
+
+# wait for everything to finish
+wait $PROCESSOR1_PID
+wait $PROCESSOR2_PID
+
+set +e
+rm $chan1Addr; rm $chan2Addr
+exit 0

examples/CMakeLists.txt

@@ -0,0 +1,151 @@
+################################################################################
+# Copyright (C) 2018-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+set(exe_prefix "fairmq-ex")
+set(script_prefix "fairmq-start-ex")
+set(test_script_prefix "test-ex")
+set(testsuite "Example")
+set(transports "zeromq" "shmem")
+
+function(add_example)
+  cmake_parse_arguments(PARSE_ARGV 0 ARG
+    "CONFIG;NO_TRANSPORT;NO_TEST"
+    "NAME"
+    "DEVICE;VARIANT;TRANSPORT;SCRIPT"
+  )
+
+  if(ARG_UNPARSED_ARGUMENTS)
+    message(FATAL_ERROR "Unexpected unparsed arguments: ${ARG_UNPARSED_ARGUMENTS}")
+  endif()
+
+  if(ARG_NAME)
+    set(name ${ARG_NAME})
+  else()
+    message(FATAL_ERROR "NAME arg is required")
+  endif()
+
+  if(ENABLE_SANITIZER_LEAK AND CMAKE_VERSION VERSION_GREATER_EQUAL 3.22)
+    get_filename_component(lsan_supps "${CMAKE_SOURCE_DIR}/test/leak_sanitizer_suppressions.txt" ABSOLUTE)
+    set(lsan_options "LSAN_OPTIONS=set:suppressions=${lsan_supps}")
+  endif()
+
+  if(ARG_DEVICE)
+    set(exe_targets)
+    foreach(device IN LISTS ARG_DEVICE)
+      set(exe "${exe_prefix}-${name}-${device}")
+      list(APPEND exe_targets ${exe})
+      add_executable(${exe} "${device}.cxx")
+      target_link_libraries(${exe} PRIVATE FairMQ)
+    endforeach()
+  endif()
+
+  if(ARG_TRANSPORT)
+    set(transports ${ARG_TRANSPORT})
+  endif()
+
+  if(ARG_SCRIPT)
+    set(scripts ${ARG_SCRIPT})
+  else()
+    set(scripts ${ARG_NAME})
+  endif()
+
+  set(EX_BIN_DIR ${CMAKE_CURRENT_BINARY_DIR})
+  if(ARG_CONFIG)
+    set(EX_CONF_DIR ${CMAKE_CURRENT_BINARY_DIR})
+  endif()
+  set(FAIRMQ_BIN_DIR ${CMAKE_BINARY_DIR}/fairmq)
+  foreach(script IN LISTS scripts)
+    set(script_file "${script_prefix}-${script}.sh")
+    configure_file("${CMAKE_CURRENT_SOURCE_DIR}/${script_file}.in" "${CMAKE_CURRENT_BINARY_DIR}/${script_file}" @ONLY)
+  endforeach()
+
+  if(ARG_CONFIG)
+    set(config "ex-${name}.json")
+    configure_file("${CMAKE_CURRENT_SOURCE_DIR}/${config}" "${CMAKE_CURRENT_BINARY_DIR}/${config}")
+  endif()
+
+  # test
+  if(NOT ARG_NO_TEST)
+    set(test_script "${test_script_prefix}-${name}.sh")
+    configure_file("${CMAKE_CURRENT_SOURCE_DIR}/${test_script}.in" "${CMAKE_CURRENT_BINARY_DIR}/${test_script}")
+
+    if(ARG_NO_TRANSPORT)
+      set(test "${testsuite}.${name}.${transport}")
+      add_test(NAME ${test} COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${test_script} ${transport})
+      set_tests_properties(${test} PROPERTIES TIMEOUT "30")
+      if(lsan_options)
+        set_tests_properties(${test} PROPERTIES ENVIRONMENT_MODIFICATION ${lsan_options})
+      endif()
+    else()
+      foreach(transport IN LISTS transports)
+        if(ARG_VARIANT)
+          foreach(variant IN LISTS ARG_VARIANT)
+            set(test "${testsuite}.${name}.${variant}.${transport}")
+            add_test(NAME ${test} COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${test_script} ${transport} ${variant})
+            set_tests_properties(${test} PROPERTIES TIMEOUT "30")
+            if(lsan_options)
+              set_tests_properties(${test} PROPERTIES ENVIRONMENT_MODIFICATION ${lsan_options})
+            endif()
+          endforeach()
+        else()
+          set(test "${testsuite}.${name}.${transport}")
+          add_test(NAME ${test} COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${test_script} ${transport})
+          set_tests_properties(${test} PROPERTIES TIMEOUT "30")
+          if(lsan_options)
+            set_tests_properties(${test} PROPERTIES ENVIRONMENT_MODIFICATION ${lsan_options})
+          endif()
+        endif()
+      endforeach()
+    endif()
+  endif()
+
+  # install
+  install(
+    TARGETS ${exe_targets}
+    LIBRARY DESTINATION ${PROJECT_INSTALL_LIBDIR}
+    RUNTIME DESTINATION ${PROJECT_INSTALL_BINDIR}
+  )
+
+  # configure run script with different executable paths for build and for install directories
+  set(EX_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR})
+  if(ARG_CONFIG)
+    set(EX_CONF_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_DATADIR})
+  endif()
+  set(FAIRMQ_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR}/fairmq)
+  foreach(script IN LISTS scripts)
+    set(script_file "${script_prefix}-${script}.sh")
+    configure_file("${CMAKE_CURRENT_SOURCE_DIR}/${script_file}.in" "${CMAKE_CURRENT_BINARY_DIR}/${script_file}_install" @ONLY)
+    install(
+      PROGRAMS "${CMAKE_CURRENT_BINARY_DIR}/${script_file}_install"
+      DESTINATION ${PROJECT_INSTALL_BINDIR}
+      RENAME ${script_file}
+    )
+  endforeach()
+
+  if(ARG_CONFIG)
+    install(
+      FILES ${CMAKE_CURRENT_BINARY_DIR}/${config}
+      DESTINATION ${PROJECT_INSTALL_DATADIR}
+    )
+  endif()
+endfunction()
+
+add_subdirectory(1-1)
+add_subdirectory(1-n-1)
+add_subdirectory(builtin-devices)
+add_subdirectory(copypush)
+add_subdirectory(custom-controller)
+add_subdirectory(dds)
+add_subdirectory(multipart)
+add_subdirectory(multiple-channels)
+add_subdirectory(multiple-transports)
+add_subdirectory(n-m)
+add_subdirectory(qc)
+add_subdirectory(readout)
+add_subdirectory(region)
+add_subdirectory(req-rep)

examples/README.md

@@ -0,0 +1,55 @@
+# FairMQ Examples
+
+Set of FairMQ examples. More examples that combine FairMQ with FairRoot can be found in the [FairRoot repository](https://github.com/FairRootGroup/FairRoot/tree/dev/examples/).
+
+## 1-1
+
+A simple topology of two devices - **Sampler** and **Sink**. **Sampler** sends data to **Sink** with the **PUSH-PULL** pattern.
+
+## 1-n-1
+
+A simple topology of three device types - **Sampler**, **Processor** and **Sink**. **Sampler** sends data to one or more **Processor**s, who modify the data and send it to one **Sink**. Transport with the **PUSH-PULL** pattern. The example also shows the configuration via JSON files, as oposed to `--channel-config` that is used by other examples.
+
+## Built-in devices
+
+Usage of generic devies provided with FairMQ.
+
+## Copy & Push
+
+A topology consisting of one **Sampler** and two **Sink**s. The **Sampler** uses the `Copy` method to send the same data to both sinks with the **PUSH-PULL** pattern. In countrary to the **PUB-SUB** pattern, this ensures that all receivers are connected and no data is lost, but requires additional channels to be configured.
+
+## DDS
+
+This example demonstrates usage of the Dynamic Deployment System ([DDS](http://dds.gsi.de/)) to dynamically deploy and configure a topology of devices. The topology is similar to those of Example 2, but now it can be easily distributed on different computing nodes without the need for manual reconfiguration of the devices.
+
+## Multipart
+
+This example shows how to send a multipart message from one device to the other. (two parts message parts - header and body).
+
+## Multiple Channels
+
+This example demonstrates how to work with multiple channels and multiplex between them.
+
+## Multiple Transports
+
+This examples shows how to combine different channel transports (zeromq/shmem) inside of one device and/or topology.
+
+## n-m
+
+A topology consisting of three layers of devices: synchronizer -> n * senders -> m * receivers.
+
+## QC
+
+A topology consisting of 4 devices - Sampler, QCDispatcher, QCTask and Sink. The data flows from Sampler through QCDispatcher to Sink. On demand - by setting the corresponding configuration property - the QCDispatcher device will duplicate the data to the QCTask device. The property is set by the topology controller, in this example this is the `fairmq-dds-command-ui` utility.
+
+## Readout
+
+Two example topologies of setups to be distributed to two kinds of nodes - detector readout node and processing node. Detector readout node contains readout process, data builder and data sender (and optionally an additional processor), while processing node contains data receiver devices. communication within readout nodes is done via unmanaged region through shared memory transport.
+
+## Region
+
+This example demonstrates the use of a more advanced feature - UnmanagedRegion, that can be used to create a buffer through one of FairMQ transports. The contents of this buffer are managed by the user, who can also create messages out of sub-buffers of the created buffer. Such feature can be interesting in environments that have special requirements by the hardware that writes the data, to keep the transfer efficient (e.g. shared memory).
+
+## Request & Reply
+
+This topology contains two devices that communicate with each other via the **REQ-REP** pettern. Bidirectional communication via a single socket.

examples/builtin-devices/CMakeLists.txt

@@ -0,0 +1,11 @@
+################################################################################
+# Copyright (C) 2014-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+add_example(NAME builtin-devices
+  VARIANT single_msg multipart
+)

examples/builtin-devices/README.md

@@ -0,0 +1,4 @@
+Built-in devices
+==========================
+
+This example demonstrates use of generic devices that are provided with FairMQ - BenchmarkSampler, Merger, Multiplier, Proxy, Sink, Splitter. They are all connected in one topology and transfer some dummy buffers generated by the BenchmarkSampler.

examples/builtin-devices/fairmq-start-ex-builtin-devices.sh.in

@@ -0,0 +1,93 @@
+#!/bin/bash
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+transport="zeromq"
+multipart="false"
+numParts="1"
+
+if [[ $1 =~ ^[a-z]+$ ]]; then
+    transport=$1
+fi
+
+if [[ $2 =~ ^[a-z]+$ ]]; then
+    multipart=$2
+fi
+
+if [[ $3 =~ ^[0-9]+$ ]]; then
+    numParts=$3
+fi
+
+SAMPLER="fairmq-bsampler"
+SAMPLER+=" --id bsampler1"
+SAMPLER+=" --transport $transport"
+SAMPLER+=" --control interactive"
+SAMPLER+=" --severity debug"
+SAMPLER+=" --msg-size 100000"
+SAMPLER+=" --multipart $multipart"
+SAMPLER+=" --num-parts $numParts"
+SAMPLER+=" --msg-rate 100"
+SAMPLER+=" --max-iterations 0"
+SAMPLER+=" --out-channel data1"
+SAMPLER+=" --channel-config name=data1,type=push,method=bind,sndBufSize=50,rcvBufSize=50,address=tcp://localhost:5555"
+xterm -geometry 90x20+0+175 -hold -e @FAIRMQ_BIN_DIR@/$SAMPLER &
+
+SPLITTER="fairmq-splitter"
+SPLITTER+=" --id splitter"
+SPLITTER+=" --transport $transport"
+SPLITTER+=" --multipart $multipart"
+SPLITTER+=" --in-channel data1"
+SPLITTER+=" --out-channel data2"
+SPLITTER+=" --channel-config name=data1,type=pull,method=connect,sndBufSize=50,rcvBufSize=50,address=tcp://localhost:5555"
+SPLITTER+="                  name=data2,type=push,method=bind,sndBufSize=50,rcvBufSize=50,address=tcp://localhost:5556,address=tcp://localhost:5557"
+xterm -geometry 90x20+0+475 -hold -e @FAIRMQ_BIN_DIR@/$SPLITTER &
+
+PROXY1="fairmq-proxy"
+PROXY1+=" --id proxy1"
+PROXY1+=" --transport $transport"
+PROXY1+=" --multipart $multipart"
+PROXY1+=" --in-channel data2"
+PROXY1+=" --out-channel data3"
+PROXY1+=" --channel-config name=data2,type=pull,method=connect,sndBufSize=50,rcvBufSize=50,address=tcp://localhost:5556"
+PROXY1+="                  name=data3,type=push,method=connect,sndBufSize=50,rcvBufSize=50,address=tcp://localhost:5558"
+xterm -geometry 90x20+550+175 -hold -e @FAIRMQ_BIN_DIR@/$PROXY1 &
+
+PROXY2="fairmq-proxy"
+PROXY2+=" --id proxy2"
+PROXY2+=" --transport $transport"
+PROXY2+=" --multipart $multipart"
+PROXY2+=" --in-channel data2"
+PROXY2+=" --out-channel data3"
+PROXY2+=" --channel-config name=data2,type=pull,method=connect,sndBufSize=50,rcvBufSize=50,address=tcp://localhost:5557"
+PROXY2+="                  name=data3,type=push,method=connect,sndBufSize=50,rcvBufSize=50,address=tcp://localhost:5559"
+xterm -geometry 90x20+550+475 -hold -e @FAIRMQ_BIN_DIR@/$PROXY2 &
+
+MERGER="fairmq-merger"
+MERGER+=" --id merger"
+MERGER+=" --transport $transport"
+MERGER+=" --multipart $multipart"
+MERGER+=" --in-channel data3"
+MERGER+=" --out-channel data4"
+MERGER+=" --channel-config name=data3,type=pull,method=bind,sndBufSize=50,rcvBufSize=50,address=tcp://localhost:5558,address=tcp://localhost:5559"
+MERGER+="                  name=data4,type=push,method=connect,sndBufSize=50,rcvBufSize=50,address=tcp://localhost:5560"
+xterm -geometry 90x20+1100+50 -hold -e @FAIRMQ_BIN_DIR@/$MERGER &
+
+MULTIPLIER="fairmq-multiplier"
+MULTIPLIER+=" --id multiplier"
+MULTIPLIER+=" --transport $transport"
+MULTIPLIER+=" --multipart $multipart"
+MULTIPLIER+=" --in-channel data4"
+MULTIPLIER+=" --out-channel data5"
+MULTIPLIER+=" --channel-config name=data4,type=pull,method=bind,sndBufSize=50,rcvBufSize=50,address=tcp://localhost:5560"
+MULTIPLIER+="                  name=data5,type=push,method=connect,sndBufSize=50,rcvBufSize=50,address=tcp://localhost:5561,address=tcp://localhost:5561"
+xterm -geometry 90x20+1100+350 -hold -e @FAIRMQ_BIN_DIR@/$MULTIPLIER &
+
+SINK="fairmq-sink"
+SINK+=" --id sink1"
+SINK+=" --transport $transport"
+SINK+=" --severity debug"
+SINK+=" --multipart $multipart"
+SINK+=" --max-iterations 0"
+SINK+=" --in-channel data5"
+SINK+=" --channel-config name=data5,type=pull,method=bind,sndBufSize=50,rcvBufSize=50,address=tcp://localhost:5561"
+xterm -geometry 90x20+1100+650 -hold -e @FAIRMQ_BIN_DIR@/$SINK &

examples/builtin-devices/test-ex-builtin-devices.sh.in

@@ -0,0 +1,176 @@
+#!/bin/bash
+
+set -e
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+transport="zeromq"
+multipart="false"
+numParts="1"
+
+if [[ $1 =~ ^[a-z]+$ ]]; then
+    transport=$1
+fi
+
+if [[ $2 =~ ^multipart$ ]]; then
+    multipart="true"
+    numParts=2
+fi
+
+session="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
+chan1="data1"
+chan2="data2"
+chan3="data3"
+chan4="data4"
+chan5="data5"
+chan1Addr="/tmp/fmq_$session""_""$chan1""_""$transport"
+chan2Addr1="/tmp/fmq_$session""_""$chan2""_1""_""$transport"
+chan2Addr2="/tmp/fmq_$session""_""$chan2""_2""_""$transport"
+chan3Addr1="/tmp/fmq_$session""_""$chan3""_1""_""$transport"
+chan3Addr2="/tmp/fmq_$session""_""$chan3""_2""_""$transport"
+chan4Addr="/tmp/fmq_$session""_""$chan4""_""$transport"
+chan5Addr="/tmp/fmq_$session""_""$chan5""_""$transport"
+
+# setup a trap to kill everything if the test fails/timeouts
+trap 'set +e; kill -TERM $SAMPLER_PID; kill -TERM $SPLITTER_PID; kill -TERM $PROXY1_PID; kill -TERM $PROXY2_PID; kill -TERM $MERGER_PID; kill -TERM $MULTIPLIER_PID; kill -TERM $SINK_PID; rm $chan1Addr; rm $chan2Addr1; rm $chan2Addr2; rm $chan3Addr1; rm $chan3Addr2; rm $chan4Addr; rm $chan5Addr; exit 0' TERM
+
+SAMPLER="fairmq-bsampler"
+SAMPLER+=" --id bsampler1"
+SAMPLER+=" --session $SESSION"
+SAMPLER+=" --transport $transport"
+SAMPLER+=" --color false"
+SAMPLER+=" --control static"
+SAMPLER+=" --verbosity veryhigh"
+SAMPLER+=" --shm-segment-size 100000000"
+SAMPLER+=" --shm-monitor true"
+SAMPLER+=" --severity debug"
+SAMPLER+=" --msg-size 100000"
+SAMPLER+=" --multipart $multipart"
+SAMPLER+=" --num-parts $numParts"
+SAMPLER+=" --msg-rate 1"
+SAMPLER+=" --max-iterations 0"
+SAMPLER+=" --out-channel $chan1"
+SAMPLER+=" --channel-config name=$chan1,type=push,method=bind,sndBufSize=50,rcvBufSize=50,address=ipc://$chan1Addr"
+@FAIRMQ_BIN_DIR@/$SAMPLER &
+SAMPLER_PID=$!
+
+SPLITTER="fairmq-splitter"
+SPLITTER+=" --id splitter"
+SPLITTER+=" --session $SESSION"
+SPLITTER+=" --transport $transport"
+SPLITTER+=" --color false"
+SPLITTER+=" --control static"
+SPLITTER+=" --verbosity veryhigh"
+SPLITTER+=" --shm-segment-size 100000000"
+SPLITTER+=" --shm-monitor true"
+SPLITTER+=" --multipart $multipart"
+SPLITTER+=" --in-channel $chan1"
+SPLITTER+=" --out-channel $chan2"
+SPLITTER+=" --channel-config name=$chan1,type=pull,method=connect,sndBufSize=50,rcvBufSize=50,address=ipc://$chan1Addr"
+SPLITTER+="                  name=$chan2,type=push,method=bind,sndBufSize=50,rcvBufSize=50,address=ipc://$chan2Addr1,address=ipc://$chan2Addr2"
+@FAIRMQ_BIN_DIR@/$SPLITTER &
+SPLITTER_PID=$!
+
+PROXY1="fairmq-proxy"
+PROXY1+=" --id proxy1"
+PROXY1+=" --session $SESSION"
+PROXY1+=" --transport $transport"
+PROXY1+=" --color false"
+PROXY1+=" --control static"
+PROXY1+=" --verbosity veryhigh"
+PROXY1+=" --shm-segment-size 100000000"
+PROXY1+=" --shm-monitor true"
+PROXY1+=" --multipart $multipart"
+PROXY1+=" --in-channel $chan2"
+PROXY1+=" --out-channel $chan3"
+PROXY1+=" --channel-config name=$chan2,type=pull,method=connect,sndBufSize=50,rcvBufSize=50,address=ipc://$chan2Addr1"
+PROXY1+="                  name=$chan3,type=push,method=connect,sndBufSize=50,rcvBufSize=50,address=ipc://$chan3Addr1"
+@FAIRMQ_BIN_DIR@/$PROXY1 &
+PROXY1_PID=$!
+
+PROXY2="fairmq-proxy"
+PROXY2+=" --id proxy2"
+PROXY2+=" --session $SESSION"
+PROXY2+=" --transport $transport"
+PROXY2+=" --color false"
+PROXY2+=" --control static"
+PROXY2+=" --verbosity veryhigh"
+PROXY2+=" --shm-segment-size 100000000"
+PROXY2+=" --shm-monitor true"
+PROXY2+=" --multipart $multipart"
+PROXY2+=" --in-channel $chan2"
+PROXY2+=" --out-channel $chan3"
+PROXY2+=" --channel-config name=$chan2,type=pull,method=connect,sndBufSize=50,rcvBufSize=50,address=ipc://$chan2Addr2"
+PROXY2+="                  name=$chan3,type=push,method=connect,sndBufSize=50,rcvBufSize=50,address=ipc://$chan3Addr2"
+@FAIRMQ_BIN_DIR@/$PROXY2 &
+PROXY2_PID=$!
+
+MERGER="fairmq-merger"
+MERGER+=" --id merger"
+MERGER+=" --session $SESSION"
+MERGER+=" --transport $transport"
+MERGER+=" --color false"
+MERGER+=" --control static"
+MERGER+=" --verbosity veryhigh"
+MERGER+=" --shm-segment-size 100000000"
+MERGER+=" --shm-monitor true"
+MERGER+=" --multipart $multipart"
+MERGER+=" --in-channel $chan3"
+MERGER+=" --out-channel $chan4"
+MERGER+=" --channel-config name=$chan3,type=pull,method=bind,sndBufSize=50,rcvBufSize=50,address=ipc://$chan3Addr1,address=ipc://$chan3Addr2"
+MERGER+="                  name=$chan4,type=push,method=connect,sndBufSize=50,rcvBufSize=50,address=ipc://$chan4Addr"
+@FAIRMQ_BIN_DIR@/$MERGER &
+MERGER_PID=$!
+
+MULTIPLIER="fairmq-multiplier"
+MULTIPLIER+=" --id multiplier"
+MULTIPLIER+=" --session $SESSION"
+MULTIPLIER+=" --transport $transport"
+MULTIPLIER+=" --color false"
+MULTIPLIER+=" --control static"
+MULTIPLIER+=" --verbosity veryhigh"
+MULTIPLIER+=" --shm-segment-size 100000000"
+MULTIPLIER+=" --shm-monitor true"
+MULTIPLIER+=" --multipart $multipart"
+MULTIPLIER+=" --in-channel $chan4"
+MULTIPLIER+=" --out-channel $chan5"
+MULTIPLIER+=" --channel-config name=$chan4,type=pull,method=bind,sndBufSize=50,rcvBufSize=50,address=ipc://$chan4Addr"
+MULTIPLIER+="                  name=$chan5,type=push,method=connect,sndBufSize=50,rcvBufSize=50,address=ipc://$chan5Addr,address=ipc://$chan5Addr"
+@FAIRMQ_BIN_DIR@/$MULTIPLIER &
+MULTIPLIER_PID=$!
+
+SINK="fairmq-sink"
+SINK+=" --id sink1"
+SINK+=" --session $SESSION"
+SINK+=" --transport $transport"
+SINK+=" --color false"
+SINK+=" --control static"
+SINK+=" --verbosity veryhigh"
+SINK+=" --severity debug"
+SINK+=" --multipart $multipart"
+SINK+=" --shm-monitor true"
+SINK+=" --max-iterations 2"
+SINK+=" --in-channel $chan5"
+SINK+=" --channel-config name=$chan5,type=pull,method=bind,sndBufSize=50,rcvBufSize=50,address=ipc://$chan5Addr"
+@FAIRMQ_BIN_DIR@/$SINK &
+SINK_PID=$!
+
+wait $SINK_PID
+
+kill -SIGINT $SAMPLER_PID
+kill -SIGINT $SPLITTER_PID
+kill -SIGINT $PROXY1_PID
+kill -SIGINT $PROXY2_PID
+kill -SIGINT $MERGER_PID
+kill -SIGINT $MULTIPLIER_PID
+
+wait $SAMPLER_PID
+wait $SPLITTER_PID
+wait $PROXY1_PID
+wait $PROXY2_PID
+wait $MERGER_PID
+wait $MULTIPLIER_PID
+
+set +e
+rm $chan1Addr; rm $chan2Addr1; rm $chan2Addr2; rm $chan3Addr1; rm $chan3Addr2; rm $chan4Addr; rm $chan5Addr
+exit 0

examples/copypush/CMakeLists.txt

@@ -0,0 +1,11 @@
+################################################################################
+# Copyright (C) 2014-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+add_example(NAME copypush
+  DEVICE sampler sink
+)

examples/copypush/README.md

@@ -0,0 +1,4 @@
+Copy & Push
+===========
+
+A topology consisting of one **Sampler** and two **Sink**s. The **Sampler** uses the `Copy` method to send the same data to both sinks with the **PUSH-PULL** pattern. In contrary to the **PUB-SUB** pattern, this ensures that all receivers are connected and no data is lost, but requires additional sockets.

examples/copypush/fairmq-start-ex-copypush.sh.in

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+SAMPLER="fairmq-ex-copypush-sampler"
+SAMPLER+=" --id sampler1"
+SAMPLER+=" --channel-config name=data,type=push,method=bind,rateLogging=0,address=tcp://*:5555,address=tcp://*:5556"
+xterm -geometry 80x23+0+165 -hold -e @EX_BIN_DIR@/$SAMPLER &
+
+SINK1="fairmq-ex-copypush-sink"
+SINK1+=" --id sink1"
+SINK1+=" --channel-config name=data,type=pull,method=connect,rateLogging=0,address=tcp://localhost:5555"
+xterm -geometry 80x23+500+0 -hold -e @EX_BIN_DIR@/$SINK1 &
+
+SINK2="fairmq-ex-copypush-sink"
+SINK2+=" --id sink2"
+SINK2+=" --channel-config name=data,type=pull,method=connect,rateLogging=0,address=tcp://localhost:5556"
+xterm -geometry 80x23+500+330 -hold -e @EX_BIN_DIR@/$SINK2 &

examples/copypush/sampler.cxx

@@ -0,0 +1,65 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include <fairmq/Device.h>
+#include <fairmq/runDevice.h>
+
+#include <chrono>
+#include <cstdint> // uint64_t
+#include <thread> // this_thread::sleep_for
+
+namespace bpo = boost::program_options;
+
+struct Sampler : fair::mq::Device
+{
+    void InitTask() override
+    {
+        fNumDataChannels = GetNumSubChannels("data");
+        fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
+    }
+
+    bool ConditionalRun() override
+    {
+        // NewSimpleMessage creates a copy of the data and takes care of its destruction (after the transfer takes place).
+        // Should only be used for small data because of the cost of an additional copy
+        fair::mq::MessagePtr msg(NewSimpleMessage(fCounter++));
+
+        for (int i = 0; i < fNumDataChannels - 1; ++i) {
+            fair::mq::MessagePtr msgCopy(NewMessage());
+            msgCopy->Copy(*msg);
+            Send(msgCopy, "data", i);
+        }
+        Send(msg, "data", fNumDataChannels - 1);
+
+        if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations) {
+            LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+            return false;
+        }
+
+        std::this_thread::sleep_for(std::chrono::seconds(1));
+
+        return true;
+    }
+
+  private:
+    int fNumDataChannels = 0;
+    uint64_t fCounter = 0;
+    uint64_t fMaxIterations = 0;
+    uint64_t fNumIterations = 0;
+};
+
+void addCustomOptions(bpo::options_description& options)
+{
+    options.add_options()
+        ("max-iterations", bpo::value<uint64_t>()->default_value(0), "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)");
+}
+
+std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& /*config*/)
+{
+    return std::make_unique<Sampler>();
+}

examples/copypush/sink.cxx

@@ -0,0 +1,57 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include <fairmq/Device.h>
+#include <fairmq/runDevice.h>
+
+#include <cstdint> // uint64_t
+
+namespace bpo = boost::program_options;
+
+struct Sink : fair::mq::Device
+{
+    Sink()
+    {
+        OnData("data", &Sink::HandleData);
+    }
+
+  protected:
+    void InitTask() override
+    {
+        // Get the fMaxIterations value from the command line options (via fConfig)
+        fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
+    }
+
+    bool HandleData(fair::mq::MessagePtr& msg, int)
+    {
+        LOG(info) << "Received message: \"" << *(static_cast<uint64_t*>(msg->GetData())) << "\"";
+
+        if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations) {
+            LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+            return false;
+        }
+
+        // return true if want to be called again (otherwise go to IDLE state)
+        return true;
+    }
+
+  private:
+    uint64_t fMaxIterations = 0;
+    uint64_t fNumIterations = 0;
+};
+
+void addCustomOptions(bpo::options_description& options)
+{
+    options.add_options()
+        ("max-iterations", bpo::value<uint64_t>()->default_value(0), "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)");
+}
+
+std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& /*config*/)
+{
+    return std::make_unique<Sink>();
+}

examples/copypush/test-ex-copypush.sh.in

@@ -0,0 +1,70 @@
+#!/bin/bash
+
+set -e
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+transport="zeromq"
+
+if [[ $1 =~ ^[a-z]+$ ]]; then
+    transport=$1
+fi
+
+session="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
+chan="data"
+chanAddr1="/tmp/fmq_$session""_""$chan""_1""_""$transport"
+chanAddr2="/tmp/fmq_$session""_""$chan""_2""_""$transport"
+
+# setup a trap to kill everything if the test fails/timeouts
+trap 'set +e; kill -TERM $SAMPLER_PID; kill -TERM $SINK1_PID; kill -TERM $SINK2_PID; wait $SAMPLER_PID; wait $SINK1_PID; wait $SINK2_PID; rm $chanAddr1; rm $chanAddr2; exit 0' TERM
+
+SAMPLER="fairmq-ex-copypush-sampler"
+SAMPLER+=" --id sampler1"
+SAMPLER+=" --transport $transport"
+SAMPLER+=" --verbosity veryhigh"
+SAMPLER+=" --severity debug"
+SAMPLER+=" --shm-segment-size 100000000"
+SAMPLER+=" --shm-monitor true"
+SAMPLER+=" --session $session"
+SAMPLER+=" --control static --color false"
+SAMPLER+=" --max-iterations 1"
+SAMPLER+=" --channel-config name=$chan,type=push,method=bind,rateLogging=0,address=ipc://$chanAddr1,address=ipc://$chanAddr2"
+@CMAKE_CURRENT_BINARY_DIR@/$SAMPLER &
+SAMPLER_PID=$!
+
+SINK1="fairmq-ex-copypush-sink"
+SINK1+=" --id sink1"
+SINK1+=" --transport $transport"
+SINK1+=" --verbosity veryhigh"
+SINK1+=" --severity debug"
+SINK1+=" --shm-segment-size 100000000"
+SINK1+=" --shm-monitor true"
+SINK1+=" --session $session"
+SINK1+=" --control static --color false"
+SINK1+=" --max-iterations 1"
+SINK1+=" --channel-config name=$chan,type=pull,method=connect,rateLogging=0,address=ipc://$chanAddr1"
+@CMAKE_CURRENT_BINARY_DIR@/$SINK1 &
+SINK1_PID=$!
+
+SINK2="fairmq-ex-copypush-sink"
+SINK2+=" --id sink2"
+SINK2+=" --transport $transport"
+SINK2+=" --verbosity veryhigh"
+SINK2+=" --severity debug"
+SINK2+=" --shm-segment-size 100000000"
+SINK2+=" --shm-monitor true"
+SINK2+=" --session $session"
+SINK2+=" --control static --color false"
+SINK2+=" --max-iterations 1"
+SINK2+=" --channel-config name=$chan,type=pull,method=connect,rateLogging=0,address=ipc://$chanAddr2"
+@CMAKE_CURRENT_BINARY_DIR@/$SINK2 &
+SINK2_PID=$!
+
+# wait for everything to finish
+wait $SAMPLER_PID
+wait $SINK1_PID
+wait $SINK2_PID
+
+set +e
+rm $chanAddr1; rm $chanAddr2
+exit 0

examples/custom-controller/CMakeLists.txt

@@ -0,0 +1,20 @@
+################################################################################
+# Copyright (C) 2022-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+set(name "custom-controller")
+set(exe "${exe_prefix}-${name}")
+add_executable(${exe} main.cxx)
+target_link_libraries(${exe} PRIVATE FairMQ)
+set_target_properties(${exe} PROPERTIES ENABLE_EXPORTS ON)
+
+set(test "${testsuite}.${name}")
+add_test(NAME ${test} COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${exe})
+set_tests_properties(${test} PROPERTIES TIMEOUT 30)
+if(lsan_options)
+  set_tests_properties(${test} PROPERTIES ENVIRONMENT_MODIFICATION ${lsan_options})
+endif()

examples/custom-controller/MyController.h

@@ -0,0 +1,97 @@
+/********************************************************************************
+ *    Copyright (C) 2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#ifndef FAIR_MQ_EXAMPLE_CUSTOM_CONTROLLER_PLUGIN
+#define FAIR_MQ_EXAMPLE_CUSTOM_CONTROLLER_PLUGIN
+
+#include <fairmq/Plugin.h>
+#include <utility>   // for std::forward
+
+namespace example {
+
+struct MyController : fair::mq::Plugin   // NOLINT
+{
+    template<typename... Args>
+    MyController(Args&&... args)
+        : Plugin(std::forward<Args>(args)...)
+    {
+        TakeDeviceControl();
+
+        SubscribeToDeviceStateChange([this](auto state) {
+            auto shutdown = GetProperty<bool>("please-shut-me-down", false);
+            try {
+                switch (state) {
+                    case DeviceState::Idle: {
+                        ChangeDeviceState(shutdown ? DeviceStateTransition::End
+                                                    : DeviceStateTransition::InitDevice);
+                        break;
+                    }
+                    case DeviceState::InitializingDevice: {
+                        ChangeDeviceState(DeviceStateTransition::CompleteInit);
+                        break;
+                    }
+                    case DeviceState::Initialized: {
+                        ChangeDeviceState(DeviceStateTransition::Bind);
+                        break;
+                    }
+                    case DeviceState::Bound: {
+                        ChangeDeviceState(DeviceStateTransition::Connect);
+                        break;
+                    }
+                    case DeviceState::DeviceReady: {
+                        ChangeDeviceState(shutdown ? DeviceStateTransition::ResetDevice
+                                                    : DeviceStateTransition::InitTask);
+                        break;
+                    }
+                    case DeviceState::Ready: {
+                        ChangeDeviceState(shutdown ? DeviceStateTransition::ResetTask
+                                                    : DeviceStateTransition::Run);
+                        break;
+                    }
+                    case DeviceState::Running: {
+                        ChangeDeviceState(DeviceStateTransition::Stop);
+                        break;
+                    }
+                    case DeviceState::Exiting: {
+                        ReleaseDeviceControl();
+                        break;
+                    }
+                    default:
+                        break;
+                }
+            } catch (fair::mq::PluginServices::DeviceControlError const&) {
+                // this means we do not have device control
+            }
+        });
+    }
+
+    ~MyController() override { ReleaseDeviceControl(); }
+};
+
+// auto MyControllerProgramOptions() -> fair::mq::Plugin::ProgOptions
+// {
+// auto plugin_options = boost::program_options::options_description{"MyController Plugin"};
+// plugin_options.add_options()
+// ("custom-dummy-option", boost::program_options::value<std::string>(), "Cool custom option.")
+// ("custom-dummy-option2", boost::program_options::value<std::string>(), "Another one.");
+// return plugin_options;
+// }
+
+}   // namespace example
+
+REGISTER_FAIRMQ_PLUGIN(example::MyController,   // Class name
+                       mycontroller,            // Plugin name (string, lower case chars only)
+                       (fair::mq::Plugin::Version{0, 42, 0}),     // Version
+                       "Mr. Dummy <dummy@test.net>",              // Maintainer
+                       "https://git.test.net/mycontroller.git",   // Homepage
+                       //                       example::MyControllerProgramOptions   // Free
+                       //                       function which declares custom
+                       // program options for the plugin
+                       fair::mq::Plugin::NoProgramOptions)
+
+#endif /* FAIR_MQ_EXAMPLE_CUSTOM_CONTROLLER_PLUGIN */

examples/custom-controller/MyDevice.h

@@ -1,16 +1,21 @@
 /********************************************************************************
- *    Copyright (C) 2017 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *    Copyright (C) 2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
  *                  copied verbatim in the file "LICENSE"                       *
  ********************************************************************************/
 
-#include <gtest/gtest.h>
+#ifndef FAIR_MQ_EXAMPLE_CUSTOM_CONTROLLER_DEVICE
+#define FAIR_MQ_EXAMPLE_CUSTOM_CONTROLLER_DEVICE
+
+#include <fairmq/Device.h>
+
+namespace example {
+
+using MyDevice = fair::mq::Device;
+
+}   // namespace example
+
+#endif /* FAIR_MQ_EXAMPLE_CUSTOM_CONTROLLER_DEVICE */
 
-auto main(int argc, char** argv) -> int
-{
-    ::testing::InitGoogleTest(&argc, argv);
-    ::testing::FLAGS_gtest_death_test_style = "threadsafe";
-    return RUN_ALL_TESTS();
-}

examples/custom-controller/main.cxx

@@ -0,0 +1,46 @@
+/********************************************************************************
+ *    Copyright (C) 2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "MyController.h"
+#include "MyDevice.h"
+
+#include <chrono>   // for std::chrono_literals
+#include <fairlogger/Logger.h>
+#include <fairmq/DeviceRunner.h>
+#include <memory>   // for std::make_unique
+
+int main(int argc, char* argv[])
+{
+    using namespace fair::mq;
+    using namespace std::chrono_literals;
+
+    DeviceRunner runner(argc, argv);
+
+    runner.AddHook<hooks::LoadPlugins>([](DeviceRunner& r) {
+        r.fPluginManager.LoadPlugin("s:mycontroller");
+        // 's:' stands for static because the plugin is compiled into the executable
+        // 'mycontroller' is the plugin name passed as second arg to REGISTER_FAIRMQ_PLUGIN
+    });
+
+    fair::Logger::SetConsoleSeverity(fair::Severity::debug);
+
+    runner.AddHook<hooks::InstantiateDevice>([](DeviceRunner& r) {
+        r.fConfig.SetProperty<int>("catch-signals", 0);
+        r.fConfig.SetProperty<bool>("please-shut-me-down", false);
+        r.fDevice = std::make_unique<example::MyDevice>(r.fConfig);
+
+        r.fDevice->SubscribeToStateChange("example", [&r](auto state) {
+            if (state == State::Running) {
+                r.fDevice->WaitFor(3s);
+                r.fConfig.SetProperty<bool>("please-shut-me-down", true);
+            }
+        });
+    });
+
+    return runner.RunWithExceptionHandlers();
+}

examples/dds/CMakeLists.txt

@@ -0,0 +1,85 @@
+################################################################################
+#  Copyright (C) 2014-2019 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+add_executable(fairmq-ex-dds-sampler sampler.cxx)
+target_link_libraries(fairmq-ex-dds-sampler PRIVATE FairMQ)
+
+add_executable(fairmq-ex-dds-processor processor.cxx)
+target_link_libraries(fairmq-ex-dds-processor PRIVATE FairMQ)
+
+add_executable(fairmq-ex-dds-sink sink.cxx)
+target_link_libraries(fairmq-ex-dds-sink PRIVATE FairMQ)
+
+add_custom_target(ExampleDDS DEPENDS fairmq-ex-dds-sampler fairmq-ex-dds-processor fairmq-ex-dds-sink)
+
+list(JOIN Boost_LIBRARY_DIRS ":" LIB_DIR)
+set(BIN_DIR ${CMAKE_CURRENT_BINARY_DIR}:${CMAKE_BINARY_DIR}/fairmq/sdk)
+set(DATA_DIR ${CMAKE_CURRENT_BINARY_DIR})
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/ex-dds-topology.xml ${CMAKE_CURRENT_BINARY_DIR}/ex-dds-topology.xml @ONLY)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/ex-dds-topology-infinite.xml ${CMAKE_CURRENT_BINARY_DIR}/ex-dds-topology-infinite.xml @ONLY)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/ex-dds-hosts.cfg ${CMAKE_CURRENT_BINARY_DIR}/ex-dds-hosts.cfg COPYONLY)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-ex-dds-env.sh ${CMAKE_CURRENT_BINARY_DIR}/fairmq-ex-dds-env.sh @ONLY)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-dds.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-dds.sh @ONLY)
+
+# test
+# if(DDS_FOUND)
+  # add_test(NAME Example.DDS.localhost COMMAND ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-dds.sh localhost)
+  # set_tests_properties(Example.DDS.localhost PROPERTIES
+    # TIMEOUT 15
+    # PASS_REGULAR_EXPRESSION "Example successful"
+  # )
+# endif()
+
+# install
+
+install(
+  TARGETS
+  fairmq-ex-dds-sampler
+  fairmq-ex-dds-processor
+  fairmq-ex-dds-sink
+
+  LIBRARY DESTINATION ${PROJECT_INSTALL_LIBDIR}
+  RUNTIME DESTINATION ${PROJECT_INSTALL_BINDIR}
+)
+
+# configure run script with different executable paths for build and for install directories
+set(BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR})
+set(DATA_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_DATADIR})
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/ex-dds-topology.xml ${CMAKE_CURRENT_BINARY_DIR}/ex-dds-topology.xml_install @ONLY)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/ex-dds-topology-infinite.xml ${CMAKE_CURRENT_BINARY_DIR}/ex-dds-topology-infinite.xml_install @ONLY)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-ex-dds-env.sh ${CMAKE_CURRENT_BINARY_DIR}/fairmq-ex-dds-env.sh_install @ONLY)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-dds.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-dds.sh_install @ONLY)
+
+install(
+  FILES ${CMAKE_CURRENT_BINARY_DIR}/ex-dds-topology.xml_install
+  DESTINATION ${PROJECT_INSTALL_DATADIR}
+  RENAME ex-dds-topology.xml
+)
+
+install(
+  FILES ${CMAKE_CURRENT_BINARY_DIR}/ex-dds-topology-infinite.xml_install
+  DESTINATION ${PROJECT_INSTALL_DATADIR}
+  RENAME ex-dds-topology-infinite.xml
+)
+
+install(
+  FILES ${CMAKE_CURRENT_BINARY_DIR}/ex-dds-hosts.cfg
+  DESTINATION ${PROJECT_INSTALL_DATADIR}
+)
+
+install(
+  PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/fairmq-ex-dds-env.sh_install
+  DESTINATION ${PROJECT_INSTALL_BINDIR}
+  RENAME fairmq-ex-dds-env.sh
+)
+
+install(
+  PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-dds.sh_install
+  DESTINATION ${PROJECT_INSTALL_BINDIR}
+  RENAME fairmq-start-ex-dds.sh
+)

examples/dds/README.md

@@ -0,0 +1,122 @@
+DDS Example
+===========
+
+This example demonstrates usage of the Dynamic Deployment System ([DDS](http://dds.gsi.de/)) to dynamically deploy and configure a topology of devices. The topology is similar to the one in Example 1-n-1, but now it can be easily distributed on different computing nodes without the need for manual addresses reconfiguration of the devices.
+
+The description below outlines the minimal steps needed to run the example with DDS. For general DDS help please refer to DDS documentation on [DDS Website](http://dds.gsi.de/).
+
+##### 1. The device handles the channel addresses and ports configuration via DDS Plugin.
+
+It is sufficient to provide the `-S "<@FAIRMQ_INSTALL_DIR@/lib" -P dds` (`<` prepends the following path to the default plugin search paths; put in the path which points to the library dir of your FairRoot installation) command line arguments to let the devices be configured dynamically. No code changes in the device are necessary. See the XML topology file for example of using the command line arguments.
+
+##### 2a. Write DDS hosts file that contains a list of worker nodes to run the topology on (When deploying using the SSH plug-in).
+
+We run this example on the local machine for simplicity. The file below defines 3 workers - sampler, processor and sink - with a total of 12 DDS agents (thus able to accept 12 tasks). The parameters for each worker node are:
+ - user-chosen worker ID (must be unique)
+ - a host name with or without a login, in a form: login@host.fqdn (password-less SSH access to these hosts must be possible)
+ - additional SSH params (can be empty)
+ - a remote working directory (most exist on the worker nodes)
+ - number of DDS Agents for this worker
+
+```bash
+@bash_begin@
+#source setup.sh
+@bash_end@
+
+sampler, username@localhost, , /path/to/dds-work-dir/, 1
+processor, username@localhost, , /path/to/dds-work-dir/, 10
+sink, username@localhost, , /path/to/dds-work-dir/, 1
+```
+
+##### 2b. Skip (When deploying using the localhost plug-in).
+
+If you want to deploy on a single host DDS 1.6+ provides a localhost rms plug-in. You do not need a hosts file in that case.
+
+##### 3. Write DDS topology file that describes which tasks (processes) to run and their topology and configuration.
+
+Take a look at `ex-dds-topology.xml`. It consists of a definition part (properties, tasks, collections and more) and execution part (main). In our example Sampler, Processor and Sink tasks are defined, containing their executables and exchanged properties. The `<main>` of the topology uses the defined tasks. Besides one Sampler and one Sink task, a group containing Processor task is defined. The group has a multiplicity of 10, meaninig 10 Processors will be executed. Each of the Processors will receive the properties with Sampler and Sink addresses.
+
+The configuration of the channel connection addresses is done by the DDS plugin via the channel names. The task property names must correspond to the channel names (data1, data2), with binding channels writing the properties and connecting channel reading the properties.
+
+**If you chose step 2b earlier**, then modify the provided `ex-dds-topology.xml` in the top that the following lines read as following:
+```xml
+<declrequirement name="SamplerWorker" type="wnname" value=".*"/>
+<declrequirement name="ProcessorWorker" type="wnname" value=".*"/>
+<declrequirement name="SinkWorker" type="wnname" value=".*"/>
+```
+
+Note that the attributes `value` contain a different value.
+
+##### 4. Start DDS session.
+
+First you need to initialize DDS environment:
+
+```bash
+source DDS_env.sh  # this script is located in the DDS installation directory
+```
+
+The DDS session is started with:
+
+```bash
+dds-session start
+```
+
+##### 5. Submit DDS Agents (configured in the hosts file).
+
+Agents are submitted with:
+```bash
+dds-submit --rms ssh --config ex-dds-hosts.cfg
+```
+The `--rms` option defines a destination resource management system. The `--config` specifies an SSH plug-in resource definition file.
+
+**If you chose step 2b earlier**, run the following command instead:
+
+```bash
+dds-submit --rms localhost -n 12
+```
+
+##### 6. Activate the topology.
+
+```bash
+dds-topology --activate ex-dds-topology.xml
+```
+
+##### 7. Run
+
+After activation, agents will execute the defined tasks on the worker nodes. Output of the tasks will be stored in the directory that was specified in the hosts file (or in the system temporary directory when using the localhost plugin).
+
+##### 8. (optional) Use example command UI to check state of the devices
+
+A simple utility (fairmq-dds-command-ui) is included with FairMQ to send commands to devices and receive replies from them. The utility uses the DDS intercom library to query state/config of devices and allows changing their state. To let the device listen to the commands from the utility, start the device with `-S "<@FAIRMQ_INSTALL_DIR@/lib" -P dds` cmd option (see example XML topology).
+
+To see it in action, start the fairmq-dds-command-ui while the topology is running. Run the utility with `-h` to see everything that it can do.
+
+The utility requires a session parameter to connect to appropriate DDS session. The session value is given when starting dds-session.
+
+By default the command UI sends commands to all tasks. This can be further refined by giving a specific topology path via `-p` argument.
+Given our topology file, here are some examples of valid paths:
+```bash
+# get state of all devices
+./fairmq/plugins/DDS/fairmq-dds-command-ui -s 937ffbca-b524-44d8-9898-1d69aedc3751 -c c
+# get state of sampler
+./fairmq/plugins/DDS/fairmq-dds-command-ui -s 937ffbca-b524-44d8-9898-1d69aedc3751 -c c -p main/Sampler
+# get state of sink
+./fairmq/plugins/DDS/fairmq-dds-command-ui -s 937ffbca-b524-44d8-9898-1d69aedc3751 -c c -p main/Sink
+# get state all processors
+./fairmq/plugins/DDS/fairmq-dds-command-ui -s 937ffbca-b524-44d8-9898-1d69aedc3751 -c c -p main/ProcessorGroup/Processor
+# get state of a specific processor
+./fairmq/plugins/DDS/fairmq-dds-command-ui -s 937ffbca-b524-44d8-9898-1d69aedc3751 -c c -p main/ProcessorGroup/Processor_9
+```
+
+##### 9. Stop DDS session/topology.
+
+The execution of tasks can be stopped with:
+```bash
+dds-topology --stop
+```
+Or by stopping the DDS session:
+```bash
+dds-session stop
+```
+
+For general DDS documentation please refer to [DDS Website](http://dds.gsi.de/).

examples/dds/ex-dds-hosts.cfg

@@ -0,0 +1,3 @@
+sampler, 127.0.0.1, , /tmp/fairmq-ex-dds, 1
+processor, 127.0.0.1, , /tmp/fairmq-ex-dds, 10
+sink, 127.0.0.1, , /tmp/fairmq-ex-dds, 1

examples/dds/ex-dds-topology-infinite.xml

@@ -0,0 +1,52 @@
+<topology name="ExampleDDS">
+
+    <property name="fmqchan_data1" />
+    <property name="fmqchan_data2" />
+
+    <declrequirement name="SamplerWorker" type="wnname" value="sampler"/>
+    <declrequirement name="ProcessorWorker" type="wnname" value="processor"/>
+    <declrequirement name="SinkWorker" type="wnname" value="sink"/>
+
+    <decltask name="Sampler">
+        <exe>fairmq-ex-dds-sampler --color false --channel-config name=data1,type=push,method=bind --rate 100 --iterations 0 -P dds</exe>
+        <env reachable="false">fairmq-ex-dds-env.sh</env>
+        <requirements>
+            <name>SamplerWorker</name>
+        </requirements>
+        <properties>
+            <name access="write">fmqchan_data1</name>
+        </properties>
+    </decltask>
+
+    <decltask name="Processor">
+        <exe>fairmq-ex-dds-processor --color false --channel-config name=data1,type=pull,method=connect name=data2,type=push,method=connect -P dds</exe>
+        <env reachable="false">fairmq-ex-dds-env.sh</env>
+        <requirements>
+            <name>ProcessorWorker</name>
+        </requirements>
+        <properties>
+            <name access="read">fmqchan_data1</name>
+            <name access="read">fmqchan_data2</name>
+        </properties>
+    </decltask>
+
+    <decltask name="Sink">
+        <exe>fairmq-ex-dds-sink --color false --channel-config name=data2,type=pull,method=bind -P dds</exe>
+        <env reachable="false">fairmq-ex-dds-env.sh</env>
+        <requirements>
+            <name>SinkWorker</name>
+        </requirements>
+        <properties>
+            <name access="write">fmqchan_data2</name>
+        </properties>
+    </decltask>
+
+    <main name="main">
+        <task>Sampler</task>
+        <task>Sink</task>
+        <group name="ProcessorGroup" n="10">
+            <task>Processor</task>
+        </group>
+    </main>
+
+</topology>

examples/dds/ex-dds-topology.xml

@@ -0,0 +1,52 @@
+<topology name="ExampleDDS">
+
+    <property name="fmqchan_data1" />
+    <property name="fmqchan_data2" />
+
+    <declrequirement name="SamplerWorker" type="wnname" value="sampler"/>
+    <declrequirement name="ProcessorWorker" type="wnname" value="processor"/>
+    <declrequirement name="SinkWorker" type="wnname" value="sink"/>
+
+    <decltask name="Sampler">
+        <exe>fairmq-ex-dds-sampler --color false --channel-config name=data1,type=push,method=bind -P dds --iterations 10 --severity trace --verbosity veryhigh</exe>
+        <env reachable="false">fairmq-ex-dds-env.sh</env>
+        <requirements>
+            <name>SamplerWorker</name>
+        </requirements>
+        <properties>
+            <name access="write">fmqchan_data1</name>
+        </properties>
+    </decltask>
+
+    <decltask name="Processor">
+        <exe>fairmq-ex-dds-processor --color false --channel-config name=data1,type=pull,method=connect name=data2,type=push,method=connect -P dds --severity trace --verbosity veryhigh</exe>
+        <env reachable="false">fairmq-ex-dds-env.sh</env>
+        <requirements>
+            <name>ProcessorWorker</name>
+        </requirements>
+        <properties>
+            <name access="read">fmqchan_data1</name>
+            <name access="read">fmqchan_data2</name>
+        </properties>
+    </decltask>
+
+    <decltask name="Sink">
+        <exe>fairmq-ex-dds-sink --color false --channel-config name=data2,type=pull,method=bind -P dds --iterations 10 --severity trace --verbosity veryhigh</exe>
+        <env reachable="false">fairmq-ex-dds-env.sh</env>
+        <requirements>
+            <name>SinkWorker</name>
+        </requirements>
+        <properties>
+            <name access="write">fmqchan_data2</name>
+        </properties>
+    </decltask>
+
+    <main name="main">
+        <task>Sampler</task>
+        <task>Sink</task>
+        <group name="ProcessorGroup" n="10">
+            <task>Processor</task>
+        </group>
+    </main>
+
+</topology>

examples/dds/fairmq-ex-dds-env.sh

@@ -1,12 +1,16 @@
+#!/bin/bash
+
 ################################################################################
-#    Copyright (C) 2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    #
+#    Copyright (C) 2019 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    #
 #                                                                              #
 #              This software is distributed under the terms of the             #
 #              GNU Lesser General Public Licence (LGPL) version 3,             #
 #                  copied verbatim in the file "LICENSE"                       #
 ################################################################################
 
-protobuf_generate_cpp(PROTO_SRCS PROTO_HDRS Control.proto)
+export PATH=@BIN_DIR@:$PATH
 
-add_library(OfiTransport OBJECT ${PROTO_SRCS} ${PROTO_HDRS})
-target_include_directories(OfiTransport PRIVATE $<TARGET_PROPERTY:protobuf::libprotobuf,INTERFACE_INCLUDE_DIRECTORIES>)
+OS=$(uname -s 2>&1)
+if [ "$OS" == "Darwin" ]; then
+   export DYLD_LIBRARY_PATH=@LIB_DIR@:$DYLD_LIBRARY_PATH
+fi

examples/dds/fairmq-start-ex-dds.sh.in

@@ -0,0 +1,84 @@
+#!/bin/bash
+
+################################################################################
+# Copyright (C) 2019-2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+# fairmq-start-ex-dds.sh [localhost]   -> submit agents with localhost plugin
+# fairmq-start-ex-dds.sh ssh           -> submit agents with ssh plugin
+
+set -e
+
+cleanup() {
+  dds-session stop $1
+  echo "CLEANUP PERFORMED"
+}
+
+export PATH=@BIN_DIR@:$PATH
+
+plugin=${1:-localhost}
+
+exec 5>&1
+output=$(dds-session start | tee >(cat - >&5))
+export DDS_SESSION_ID=$(echo ${output} | grep "DDS session ID: " | cut -d' ' -f4)
+echo "SESSION ID: ${DDS_SESSION_ID}"
+
+trap "cleanup ${DDS_SESSION_ID}" EXIT
+
+requiredNofSlots=12
+if [[ "$plugin" == "ssh" ]]; then
+  dds-submit -r ${plugin} -c @DATA_DIR@/ex-dds-hosts.cfg
+else
+  dds-submit -r ${plugin} --slots ${requiredNofSlots}
+fi
+echo "...waiting for ${requiredNofSlots} idle slots..."
+dds-info --idle-count --wait ${requiredNofSlots}
+
+export FAIRMQ_DDS_TOPO_FILE=@DATA_DIR@/ex-dds-topology.xml
+echo "TOPOLOGY FILE: ${FAIRMQ_DDS_TOPO_FILE}"
+echo "TOPOLOGY NAME: $(dds-topology --disable-validation --topology-name ${FAIRMQ_DDS_TOPO_FILE})"
+
+dds-info --active-topology
+dds-topology --activate ${FAIRMQ_DDS_TOPO_FILE}
+dds-info --active-topology
+echo "...waiting for ${requiredNofSlots} executing slots..."
+dds-info --executing-count --wait ${requiredNofSlots}
+
+echo "------------------------"
+echo "...waiting for Topology to finish..."
+fairmq-dds-command-ui -w "IDLE"
+fairmq-dds-command-ui -c i
+fairmq-dds-command-ui -c k
+fairmq-dds-command-ui -c b
+fairmq-dds-command-ui -c x
+fairmq-dds-command-ui -c j
+fairmq-dds-command-ui -c r
+sampler_and_sink="main/(Sampler|Sink).*"
+fairmq-dds-command-ui -w "RUNNING->READY" -p $sampler_and_sink
+echo "...$sampler_and_sink are READY, sending shutdown..."
+fairmq-dds-command-ui -c s
+fairmq-dds-command-ui -c t
+fairmq-dds-command-ui -c d
+fairmq-dds-command-ui -c q
+echo "...waiting for ${requiredNofSlots} idle slots..."
+dds-info --idle-count --wait ${requiredNofSlots}
+echo "------------------------"
+
+dds-info --active-topology
+dds-topology --stop
+dds-info --active-topology
+
+# TODO Simplify, see https://github.com/FairRootGroup/DDS/issues/369
+if dds-agent-cmd getlog -a; then
+  logDir=$(eval "echo $(dds-user-defaults --key server.sandbox_dir)/log/agents")
+  echo "AGENT LOG FILES IN: ${logDir}"
+fi
+
+# This string is used by ctest to detect success
+echo "Example successful"
+
+# Cleanup function is called by EXIT trap

examples/dds/processor.cxx

@@ -0,0 +1,56 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include <fairmq/Device.h>
+#include <fairmq/runDevice.h>
+
+#include <string>
+
+namespace bpo = boost::program_options;
+
+struct Processor : fair::mq::Device
+{
+    Processor()
+    {
+        OnData("data1", &Processor::HandleData);
+    }
+
+    bool HandleData(fair::mq::MessagePtr& msg, int)
+    {
+        LOG(info) << "Received data, processing...";
+
+        // Modify the received string
+        std::string* text = new std::string(static_cast<char*>(msg->GetData()), msg->GetSize());
+        *text += " (modified by " + fId + ")";
+
+        // create message object with a pointer to the data buffer,
+        // its size,
+        // custom deletion function (called when transfer is done),
+        // and pointer to the object managing the data buffer
+        fair::mq::MessagePtr msg2(NewMessage(const_cast<char*>(text->c_str()),
+                                        text->length(),
+                                        [](void* /*data*/, void* object) { delete static_cast<std::string*>(object); },
+                                        text));
+
+        // Send out the output message
+        if (Send(msg2, "data2") < 0) {
+            return false;
+        }
+
+        return true;
+    }
+};
+
+void addCustomOptions(bpo::options_description& /*options*/)
+{
+}
+
+std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& /*config*/)
+{
+    return std::make_unique<Processor>();
+}

examples/dds/sampler.cxx

@@ -0,0 +1,64 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include <fairmq/Device.h>
+#include <fairmq/runDevice.h>
+
+#include <cstdint> // uint64_t
+
+namespace bpo = boost::program_options;
+
+struct Sampler : fair::mq::Device
+{
+    void InitTask() override
+    {
+        fIterations = fConfig->GetValue<uint64_t>("iterations");
+    }
+
+    bool ConditionalRun() override
+    {
+        // NewSimpleMessage creates a copy of the data and takes care of its destruction (after the transfer takes place).
+        // Should only be used for small data because of the cost of an additional copy
+        fair::mq::MessagePtr msg(NewSimpleMessage("Data"));
+
+        LOG(info) << "Sending \"Data\"";
+
+        // in case of error or transfer interruption, return false to go to IDLE state
+        // successfull transfer will return number of bytes transfered (can be 0 if sending an empty message).
+        if (Send(msg, "data1") < 0) {
+            return false;
+        }
+
+        if (fIterations > 0) {
+            ++fCounter;
+            if (fCounter >= fIterations) {
+                LOG(info) << "Sent " << fCounter << " messages. Finished.";
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+  private:
+    uint64_t fIterations = 0;
+    uint64_t fCounter = 0;
+};
+
+void addCustomOptions(bpo::options_description& options)
+{
+    options.add_options()(
+        "iterations,i",
+        bpo::value<uint64_t>()->default_value(1000),
+        "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)");
+}
+
+std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& /*config*/)
+{
+    return std::make_unique<Sampler>();
+}

examples/dds/sink.cxx

@@ -0,0 +1,58 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include <fairmq/Device.h>
+#include <fairmq/runDevice.h>
+
+#include <string>
+
+namespace bpo = boost::program_options;
+
+struct Sink : fair::mq::Device
+{
+    Sink()
+    {
+        OnData("data2", &Sink::HandleData);
+    }
+
+    void InitTask() override
+    {
+        fIterations = fConfig->GetValue<uint64_t>("iterations");
+    }
+
+    bool HandleData(fair::mq::MessagePtr& msg, int)
+    {
+        LOG(info) << "Received: \"" << std::string(static_cast<char*>(msg->GetData()), msg->GetSize()) << "\"";
+
+        if (fIterations > 0) {
+            ++fCounter;
+            if (fCounter >= fIterations) {
+                LOG(info) << "Received " << fCounter << " messages. Finished.";
+                return false;
+            }
+        }
+        // return true if want to be called again (otherwise go to IDLE state)
+        return true;
+    }
+
+  private:
+    uint64_t fIterations = 0;
+    uint64_t fCounter = 0;
+};
+void addCustomOptions(bpo::options_description& options)
+{
+    options.add_options()(
+        "iterations,i",
+        bpo::value<uint64_t>()->default_value(1000),
+        "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)");
+}
+
+std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& /*config*/)
+{
+    return std::make_unique<Sink>();
+}

examples/multipart/CMakeLists.txt

@@ -0,0 +1,11 @@
+################################################################################
+# Copyright (C) 2014-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+add_example(NAME multipart
+  DEVICE sampler sink
+)

examples/multipart/Header.h

@@ -5,11 +5,20 @@
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
  *                  copied verbatim in the file "LICENSE"                       *
  ********************************************************************************/
-/**
- * FairMQLogger.cxx
- *
- * @since 2012-12-04
- * @author D. Klein, A. Rybalchenko
- */
 
-#include "FairMQLogger.h"
+#ifndef FAIRMQEXAMPLEMULTIPARTHEADER_H
+#define FAIRMQEXAMPLEMULTIPARTHEADER_H
+
+#include <cstdint>
+
+namespace example_multipart
+{
+
+struct Header
+{
+    int32_t stopFlag;
+};
+
+}
+
+#endif /* FAIRMQEXAMPLEMULTIPARTHEADER_H */

examples/multipart/README.md

@@ -0,0 +1,12 @@
+Sending Multipart messages
+==========================
+
+A topology of two devices - Sampler and Sink, communicating with PUSH-PULL pattern.
+
+The Sampler sends a multipart message to the Sink, consisting of two message parts - header and body.
+
+Each message part is a regular fair::mq::Message. To combine them into a multi-part message use `fair::mq::Parts`. Add messages to `fair::mq::Parts` with `AddPart` method.
+
+All parts are guaranteed to be delivered together. The Receive call in the sink will recive the entire parts structure.
+
+The header contains a simple data structure with one integer. The integer in this structure is used as a stop flag for the sink. As long as its value is 0, the Sink will keep processing the data. Once its value is 1, the data handler method of the Sink will return false, which will exit the RUNNING state of the device.

examples/multipart/ex-multipart-multiple-endpoints.json

@@ -2,18 +2,18 @@
     "fairMQOptions": {
         "devices": [
             {
-                "id": "bsampler1",
+                "id": "sampler1",
                 "channels": [
                     {
                         "name": "data",
                         "sockets": [
                             {
                                 "type": "push",
-                                "method": "bind",
-                                "address": "tcp://127.0.0.1:5555",
+                                "method": "connect",
+                                "address": "tcp://localhost:5555,tcp://localhost:5556",
                                 "sndBufSize": 1000,
                                 "rcvBufSize": 1000,
-                                "rateLogging": 1
+                                "rateLogging": 0
                             }
                         ]
                     }
@@ -27,11 +27,29 @@
                         "sockets": [
                             {
                                 "type": "pull",
-                                "method": "connect",
-                                "address": "tcp://127.0.0.1:5555",
+                                "method": "bind",
+                                "address": "tcp://*:5555",
                                 "sndBufSize": 1000,
                                 "rcvBufSize": 1000,
-                                "rateLogging": 1
+                                "rateLogging": 0
+                            }
+                        ]
+                    }
+                ]
+            },
+            {
+                "id": "sink2",
+                "channels": [
+                    {
+                        "name": "data",
+                        "sockets": [
+                            {
+                                "type": "pull",
+                                "method": "connect",
+                                "address": "@tcp://*:5556",
+                                "sndBufSize": 1000,
+                                "rcvBufSize": 1000,
+                                "rateLogging": 0
                             }
                         ]
                     }

examples/multipart/fairmq-start-ex-multipart.sh.in

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+transport="zeromq"
+
+if [[ $1 =~ ^[a-z]+$ ]]; then
+    transport=$1
+fi
+
+SESSION="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
+
+SAMPLER="fairmq-ex-multipart-sampler"
+SAMPLER+=" --id sampler1"
+SAMPLER+=" --transport $transport"
+SAMPLER+=" --session $SESSION"
+SAMPLER+=" --channel-config name=data,type=push,method=connect,rateLogging=0,address=tcp://127.0.0.1:5555"
+xterm -geometry 80x23+0+0 -hold -e @EX_BIN_DIR@/$SAMPLER &
+
+SINK="fairmq-ex-multipart-sink"
+SINK+=" --id sink1"
+SINK+=" --transport $transport"
+SINK+=" --session $SESSION"
+SINK+=" --channel-config name=data,type=pull,method=bind,rateLogging=0,address=tcp://127.0.0.1:5555"
+xterm -geometry 80x23+500+0 -hold -e @EX_BIN_DIR@/$SINK &

examples/multipart/sampler.cxx

@@ -0,0 +1,90 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "Header.h"
+
+#include <fairmq/Device.h>
+#include <fairmq/runDevice.h>
+
+#include <chrono>
+#include <cstdint>
+#include <thread> // this_thread::sleep_for
+
+namespace bpo = boost::program_options;
+
+struct Sampler : fair::mq::Device
+{
+    void InitTask() override
+    {
+        fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
+    }
+
+    bool ConditionalRun() override
+    {
+        example_multipart::Header header;
+        header.stopFlag = 0;
+
+        // Set stopFlag to 1 for last message.
+        if (fMaxIterations > 0 && fNumIterations == fMaxIterations - 1) {
+            header.stopFlag = 1;
+        }
+        LOG(info) << "Sending header with stopFlag: " << header.stopFlag;
+
+        fair::mq::Parts parts;
+
+        // NewSimpleMessage creates a copy of the data and takes care of its destruction (after the transfer takes place).
+        // Should only be used for small data because of the cost of an additional copy
+        parts.AddPart(NewSimpleMessage(header));
+        parts.AddPart(NewMessage(1000));
+
+        // create more data parts, testing the fair::mq::Parts in-place constructor
+        fair::mq::Parts auxData{ NewMessage(500), NewMessage(600), NewMessage(700) };
+        assert(auxData.Size() == 3);
+        parts.AddPart(std::move(auxData));
+        assert(auxData.Size() == 0);
+        assert(parts.Size() == 5);
+
+        parts.AddPart(NewMessage());
+
+        assert(parts.Size() == 6);
+
+        parts.AddPart(NewMessage(100));
+
+        assert(parts.Size() == 7);
+
+        LOG(info) << "Sending body of size: " << parts.At(1)->GetSize();
+
+        Send(parts, "data");
+
+        // Go out of the sending loop if the stopFlag was sent.
+        if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations) {
+            LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+            return false;
+        }
+
+        // Wait a second to keep the output readable.
+        std::this_thread::sleep_for(std::chrono::seconds(1));
+
+        return true;
+    }
+
+  private:
+    uint64_t fMaxIterations = 5;
+    uint64_t fNumIterations = 0;
+};
+
+void addCustomOptions(bpo::options_description& options)
+{
+    options.add_options()
+        ("max-iterations", bpo::value<uint64_t>()->default_value(5), "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)");
+}
+
+std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& /*config*/)
+{
+    return std::make_unique<Sampler>();
+}

examples/multipart/sink.cxx

@@ -0,0 +1,65 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "Header.h"
+
+#include <fairmq/Device.h>
+#include <fairmq/runDevice.h>
+
+namespace bpo = boost::program_options;
+
+struct Sink : fair::mq::Device
+{
+    Sink()
+    {
+        OnData("data", &Sink::HandleData);
+    }
+
+    bool HandleData(fair::mq::Parts& parts, int)
+    {
+        LOG(info) << "Received message with " << parts.Size() << " parts";
+
+        if (parts.Size() != 7) {
+            throw std::runtime_error("Number of received parts != 7");
+        }
+
+        example_multipart::Header header;
+        header.stopFlag = (static_cast<example_multipart::Header*>(parts.At(0)->GetData()))->stopFlag;
+
+        LOG(info) << "Received part 1 (header) with stopFlag: " << header.stopFlag;
+        LOG(info) << "Received part 2 of size: " << parts.At(1)->GetSize();
+        assert(parts.At(1)->GetSize() == 1000);
+        LOG(info) << "Received part 3 of size: " << parts.At(2)->GetSize();
+        assert(parts.At(2)->GetSize() == 500);
+        LOG(info) << "Received part 4 of size: " << parts.At(3)->GetSize();
+        assert(parts.At(3)->GetSize() == 600);
+        LOG(info) << "Received part 5 of size: " << parts.At(4)->GetSize();
+        assert(parts.At(4)->GetSize() == 700);
+        LOG(info) << "Received part 6 of size: " << parts.At(5)->GetSize();
+        assert(parts.At(5)->GetSize() == 0);
+        LOG(info) << "Received part 7 of size: " << parts.At(6)->GetSize();
+        assert(parts.At(6)->GetSize() == 100);
+
+        if (header.stopFlag == 1) {
+            LOG(info) << "stopFlag is 1, going IDLE";
+            return false;
+        }
+
+        return true;
+    }
+
+};
+
+void addCustomOptions(bpo::options_description& /*options*/)
+{
+}
+
+std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& /*config*/)
+{
+    return std::make_unique<Sink>();
+}