.devcontainer/devcontainer.json

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

.github/dependabot.yml

@@ -1,12 +0,0 @@
-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

@@ -1,29 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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

@@ -4,5 +4,3 @@ install
 .vscode
 /compile_commands.json
 .cache
-.spack-env
-spack.lock

.zenodo.json

@@ -1,88 +0,0 @@
-{
-    "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 [https://orcid.org/0000-0002-8071-4497]
-Klein, Dennis [https://orcid.org/0000-0003-3787-1910]
+Al-Turany, Mohammad
+Klein, Dennis
 Kollegger, Thorsten
-Rybalchenko, Alexey [https://orcid.org/0000-0002-6249-155X]
+Rybalchenko, Alexey
 Winckler, Nicolas

CMakeLists.txt

@@ -1,5 +1,5 @@
 ################################################################################
-# Copyright (C) 2018-2024 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,             #
@@ -8,7 +8,8 @@
 
 
 # Project ######################################################################
-cmake_minimum_required(VERSION 3.15...3.30 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.15 FATAL_ERROR)
+cmake_policy(VERSION 3.15...3.20)
 
 list(PREPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake)
 include(GitHelper)
@@ -26,8 +27,18 @@ 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_OFI_TRANSPORT "Build experimental OFI transport."
+                                         DEFAULT OFF REQUIRES "BUILD_FAIRMQ")
+fairmq_build_option(BUILD_SDK_COMMANDS  "Build the FairMQ SDK commands."
+                                         DEFAULT OFF)
+fairmq_build_option(BUILD_DDS_PLUGIN    "Build DDS plugin."
+                                         DEFAULT OFF REQUIRES "BUILD_FAIRMQ;BUILD_SDK_COMMANDS")
+fairmq_build_option(BUILD_PMIX_PLUGIN   "Build PMIx plugin."
+                                         DEFAULT OFF REQUIRES "BUILD_FAIRMQ;BUILD_SDK_COMMANDS")
 fairmq_build_option(BUILD_EXAMPLES      "Build FairMQ examples."
                                          DEFAULT ON  REQUIRES "BUILD_FAIRMQ")
+fairmq_build_option(BUILD_SDK           "Build the FairMQ controller SDK."
+                                         DEFAULT OFF REQUIRES "BUILD_DDS_PLUGIN;BUILD_SDK_COMMANDS")
 fairmq_build_option(BUILD_TIDY_TOOL     "Build the fairmq-tidy tool."
                                          DEFAULT OFF)
 fairmq_build_option(BUILD_DOCS          "Build FairMQ documentation."
@@ -46,7 +57,7 @@ include(FairMQDependencies)
 
 
 # Targets ######################################################################
-if(BUILD_FAIRMQ)
+if(BUILD_FAIRMQ OR BUILD_SDK)
   add_subdirectory(fairmq)
 endif()
 
@@ -81,12 +92,27 @@ endif()
 if(BUILD_TESTING)
   list(APPEND PROJECT_PACKAGE_COMPONENTS tests)
 endif()
+if(BUILD_DDS_PLUGIN)
+  list(APPEND PROJECT_PACKAGE_COMPONENTS dds_plugin)
+endif()
+if(BUILD_PMIX_PLUGIN)
+  list(APPEND PROJECT_PACKAGE_COMPONENTS pmix_plugin)
+endif()
+if(BUILD_OFI_TRANSPORT)
+  list(APPEND PROJECT_PACKAGE_COMPONENTS ofi_transport)
+endif()
 if(BUILD_EXAMPLES)
   list(APPEND PROJECT_PACKAGE_COMPONENTS examples)
 endif()
 if(BUILD_DOCS)
   list(APPEND PROJECT_PACKAGE_COMPONENTS docs)
 endif()
+if(BUILD_SDK)
+  list(APPEND PROJECT_PACKAGE_COMPONENTS sdk)
+endif()
+if(BUILD_SDK_COMMANDS)
+  list(APPEND PROJECT_PACKAGE_COMPONENTS sdk_commands)
+endif()
 if(BUILD_TIDY_TOOL)
   list(APPEND PROJECT_PACKAGE_COMPONENTS tidy_tool)
 endif()
@@ -99,6 +125,11 @@ if(BUILD_FAIRMQ)
     DESTINATION ${PROJECT_INSTALL_CMAKEMODDIR}
   )
 endif()
+if(BUILD_SDK OR BUILD_DDS_PLUGIN)
+  install(FILES cmake/Findasio.cmake
+    DESTINATION ${PROJECT_INSTALL_CMAKEMODDIR}
+  )
+endif()
 if(BUILD_DOCS)
   install(DIRECTORY ${CMAKE_BINARY_DIR}/doxygen/html
     DESTINATION ${PROJECT_INSTALL_DATADIR}/docs
@@ -126,6 +157,5 @@ fairmq_summary_components()
 fairmq_summary_static_analysis()
 fairmq_summary_install_prefix()
 fairmq_summary_debug_mode()
-fairmq_summary_compile_definitions()
 message(STATUS "  ")
 ################################################################################

CONTRIBUTORS

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

COPYRIGHT

@@ -4,19 +4,19 @@ 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]
+Copyright: 2012-2021, GSI Helmholtzzentrum fuer Schwerionenforschung GmbH
+Copyright: 2012-2021, [see AUTHORS file]
+Copyright: 2012-2021, [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.
+Copyright: 2008-2021, Google Inc.
 License: GOOGLE
 
 Files: extern/asio
-Copyright: 2003-2022, Christopher M. Kohlhoff (chris at kohlhoff dot com)
+Copyright: 2003-2021, Christopher M. Kohlhoff (chris at kohlhoff dot com)
 License: BSL-1.0
 
 Files: extern/PicoSHA2

FairMQTest.cmake

@@ -1,5 +1,5 @@
 ################################################################################
-# Copyright (C) 2021-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#    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,             #
@@ -42,6 +42,15 @@ endif()
 ctest_start(Continuous)
 
 list(APPEND options "-DDISABLE_COLOR=ON" "-DBUILD_EXAMPLES=ON" "-DBUILD_TESTING=ON")
+if(HAS_ASIO AND HAS_DDS)
+  list(APPEND options "-DBUILD_SDK_COMMANDS=ON" "-DBUILD_SDK=ON" "-DBUILD_DDS_PLUGIN=ON")
+endif()
+if(HAS_PMIX)
+  list(APPEND options "-DBUILD_SDK_COMMANDS=ON" "-DBUILD_PMIX_PLUGIN=ON")
+endif()
+if(HAS_ASIO AND HAS_ASIOFI)
+  list(APPEND options "-DBUILD_OFI_TRANSPORT=ON")
+endif()
 if(RUN_STATIC_ANALYSIS)
   list(APPEND options "-DRUN_STATIC_ANALYSIS=ON")
 endif()
@@ -63,9 +72,6 @@ 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()
@@ -81,7 +87,7 @@ ctest_submit()
 
 if(NOT RUN_STATIC_ANALYSIS)
   ctest_test(BUILD "${CTEST_BINARY_DIRECTORY}"
-             PARALLEL_LEVEL ${NCPUS}
+             PARALLEL_LEVEL 1
              SCHEDULE_RANDOM ON
              RETURN_VALUE _ctest_test_ret_val)
 

Jenkinsfile

@@ -4,21 +4,20 @@ def jobMatrix(String type, List specs) {
   def nodes = [:]
   for (spec in specs) {
     def job = ""
-    def selector = "slurm"
+    def selector = ""
     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}"
-      }
+      selector = "${spec.os}-${spec.ver}-${spec.arch}"
       os = spec.os
       ver = spec.ver
     } else { // == 'check'
       job = "${spec.name}"
+      selector = 'fedora-34-x86_64'
       os = 'fedora'
-      ver = '36'
+      ver = '34'
     }
 
     def label = "${job}"
@@ -37,14 +36,14 @@ def jobMatrix(String type, List specs) {
           sh "echo \"export LABEL=\\\"\${JOB_BASE_NAME} ${label}\\\"\" >> ${jobscript}"
           if (selector =~ /^macos/) {
             sh """\
+              echo \"export DDS_ROOT=\\\"\\\$(brew --prefix dds)\\\"\" >> ${jobscript}
+              echo \"export PATH=\\\"\\\$(brew --prefix dds)/bin:\\\$PATH\\\"\" >> ${jobscript}
               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}\\\""
+          } else {
+            def containercmd = "singularity exec --net --ipc --uts --pid -B/shared ${env.SINGULARITY_CONTAINER_ROOT}/fairmq/${os}.${ver}.sif bash -l -c \\\"${ctestcmd} ${extra}\\\""
             sh """\
               echo \"echo \\\"*** Job started at .......: \\\$(date -R)\\\"\" >> ${jobscript}
               echo \"echo \\\"*** Job ID ...............: \\\${SLURM_JOB_ID}\\\"\" >> ${jobscript}
@@ -68,6 +67,12 @@ def jobMatrix(String type, List specs) {
           deleteDir()
           githubNotify(context: "${label}", description: 'Success', status: 'SUCCESS')
         } catch (e) {
+          def tarball = "${type}_${job}_dds_logs.tar.gz"
+          if (fileExists("build/test/.DDS")) {
+            sh "tar czvf ${tarball} -C \${WORKSPACE}/build/test .DDS/"
+            archiveArtifacts tarball
+          }
+
           deleteDir()
           githubNotify(context: "${label}", description: 'Error', status: 'ERROR')
           throw e
@@ -84,30 +89,23 @@ pipeline{
     stage("CI") {
       steps{
         script {
+          def all = '-DHAS_ASIO=ON -DHAS_DDS=ON -DHAS_PMIX=ON'
+
           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'],
+            [os: 'ubuntu', ver: '20.04', arch: 'x86_64', compiler: 'gcc-9',  extra: all],
+            [os: 'fedora', ver: '32',    arch: 'x86_64', compiler: 'gcc-10', extra: all],
+            [os: 'fedora', ver: '33',    arch: 'x86_64', compiler: 'gcc-10', extra: all],
+            [os: 'fedora', ver: '34',    arch: 'x86_64', compiler: 'gcc-11', extra: all],
+            [os: 'macos',  ver: '11',    arch: 'x86_64', compiler: 'apple-clang-12',
+             extra: '-DHAS_ASIO=ON -DHAS_DDS=ON'],
           ])
 
-          def all_debug = "-DCMAKE_BUILD_TYPE=Debug"
+          def all_debug = "${all} -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)

README.md

@@ -1,15 +1,12 @@
 <!-- {#mainpage} -->
-# FairMQ
-
-[![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)
+# FairMQ [![license](https://alfa-ci.gsi.de/shields/badge/license-LGPL--3.0-orange.svg)](COPYRIGHT) [![build status](https://alfa-ci.gsi.de/buildStatus/icon?job=FairRootGroup/FairMQ/dev)](https://alfa-ci.gsi.de/blue/organizations/jenkins/FairRootGroup%2FFairMQ/branches) [![Coverity Badge](https://alfa-ci.gsi.de/shields/coverity/scan/fairrootgroup-fairmq.svg)](https://scan.coverity.com/projects/fairrootgroup-fairmq)
 
 C++ Message Queuing Library and Framework
 
-Docs: [Book](https://github.com/FairRootGroup/FairMQ/blob/dev/README.md#documentation)
+| Release | Version | Docs |
+| :---: | :--- | :--- |
+| `stable` | [![release](https://alfa-ci.gsi.de/shields/github/release/FairRootGroup/FairMQ.svg)](https://github.com/FairRootGroup/FairMQ/releases/latest) | [API](https://fairrootgroup.github.io/FairMQ/latest), [Book](https://github.com/FairRootGroup/FairMQ/blob/master/README.md#documentation) |
+| `testing` | [![dev tag](https://alfa-ci.gsi.de/shields/github/tag/FairRootGroup/FairMQ.svg)](https://github.com/FairRootGroup/FairMQ/tags) | [Book](https://github.com/FairRootGroup/FairMQ/blob/dev/README.md#documentation) |
 
 Find all FairMQ releases [here](https://github.com/FairRootGroup/FairMQ/releases).
 
@@ -24,17 +21,14 @@ FairMQ is designed to help implementing large-scale data processing workflows ne
 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. `zeromq`, `shmem` and `ofi` (in development)) 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.
+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 and plugins (e.g. [DDS](https://github.com/FairRootGroup/DDS))
+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.
@@ -45,42 +39,22 @@ Recommended:
 
 ```bash
 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 -S fairmq_source -B fairmq_build -GNinja -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=fairmq_install
 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
+cmake --build fairmq_build --target test
+cmake --build fairmq_build --target install
 ```
 
 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
-```
+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`, `OFI`, `PMIX`, `ASIO`, `ASIOFI` or `DDS` (`*_ROOT` variables can also be environment variables).
 
 ## Usage
 
 FairMQ ships as a CMake package, so in your `CMakeLists.txt` you can discover it like this:
 
 ```cmake
-find_package(FairCMakeModules 1.0 REQUIRED)
+find_package(FairCMakeModules 0.2 REQUIRED)
 include(FairFindPackage2)
 find_package2(FairMQ)
 find_package2_implicit_dependencies()
@@ -94,19 +68,31 @@ If FairMQ is not installed in system directories, you can hint the installation:
 list(PREPEND CMAKE_PREFIX_PATH /path/to/fairmq_install)
 ```
 
+Optionally, you can require certain FairMQ package components and a minimum version:
+
+```cmake
+find_package(FairMQ 1.4.0 COMPONENTS dds_plugin)
+```
+
+When building FairMQ, CMake will print a summary table of all available package components.
+
 ## Dependencies
 
+  * [asio](https://github.com/chriskohlhoff/asio) (optionally bundled)
+  * [asiofi](https://github.com/FairRootGroup/asiofi)
   * [Boost](https://www.boost.org/)
   * [CMake](https://cmake.org/)
+  * [DDS](http://dds.gsi.de)
   * [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)
+  * [PMIx](https://pmix.org/)
   * [ZeroMQ](http://zeromq.org/)
 
   Which dependencies are required depends on which components are built.
 
-  Supported platform is Linux. macOS is supported on a best-effort basis.
+  Supported platforms: Linux and MacOS.
 
 ## CMake options
 
@@ -115,8 +101,10 @@ On command line:
   * `-DDISABLE_COLOR=ON` disables coloured console output.
   * `-DBUILD_TESTING=OFF` disables building of tests.
   * `-DBUILD_EXAMPLES=OFF` disables building of examples.
+  * `-DBUILD_OFI_TRANSPORT=ON` enables building of the experimental OFI transport.
+  * `-DBUILD_DDS_PLUGIN=ON` enables building of the DDS plugin.
+  * `-DBUILD_PMIX_PLUGIN=ON` enables building of the PMIx plugin.
   * `-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:
@@ -173,4 +161,6 @@ After the `find_package(FairMQ)` call the following CMake variables are defined:
    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)
+       1. [DDS](docs/Plugins.md#731-dds)
+       2. [PMIx](docs/Plugins.md#732-pmix)
+8. [Controller SDK](docs/SDK.md)

cmake/FairMQDependencies.cmake

@@ -1,5 +1,5 @@
 ################################################################################
-# Copyright (C) 2018-2025 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,             #
@@ -12,19 +12,46 @@ include(FairCMakeModules)
 include(FairFindPackage2)
 include(FairMQBundlePackageHelper)
 
-if(BUILD_FAIRMQ)
+if(BUILD_FAIRMQ OR BUILD_SDK)
   set(THREADS_PREFER_PTHREAD_FLAG TRUE)
   find_package2(PUBLIC Threads REQUIRED)
   set(Threads_PREFIX "<system>")
 endif()
 
-if(BUILD_FAIRMQ OR BUILD_TIDY_TOOL)
+if(BUILD_OFI_TRANSPORT)
+  find_package2(PRIVATE asiofi REQUIRED VERSION 0.5)
+  find_package2(PRIVATE OFI REQUIRED)
+endif()
+
+if(BUILD_SDK_COMMANDS)
+  find_package2(PRIVATE Flatbuffers REQUIRED)
+endif()
+
+if(BUILD_DDS_PLUGIN OR BUILD_SDK)
+  find_package2(PRIVATE DDS REQUIRED VERSION 3.5.13.7)
+  set(DDS_Boost_COMPONENTS system log log_setup regex filesystem thread)
+  set(DDS_Boost_VERSION 1.67)
+endif()
+
+if(BUILD_PMIX_PLUGIN)
+  find_package2(PRIVATE PMIx REQUIRED VERSION 2.1.4)
+endif()
+
+if(BUILD_FAIRMQ OR BUILD_SDK 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_OFI_TRANSPORT OR BUILD_SDK OR BUILD_DDS_PLUGIN)
+  set(__old ${CMAKE_FIND_PACKAGE_PREFER_CONFIG})
+  set(CMAKE_FIND_PACKAGE_PREFER_CONFIG ON)
+  find_package2(PUBLIC asio REQUIRED VERSION 1.18)
+  set(CMAKE_FIND_PACKAGE_PREFER_CONFIG ${__old})
+  unset(__old)
+endif()
+
 if(BUILD_FAIRMQ)
   find_package2(PRIVATE ZeroMQ REQUIRED VERSION 4.1.4)
   if(NOT PicoSHA2_BUNDLED)
@@ -41,7 +68,7 @@ if(BUILD_TESTING)
   endif()
   find_package2(BUNDLED GTest REQUIRED)
   if(GTest_BUNDLED)
-    set(GTest_VERSION "Dec 26 2024 @7d76a23")
+    set(GTest_VERSION "Apr 28 2021 @f5e592d8")
     set(GTest_PREFIX "<bundled>")
   endif()
 endif()
@@ -70,6 +97,12 @@ if(PROJECT_PACKAGE_DEPENDENCIES)
       if(NOT FairLogger_PREFIX AND FairLogger_ROOT)
         set(FairLogger_PREFIX ${FairLogger_ROOT})
       endif()
+    elseif(${dep} STREQUAL asiofi)
+      if(NOT asiofi_PREFIX AND asiofi_ROOT)
+        set(asiofi_PREFIX ${asiofi_ROOT})
+      endif()
+    elseif(${dep} STREQUAL DDS)
+      set(DDS_PREFIX "${DDS_INSTALL_PREFIX}")
     elseif(${dep} STREQUAL Boost)
       if(TARGET Boost::headers)
         get_target_property(boost_include Boost::headers INTERFACE_INCLUDE_DIRECTORIES)
@@ -83,6 +116,14 @@ if(PROJECT_PACKAGE_DEPENDENCIES)
       get_filename_component(Doxygen_PREFIX ${doxygen_bin} DIRECTORY)
       get_filename_component(Doxygen_PREFIX ${Doxygen_PREFIX}/.. ABSOLUTE)
       unset(doxygen_bin)
+    elseif(${dep} STREQUAL Flatbuffers)
+      if(TARGET flatbuffers::flatbuffers)
+        get_target_property(flatbuffers_include flatbuffers::flatbuffers INTERFACE_INCLUDE_DIRECTORIES)
+      else()
+        get_target_property(flatbuffers_include flatbuffers::flatbuffers_shared INTERFACE_INCLUDE_DIRECTORIES)
+      endif()
+      get_filename_component(Flatbuffers_PREFIX ${flatbuffers_include}/.. ABSOLUTE)
+      unset(flatbuffers_include)
     elseif(NOT ${dep}_PREFIX)
       # try to guess
       if(TARGET ${dep}::${dep})

cmake/FairMQPackage.cmake

@@ -1,5 +1,5 @@
 ################################################################################
-# Copyright (C) 2018-2023 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,             #
@@ -34,6 +34,8 @@ endfunction()
 
 # Configure/Install CMake package
 macro(install_cmake_package)
+  list(SORT PROJECT_PACKAGE_DEPENDENCIES)
+  list(SORT PROJECT_INTERFACE_PACKAGE_DEPENDENCIES)
   include(CMakePackageConfigHelpers)
   set(PACKAGE_INSTALL_DESTINATION
     ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}-${PROJECT_VERSION}

cmake/FairMQProjectSettings.cmake

@@ -1,5 +1,5 @@
 ################################################################################
-# Copyright (C) 2018-2023 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,             #
@@ -114,8 +114,8 @@ endif()
 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}")
+set(CMAKE_CXX_FLAGS_RELEASE        "-O2 -DNDEBUG")
+set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "-O2 -g ${_warnings} -DNDEBUG ${_sanitizers}")
 unset(_warnings)
 unset(_sanitizers)
 
@@ -168,22 +168,9 @@ if(CMAKE_GENERATOR STREQUAL Ninja AND ENABLE_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()
+if(    CMAKE_CXX_COMPILER_ID STREQUAL "GNU"
+   AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS 9)
+  set(FAIRMQ_HAS_STD_FILESYSTEM 0)
+else()
+  set(FAIRMQ_HAS_STD_FILESYSTEM 1)
 endif()

cmake/FairMQSummary.cmake

@@ -1,5 +1,5 @@
 ################################################################################
-# Copyright (C) 2018-2023 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,             #
@@ -27,6 +27,24 @@ macro(fairmq_summary_components)
     set(tests_summary "${BRed} NO${CR}    (default, enable with ${BMagenta}-DBUILD_TESTING=ON${CR})")
   endif()
   message(STATUS "  ${BWhite}tests${CR}              ${tests_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}")
+  if(BUILD_PMIX_PLUGIN)
+    set(pmix_summary "${BGreen}YES${CR}    EXPERIMENTAL (disable with ${BMagenta}-DBUILD_PMIX_PLUGIN=OFF${CR})")
+  else()
+    set(pmix_summary "${BRed} NO${CR}    EXPERIMENTAL (default, enable with ${BMagenta}-DBUILD_PMIX_PLUGIN=ON${CR})")
+  endif()
+  message(STATUS "  ${BWhite}pmix_plugin${CR}        ${pmix_summary}")
   if(BUILD_EXAMPLES)
     set(examples_summary "${BGreen}YES${CR}    (default, disable with ${BMagenta}-DBUILD_EXAMPLES=OFF${CR})")
   else()
@@ -39,10 +57,22 @@ macro(fairmq_summary_components)
     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})")
+  if(BUILD_SDK)
+    set(sdk_summary "${BGreen}YES${CR}    EXPERIMENTAL (disable with ${BMagenta}-DBUILD_SDK=OFF${CR})")
   else()
-    set(sdk_tidy_summary "${BRed} NO${CR}    EXPERIMENTAL (default, enable with ${BMagenta}-DBUILD_TIDY_TOOL=ON${CR})")
+    set(sdk_summary "${BRed} NO${CR}    EXPERIMENTAL (default, enable with ${BMagenta}-DBUILD_SDK=ON${CR})")
+  endif()
+  message(STATUS "  ${BWhite}sdk${CR}                ${sdk_summary}")
+  if(BUILD_SDK_COMMANDS)
+    set(sdk_commands_summary "${BGreen}YES${CR}    (disable with ${BMagenta}-DBUILD_SDK_COMMANDS=OFF${CR})")
+  else()
+    set(sdk_commands_summary "${BRed} NO${CR}    (default, enable with ${BMagenta}-DBUILD_SDK_COMMANDS=ON${CR})")
+  endif()
+  message(STATUS "  ${BWhite}sdk_commands${CR}       ${sdk_commands_summary}")
+  if(BUILD_TIDY_TOOL)
+    set(sdk_tidy_summary "${BGreen}YES${CR}    (disable with ${BMagenta}-DBUILD_TIDY_TOOL=OFF${CR})")
+  else()
+    set(sdk_tidy_summary "${BRed} NO${CR}    (default, enable with ${BMagenta}-DBUILD_TIDY_TOOL=ON${CR})")
   endif()
   message(STATUS "  ${BWhite}tidy_tool${CR}          ${sdk_tidy_summary}")
 endmacro()
@@ -93,13 +123,3 @@ macro(fairmq_summary_debug_mode)
     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/FindPMIx.cmake

@@ -0,0 +1,74 @@
+################################################################################
+#    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"                       #
+################################################################################
+
+
+# The "lib/${CMAKE_LIBRARY_ARCHITECTURE}/pmix" part in all
+# the PATH_SUFFIXES is here to be able to find Debian's
+# libpmix-dev package. It installs everything below
+# /usr/lib/${CMAKE_LIBRARY_ARCHITECTURE}/pmix
+
+
+find_path(PMIx_INCLUDE_DIR
+  NAMES pmix.h
+  HINTS ${PMIX_ROOT} $ENV{PMIX_ROOT}
+  PATH_SUFFIXES include lib/${CMAKE_LIBRARY_ARCHITECTURE}/pmix/include
+)
+
+find_path(PMIx_LIBRARY_DIR
+  NAMES libpmix.dylib libpmix.so
+  HINTS ${PMIX_ROOT} $ENV{PMIX_ROOT}
+  PATH_SUFFIXES lib lib64 lib/${CMAKE_LIBRARY_ARCHITECTURE}/pmix/lib
+)
+
+find_library(PMIx_LIBRARY_SHARED
+  NAMES libpmix.dylib libpmix.so
+  HINTS ${PMIX_ROOT} $ENV{PMIX_ROOT}
+  PATH_SUFFIXES lib lib64 lib/${CMAKE_LIBRARY_ARCHITECTURE}/pmix/lib
+)
+
+find_file(PMIx_VERSION_FILE
+  NAMES pmix_version.h
+  HINTS ${PMIX_ROOT} $ENV{PMIX_ROOT}
+  PATH_SUFFIXES include lib/${CMAKE_LIBRARY_ARCHITECTURE}/pmix/include
+)
+
+file(READ "${PMIx_VERSION_FILE}" __version_raw)
+string(REGEX MATCH "#define PMIX_VERSION_MAJOR ([0-9]?)L?"
+  __version_major_raw "${__version_raw}"
+)
+set(PMIx_VERSION_MAJOR "${CMAKE_MATCH_1}")
+
+string(REGEX MATCH "#define PMIX_VERSION_MINOR ([0-9]?)L?"
+  __version_minor_raw "${__version_raw}"
+)
+set(PMIx_VERSION_MINOR "${CMAKE_MATCH_1}")
+
+string(REGEX MATCH "#define PMIX_VERSION_RELEASE ([0-9]?)L?"
+  __version_patch_raw "${__version_raw}"
+)
+set(PMIx_VERSION_PATCH "${CMAKE_MATCH_1}")
+
+set(PMIx_VERSION "${PMIx_VERSION_MAJOR}.${PMIx_VERSION_MINOR}.${PMIx_VERSION_PATCH}")
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(PMIx
+  REQUIRED_VARS
+  PMIx_INCLUDE_DIR
+  PMIx_LIBRARY_DIR
+  PMIx_LIBRARY_SHARED
+
+  VERSION_VAR PMIx_VERSION
+)
+
+if(NOT TARGET PMIx::libpmix AND PMIx_FOUND)
+  add_library(PMIx::libpmix SHARED IMPORTED)
+  set_target_properties(PMIx::libpmix PROPERTIES
+    IMPORTED_LOCATION ${PMIx_LIBRARY_SHARED}
+    INTERFACE_INCLUDE_DIRECTORIES ${PMIx_INCLUDE_DIR}
+  )
+endif()

cmake/GTestHelper.cmake

@@ -1,5 +1,5 @@
 ################################################################################
-# Copyright (C) 2017-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+# Copyright (C) 2017-2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
 #                                                                              #
 #              This software is distributed under the terms of the             #
 #              GNU Lesser General Public Licence (LGPL) version 3,             #
@@ -20,7 +20,6 @@
 #                        [DEPENDS dep1 [dep2 ...]]
 #                        [LINKS linklib1 [linklib2 ...]
 #                        [INCLUDES dir1 [dir2 ...]
-#                        [ENVIRONMENT var1=op:val1[;var2=op:val2 ...]]
 #                        [TIMEOUT seconds]
 #                        [RUN_SERIAL ON/OFF])
 #
@@ -57,7 +56,7 @@ function(add_testsuite suitename)
     cmake_parse_arguments(testsuite
         ""
         "TIMEOUT;RUN_SERIAL"
-        "SOURCES;LINKS;DEPENDS;INCLUDES;DEFINITIONS;ENVIRONMENT"
+        "SOURCES;LINKS;DEPENDS;INCLUDES;DEFINITIONS"
         ${ARGN}
     )
 
@@ -78,9 +77,6 @@ function(add_testsuite suitename)
     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()
@@ -101,7 +97,6 @@ function(add_testsuite suitename)
       TEST_PREFIX ${suitename}.
       PROPERTIES RUN_SERIAL ${testsuite_RUN_SERIAL}
                  TIMEOUT ${testsuite_TIMEOUT}
-                 ${env}
     )
 
     list(APPEND ALL_TEST_TARGETS ${target})

codemeta.json

@@ -6,29 +6,17 @@
   "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"
     },
@@ -39,7 +27,6 @@
     },
     {
       "@type": "Person",
-      "@id": "https://orcid.org/0000-0002-6249-155X",
       "givenName": "Alexey",
       "familyName": "Rybalchenko"
     },
@@ -104,7 +91,6 @@
     },
     {
       "@type": "Person",
-      "@id": "https://orcid.org/0000-0002-5321-8404",
       "givenName": "Christian",
       "familyName": "Tacke"
     },

codemeta_update.py

@@ -0,0 +1,83 @@
+#! /usr/bin/env python3
+# Copyright (C) 2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+
+import argparse
+import json
+import re
+from collections import OrderedDict
+
+
+class CodeMetaManipulator(object):
+    def load(self, filename='codemeta.json'):
+        with open(filename, 'rb') as fp:
+            self.data = json.load(fp, object_pairs_hook=OrderedDict)
+
+    @staticmethod
+    def _dict_entry_cmp(dict1, dict2, field):
+        if (field in dict1) and (field in dict2):
+            return dict1[field] == dict2[field]
+        else:
+            return False
+
+    @classmethod
+    def find_person_entry(cls, person_list, matchdict):
+        for entry in person_list:
+            if cls._dict_entry_cmp(entry, matchdict, 'email'):
+                return entry
+            if cls._dict_entry_cmp(entry, matchdict, 'familyName') \
+                    and cls._dict_entry_cmp(entry, matchdict, 'givenName'):
+                return entry
+        return None
+
+    @staticmethod
+    def update_person_entry(entry, matchdict):
+        if entry is None:
+            entry = OrderedDict()
+            entry['@type'] = 'Person'
+        for field in ('givenName', 'familyName', 'email'):
+            val = matchdict.get(field, None)
+            if val is not None:
+                entry[field] = val
+        return entry
+
+    def handle_person_list_file(self, filename, cm_field_name):
+        fp = open(filename, 'r', encoding='utf8')
+        findregex = re.compile(r'^(?P<familyName>[-\w\s]*[-\w]),\s*'
+                               r'(?P<givenName>[-\w\s]*[-\w])\s*'
+                               r'(?:<(?P<email>\S+@\S+)>)?$')
+        person_list = self.data.setdefault(cm_field_name, [])
+        for line in fp:
+            line = line.strip()
+            m = findregex.match(line)
+            if m is None:
+                raise RuntimeError("Could not analyze line %r" % line)
+            found_entry = self.find_person_entry(person_list, m.groupdict())
+            entry = self.update_person_entry(found_entry, m.groupdict())
+            if found_entry is None:
+                person_list.append(entry)
+
+    def save(self, filename='codemeta.json'):
+        with open('codemeta.json', 'w', encoding='utf8') as fp:
+            json.dump(self.data, fp, indent=2)
+            fp.write('\n')
+
+
+def main():
+    parser = argparse.ArgumentParser(description='Update codemeta.json')
+    parser.add_argument('--set-version', dest='newversion')
+    args = parser.parse_args()
+
+    cm = CodeMetaManipulator()
+    cm.load()
+    if args.newversion is not None:
+        cm.data['softwareVersion'] = args.newversion
+    cm.handle_person_list_file('AUTHORS', 'author')
+    cm.handle_person_list_file('CONTRIBUTORS', 'contributor')
+    cm.save()
+
+
+if __name__ == '__main__':
+    main()

docs/Configuration.md

@@ -16,18 +16,20 @@ 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>`)) |
+| `severity` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<runFairMQDevice.h>`)) |
+| `file-severity` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<runFairMQDevice.h>`)) |
+| `verbosity` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<runFairMQDevice.h>`)) |
+| `color` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<runFairMQDevice.h>`)) |
+| `log-to-file` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<runFairMQDevice.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` |
+| `max-run-time` | 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` |
+| `ofi-size-hint` | 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`) |

docs/Development.md

@@ -6,7 +6,7 @@
 
 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 `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.
+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.
 
 ## 4.2 Static Analysis
 

docs/Device.md

@@ -2,7 +2,7 @@
 
 # 1. Device
 
-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`).
+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`).
 
 ## 1.1 Topology
 

docs/Plugins.md

@@ -35,7 +35,7 @@ Plugin Manager:
                                         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
+                                        'libFairMQPlugin_example.so', just list
                                         'example' or 'd:example' here.To load a
                                         prelinked plugin, list 'p:example'
                                         here.
@@ -54,8 +54,40 @@ A more complete example which may serve as a start including example CMake code
 
 ## 7.3 Provided Plugins
 
-### 7.3.1 PMIx
+### 7.3.1 DDS
 
-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.
+When launching a FairMQ topology via [DDS](http://dds.gsi.de/) the DDS plugin enables FairMQ devices to interact with DDS' custom command and property subsystems - enable the plugin by passing `-P dds` on the command line.
+
+Via the property subsystem a FairMQ topology may exchange channel connection data (essentially to do service discovery) needed to connect/bind all FairMQ channels appropriately. DDS is highly optimized for this use case. See [examples/dds](examples/dds/README.md) for more details.
+
+Via the custom command subsystem a FairMQ device can receive a number of commands. FairMQ provides a convenient command line tool `fairmq-dds-command-ui` that allows interactive or scripted control of a running FairMQ topology managed via DDS. If one develops directly against the custom command DDS API, the following table lists all the commands the DDS plugin currently understands:
+
+| Custom Command | Response | Error | Description |
+| --- | --- | --- | --- |
+| `check-state` | `<ID>: <STATE> (pid: <PID>)` | n/a | Query current device state, see state machine for possible states |
+| `dump-config` | `(<ID>: <PKEY> -> <PVALUE>\n)+` | n/a | Query current device config (list property key/value pairs) |
+| `INIT DEVICE` | `<ID>: queued <CMD> transition` | `<ID>: could not queue <CMD> transition` | Initiate state transition |
+| `BIND` | `<ID>: queued <CMD> transition` | `<ID>: could not queue <CMD> transition` | Initiate state transition |
+| `CONNECT` | `<ID>: queued <CMD> transition` | `<ID>: could not queue <CMD> transition` | Initiate state transition |
+| `INIT TASK` | `<ID>: queued <CMD> transition` | `<ID>: could not queue <CMD> transition` | Initiate state transition |
+| `RUN` | `<ID>: queued <CMD> transition` | `<ID>: could not queue <CMD> transition` | Initiate state transition |
+| `STOP` | `<ID>: queued <CMD> transition` | `<ID>: could not queue <CMD> transition` | Initiate state transition |
+| `RESET TASK` | `<ID>: queued <CMD> transition` | `<ID>: could not queue <CMD> transition` | Initiate state transition |
+| `RESET DEVICE` | `<ID>: queued <CMD> transition` | `<ID>: could not queue <CMD> transition` | Initiate state transition |
+| `END` | `<ID>: queued <CMD> transition` | `<ID>: could not queue <CMD> transition` | Initiate state transition |
+| `subscribe-to-heartbeats` | `heartbeat-subscription: <ID>,OK` | n/a | Subscribe to heartbeats |
+| on heartbeat subscription | `heartbeat: <ID>,<PID>` | n/a | Heartbeat every 100ms |
+| `unsubscribe-from-heartbeats` | `heartbeat-unsubscription: <ID>,OK` | n/a | Unsubscribe from heartbeats |
+| `subscribe-to-state-changes` | `state-changes-subscription: <ID>,OK` | n/a | Subscribe to state changes |
+| on state changes subscription | `state-change: <ID>,<STATE>` | n/a | State change notification |
+| `unsubscribe-from-state-changes` | `state-changes-unsubscription: <ID>,OK` | n/a | Unsubscribe from state changes |
+
+If unknown commands are received the plugin will print a warning.
+
+### 7.3.2 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 plugin is not (yet) very mature and serves as a proof of concept at the moment.
+
+TODO example usage
 
 ← [Back](../README.md)

docs/SDK.md

@@ -0,0 +1,34 @@
+← [Back](../README.md)
+
+# 8. Controller SDK
+
+The FairMQ Controller Software Development Kit (`-DBUILD_SDK=ON`) contains a (as of today still experimental) set of C++ APIs that provide essential functionality to the implementer of a global controller.
+
+The FairMQ core library only provides two local controllers - `static` (a fixed sequence of state transitions) and `interactive` (a read-eval-print-loop which reads keyboard commands from standard input). A local controller only knows how steer a single [FairMQ device](Device.md) - in fact, it runs in a thread within the device process.
+
+A global controller has knowledge about the full topology of connected FairMQ devices. Its responsibility is to facilitate the lifecycle of a distributed FairMQ-based application (*executing a topology*), such as
+
+* allocating/releasing compute resources from a resource management system,
+* launching/setting up the run-time environment and the FairMQ devices,
+* driving the device state machines in lock-step across the full topology,
+* pushing the device configuration,
+* monitoring (some aspects of the application's) operation,
+* and handling/reporting (some) error cases.
+
+The low-level hook to integrate FairMQ devices with such a global contoller is the [plugin mechanism](Plugins.md) in the FairMQ core library. The FairMQ Controller SDK provides C++ APIs that communicate to the endpoints exposed by such a FairMQ plugin.
+
+At the moment, the Controller SDK only supports [DDS](https://dds.gsi.de) as resource manager and run-time environment. A second implementation based on [PMIx](https://pmix.org/) (targeting its implementation in [Slurm](https://slurm.schedmd.com/documentation.html) and [OpenRTE](https://www-lb.open-mpi.org/papers/euro-pvmmpi-2005-orte/)) is in development.
+
+The following section give a short overview on the APIs provided.
+
+## RMS and run-time environment
+
+The classes [`fair::mq::sdk::DDSEnvironment`](../fairmq/sdk/DDSEnvironment.h), [`fair::mq::sdk::DDSSession`](../fairmq/sdk/DDSSession.h), and [`fair::mq::sdk::DDSTopology`](../fairmq/sdk/DDSTopology.h) are thin wrappers of most of the synchronous APIs exposed by DDS ([`dds::tools_api`](http://dds.gsi.de/doc/api-docs/DDS/html/namespacedds_1_1tools__api.html) and [`dds::topology_api`](http://dds.gsi.de/doc/api-docs/DDS/html/namespacedds_1_1topology__api.html)). E.g. they allow to [start a DDS session](https://github.com/FairRootGroup/FairMQ/blob/077eb0ef691940d764cfd1852bf3981dc812ddbd/main.cpp#L26-L28), [allocate resources](https://github.com/FairRootGroup/FairMQ/blob/077eb0ef691940d764cfd1852bf3981dc812ddbd/main.cpp#L34) and [launch a topology](https://github.com/FairRootGroup/FairMQ/blob/077eb0ef691940d764cfd1852bf3981dc812ddbd/main.cpp#L39) from a C++ program.
+
+## Driving the global state machine
+
+The class [`fair::mq::sdk::Topology`](../fairmq/sdk/Topology.h) adds a FairMQ-specific view on an existing DDS session that is executing a topology of FairMQ devices. One can e.g. [initiate a state transition on all devices in the topology simultaneously](https://github.com/FairRootGroup/FairMQ/blob/077eb0ef691940d764cfd1852bf3981dc812ddbd/main.cpp#L48-L49). This topology transition completes once a topology-wide barrier is passed (all devices completed the transition). This effectively exposes the device state machine as a topology state machine. The implementation is based on remote procedure calls over the [DDS intercom service](http://dds.gsi.de/doc/api-docs/DDS/html/namespacedds_1_1intercom__api.html) between the controller and the DDS plugin shipped with FairMQ (`-DBUILD_DDS_PLUGIN=ON`).
+
+For future versions of the SDK new APIs are planned to inspect and modify the device configurations and also operate only on subsets of a given topology.
+
+← [Back](../README.md)

examples/1-1/CMakeLists.txt

@@ -1,9 +1,51 @@
 ################################################################################
-# Copyright (C) 2014-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#    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"                       #
 ################################################################################
 
-add_example(NAME 1-1 DEVICE sampler sink)
+add_executable(fairmq-ex-1-1-sampler sampler.cxx)
+target_link_libraries(fairmq-ex-1-1-sampler PRIVATE FairMQ)
+
+add_executable(fairmq-ex-1-1-sink sink.cxx)
+target_link_libraries(fairmq-ex-1-1-sink PRIVATE FairMQ)
+
+add_custom_target(Example11 DEPENDS fairmq-ex-1-1-sampler fairmq-ex-1-1-sink)
+
+set(EX_BIN_DIR ${CMAKE_CURRENT_BINARY_DIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_BINARY_DIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-1-1.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-1-1.sh)
+
+# test
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/test-ex-1-1.sh.in ${CMAKE_CURRENT_BINARY_DIR}/test-ex-1-1.sh)
+
+add_test(NAME Example.1-1.zeromq COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-1-1.sh zeromq)
+set_tests_properties(Example.1-1.zeromq PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received: ")
+
+add_test(NAME Example.1-1.shmem COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-1-1.sh shmem)
+set_tests_properties(Example.1-1.shmem PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received: ")
+
+# install
+
+install(
+  TARGETS
+  fairmq-ex-1-1-sampler
+  fairmq-ex-1-1-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(EX_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-1-1.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-1-1.sh_install)
+
+install(
+  PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-1-1.sh_install
+  DESTINATION ${PROJECT_INSTALL_BINDIR}
+  RENAME fairmq-start-ex-1-1.sh
+)

examples/1-1/sampler.cxx

@@ -30,7 +30,7 @@ struct Sampler : fair::mq::Device
         // 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(
+        FairMQMessagePtr msg(NewMessage(
             const_cast<char*>(text->c_str()),
             text->length(),
             [](void* /*data*/, void* object) { delete static_cast<std::string*>(object); },

examples/1-1/sink.cxx

@@ -27,7 +27,7 @@ struct Sink : fair::mq::Device
         fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
     }
 
-    bool HandleData(fair::mq::MessagePtr& msg, int)
+    bool HandleData(FairMQMessagePtr& msg, int)
     {
         LOG(info) << "Received: \"" << std::string(static_cast<char*>(msg->GetData()), msg->GetSize()) << "\"";
 

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

@@ -1,7 +1,5 @@
 #!/bin/bash
 
-set -e
-
 export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
 
 transport="zeromq"
@@ -10,24 +8,20 @@ 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"
+SESSION="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
 
 # 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
+trap 'kill -TERM $SAMPLER_PID; kill -TERM $SINK_PID; wait $SAMPLER_PID; wait $SINK_PID;' 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+=" --session $SESSION"
 SAMPLER+=" --control static --color false"
 SAMPLER+=" --max-iterations 1"
-SAMPLER+=" --channel-config name=$chan,type=push,method=bind,address=ipc://$chanAddr,rateLogging=0"
+SAMPLER+=" --channel-config name=data,type=push,method=bind,address=tcp://*:5555,rateLogging=0"
 @CMAKE_CURRENT_BINARY_DIR@/$SAMPLER &
 SAMPLER_PID=$!
 
@@ -35,19 +29,13 @@ 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+=" --session $SESSION"
 SINK+=" --control static --color false"
 SINK+=" --max-iterations 1"
-SINK+=" --channel-config name=$chan,type=pull,method=connect,address=ipc://$chanAddr,rateLogging=0"
+SINK+=" --channel-config name=data,type=pull,method=connect,address=tcp://localhost:5555,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

@@ -1,9 +1,64 @@
 ################################################################################
-# Copyright (C) 2014-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#    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"                       #
 ################################################################################
 
-add_example(NAME 1-n-1 DEVICE sampler processor sink CONFIG)
+add_executable(fairmq-ex-1-n-1-sampler sampler.cxx)
+target_link_libraries(fairmq-ex-1-n-1-sampler PRIVATE FairMQ)
+
+add_executable(fairmq-ex-1-n-1-processor processor.cxx)
+target_link_libraries(fairmq-ex-1-n-1-processor PRIVATE FairMQ)
+
+add_executable(fairmq-ex-1-n-1-sink sink.cxx)
+target_link_libraries(fairmq-ex-1-n-1-sink PRIVATE FairMQ)
+
+add_custom_target(Example1N1 DEPENDS fairmq-ex-1-n-1-sampler fairmq-ex-1-n-1-processor fairmq-ex-1-n-1-sink)
+
+set(EX_BIN_DIR ${CMAKE_CURRENT_BINARY_DIR})
+set(EX_CONF_DIR ${CMAKE_CURRENT_BINARY_DIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_BINARY_DIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-1-n-1.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-1-n-1.sh)
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/ex-1-n-1.json ${CMAKE_CURRENT_BINARY_DIR}/ex-1-n-1.json)
+
+# test
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/test-ex-1-n-1.sh.in ${CMAKE_CURRENT_BINARY_DIR}/test-ex-1-n-1.sh)
+
+add_test(NAME Example.1-n-1.zeromq COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-1-n-1.sh zeromq)
+set_tests_properties(Example.1-n-1.zeromq PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received: ")
+
+add_test(NAME Example.1-n-1.shmem COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-1-n-1.sh shmem)
+set_tests_properties(Example.1-n-1.shmem PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received: ")
+
+# install
+
+install(
+  TARGETS
+  fairmq-ex-1-n-1-sampler
+  fairmq-ex-1-n-1-processor
+  fairmq-ex-1-n-1-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(EX_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR})
+set(EX_CONF_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_DATADIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-1-n-1.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-1-n-1.sh_install)
+
+install(
+  PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-1-n-1.sh_install
+  DESTINATION ${PROJECT_INSTALL_BINDIR}
+  RENAME fairmq-start-ex-1-n-1.sh
+)
+
+install(
+  FILES ${CMAKE_CURRENT_BINARY_DIR}/ex-1-n-1.json
+  DESTINATION ${PROJECT_INSTALL_DATADIR}
+)

examples/1-n-1/processor.cxx

@@ -20,7 +20,7 @@ struct Processor : fair::mq::Device
         OnData("data1", &Processor::HandleData);
     }
 
-    bool HandleData(fair::mq::MessagePtr& msg, int)
+    bool HandleData(FairMQMessagePtr& msg, int)
     {
         LOG(info) << "Received data, processing...";
 
@@ -32,7 +32,7 @@ struct Processor : fair::mq::Device
         // 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()),
+        FairMQMessagePtr msg2(NewMessage(const_cast<char*>(text->c_str()),
                                         text->length(),
                                         [](void* /*data*/, void* object) { delete static_cast<std::string*>(object); },
                                         text));

examples/1-n-1/sampler.cxx

@@ -28,7 +28,7 @@ struct Sampler : fair::mq::Device
     {
         // Initializing message with NewStaticMessage will avoid copy
         // but won't delete the data after the sending is completed.
-        fair::mq::MessagePtr msg(NewStaticMessage(fText));
+        FairMQMessagePtr msg(NewStaticMessage(fText));
 
         LOG(info) << "Sending \"" << fText << "\"";
 

examples/1-n-1/sink.cxx

@@ -27,7 +27,7 @@ struct Sink : fair::mq::Device
         fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
     }
 
-    bool HandleData(fair::mq::MessagePtr& msg, int)
+    bool HandleData(FairMQMessagePtr& msg, int)
     {
         LOG(info) << "Received: \"" << std::string(static_cast<char*>(msg->GetData()), msg->GetSize()) << "\"";
 

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

@@ -1,7 +1,5 @@
 #!/bin/bash
 
-set -e
-
 export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
 
 transport="zeromq"
@@ -10,26 +8,20 @@ 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"
+ex2config="@CMAKE_CURRENT_BINARY_DIR@/ex-1-n-1.json"
+SESSION="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
 
 # 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
+trap '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;' 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+=" --session $SESSION"
 SAMPLER+=" --control static --color false"
 SAMPLER+=" --max-iterations 2"
-SAMPLER+=" --channel-config name=$chan1,type=push,method=bind,address=ipc://$chan1Addr,rateLogging=0"
+SAMPLER+=" --mq-config $ex2config"
 @CMAKE_CURRENT_BINARY_DIR@/$SAMPLER &
 SAMPLER_PID=$!
 
@@ -37,13 +29,10 @@ 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+=" --session $SESSION"
 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"
+PROCESSOR1+=" --mq-config $ex2config"
+PROCESSOR1+=" --config-key processor"
 @CMAKE_CURRENT_BINARY_DIR@/$PROCESSOR1 &
 PROCESSOR1_PID=$!
 
@@ -51,13 +40,10 @@ 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+=" --session $SESSION"
 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"
+PROCESSOR2+=" --mq-config $ex2config"
+PROCESSOR2+=" --config-key processor"
 @CMAKE_CURRENT_BINARY_DIR@/$PROCESSOR2 &
 PROCESSOR2_PID=$!
 
@@ -65,13 +51,10 @@ 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+=" --session $SESSION"
 SINK+=" --control static --color false"
 SINK+=" --max-iterations 2"
-SINK+=" --channel-config name=$chan2,type=pull,method=bind,address=ipc://$chan2Addr,rateLogging=0"
+SINK+=" --mq-config $ex2config"
 @CMAKE_CURRENT_BINARY_DIR@/$SINK &
 SINK_PID=$!
 
@@ -86,7 +69,3 @@ 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

@@ -1,145 +1,15 @@
 ################################################################################
-# Copyright (C) 2018-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#    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"                       #
 ################################################################################
 
-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)

examples/builtin-devices/CMakeLists.txt

@@ -1,11 +1,40 @@
-################################################################################
-# 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"                       #
-################################################################################
+ ################################################################################
+ #    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"                       #
+ ################################################################################
 
-add_example(NAME builtin-devices
-  VARIANT single_msg multipart
+set(EX_BIN_DIR ${CMAKE_CURRENT_BINARY_DIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_BINARY_DIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-builtin-devices.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-builtin-devices.sh)
+
+# test
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/test-ex-builtin-devices.sh.in ${CMAKE_CURRENT_BINARY_DIR}/test-ex-builtin-devices.sh)
+
+add_test(NAME Example.BuiltinDevices.zeromq COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-builtin-devices.sh zeromq)
+set_tests_properties(Example.BuiltinDevices.zeromq PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Configured maximum number of iterations reached")
+
+add_test(NAME Example.BuiltinDevices.shmem COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-builtin-devices.sh shmem)
+set_tests_properties(Example.BuiltinDevices.shmem PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Configured maximum number of iterations reached")
+
+add_test(NAME Example.BuiltinDevices.multipart.zeromq COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-builtin-devices.sh zeromq true 2)
+set_tests_properties(Example.BuiltinDevices.multipart.zeromq PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Configured maximum number of iterations reached")
+
+add_test(NAME Example.BuiltinDevices.multipart.shmem COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-builtin-devices.sh shmem true 2)
+set_tests_properties(Example.BuiltinDevices.multipart.shmem PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Configured maximum number of iterations reached")
+
+# install
+
+# configure run script with different executable paths for build and for install directories
+set(EX_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-builtin-devices.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-builtin-devices.sh_install)
+
+install(
+  PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-builtin-devices.sh_install
+  DESTINATION ${PROJECT_INSTALL_BINDIR}
+  RENAME fairmq-start-ex-builtin-devices.sh
 )

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

@@ -1,9 +1,9 @@
 #!/bin/bash
 
-set -e
-
 export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
 
+SESSION="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
+
 transport="zeromq"
 multipart="false"
 numParts="1"
@@ -12,27 +12,16 @@ if [[ $1 =~ ^[a-z]+$ ]]; then
     transport=$1
 fi
 
-if [[ $2 =~ ^multipart$ ]]; then
-    multipart="true"
-    numParts=2
+if [[ $2 =~ ^[a-z]+$ ]]; then
+    multipart=$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"
+if [[ $3 =~ ^[0-9]+$ ]]; then
+    numParts=$3
+fi
 
 # 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
+trap '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;' TERM
 
 SAMPLER="fairmq-bsampler"
 SAMPLER+=" --id bsampler1"
@@ -41,16 +30,14 @@ 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"
+SAMPLER+=" --out-channel data1"
+SAMPLER+=" --channel-config name=data1,type=push,method=bind,sndBufSize=50,rcvBufSize=50,address=tcp://localhost:5555"
 @FAIRMQ_BIN_DIR@/$SAMPLER &
 SAMPLER_PID=$!
 
@@ -61,13 +48,11 @@ 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"
+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"
 @FAIRMQ_BIN_DIR@/$SPLITTER &
 SPLITTER_PID=$!
 
@@ -78,13 +63,11 @@ 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"
+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"
 @FAIRMQ_BIN_DIR@/$PROXY1 &
 PROXY1_PID=$!
 
@@ -95,13 +78,11 @@ 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"
+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"
 @FAIRMQ_BIN_DIR@/$PROXY2 &
 PROXY2_PID=$!
 
@@ -112,13 +93,11 @@ 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"
+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"
 @FAIRMQ_BIN_DIR@/$MERGER &
 MERGER_PID=$!
 
@@ -129,13 +108,11 @@ 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"
+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"
 @FAIRMQ_BIN_DIR@/$MULTIPLIER &
 MULTIPLIER_PID=$!
 
@@ -148,10 +125,9 @@ 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"
+SINK+=" --in-channel data5"
+SINK+=" --channel-config name=data5,type=pull,method=bind,sndBufSize=50,rcvBufSize=50,address=tcp://localhost:5561"
 @FAIRMQ_BIN_DIR@/$SINK &
 SINK_PID=$!
 
@@ -170,7 +146,3 @@ 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

@@ -1,11 +1,52 @@
 ################################################################################
-# Copyright (C) 2014-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+#    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"                       #
 ################################################################################
 
-add_example(NAME copypush
-  DEVICE sampler sink
+
+add_executable(fairmq-ex-copypush-sampler sampler.cxx)
+target_link_libraries(fairmq-ex-copypush-sampler PRIVATE FairMQ)
+
+add_executable(fairmq-ex-copypush-sink sink.cxx)
+target_link_libraries(fairmq-ex-copypush-sink PRIVATE FairMQ)
+
+add_custom_target(ExampleCopyPush DEPENDS fairmq-ex-copypush-sampler fairmq-ex-copypush-sink)
+
+set(EX_BIN_DIR ${CMAKE_CURRENT_BINARY_DIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_BINARY_DIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-copypush.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-copypush.sh)
+
+# test
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/test-ex-copypush.sh.in ${CMAKE_CURRENT_BINARY_DIR}/test-ex-copypush.sh)
+
+add_test(NAME Example.CopyPush.zeromq COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-copypush.sh zeromq)
+set_tests_properties(Example.CopyPush.zeromq PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received message: ")
+
+add_test(NAME Example.CopyPush.shmem COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-copypush.sh shmem)
+set_tests_properties(Example.CopyPush.shmem PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received message: ")
+
+# install
+
+install(
+  TARGETS
+  fairmq-ex-copypush-sampler
+  fairmq-ex-copypush-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(EX_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-copypush.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-copypush.sh_install)
+
+install(
+  PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-copypush.sh_install
+  DESTINATION ${PROJECT_INSTALL_BINDIR}
+  RENAME fairmq-start-ex-copypush.sh
 )

examples/copypush/sampler.cxx

@@ -19,7 +19,7 @@ struct Sampler : fair::mq::Device
 {
     void InitTask() override
     {
-        fNumDataChannels = GetNumSubChannels("data");
+        fNumDataChannels = fChannels.at("data").size();
         fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
     }
 
@@ -27,10 +27,10 @@ struct Sampler : fair::mq::Device
     {
         // 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++));
+        FairMQMessagePtr msg(NewSimpleMessage(fCounter++));
 
         for (int i = 0; i < fNumDataChannels - 1; ++i) {
-            fair::mq::MessagePtr msgCopy(NewMessage());
+            FairMQMessagePtr msgCopy(NewMessage());
             msgCopy->Copy(*msg);
             Send(msgCopy, "data", i);
         }

examples/copypush/sink.cxx

@@ -27,7 +27,7 @@ struct Sink : fair::mq::Device
         fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
     }
 
-    bool HandleData(fair::mq::MessagePtr& msg, int)
+    bool HandleData(FairMQMessagePtr& msg, int)
     {
         LOG(info) << "Received message: \"" << *(static_cast<uint64_t*>(msg->GetData())) << "\"";
 

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

@@ -1,7 +1,5 @@
 #!/bin/bash
 
-set -e
-
 export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
 
 transport="zeromq"
@@ -10,25 +8,19 @@ 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"
+SESSION="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
 
 # 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
+trap 'kill -TERM $SAMPLER_PID; kill -TERM $SINK1_PID; kill -TERM $SINK2_PID; wait $SAMPLER_PID; wait $SINK1_PID; wait $SINK2_PID;' 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+=" --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"
+SAMPLER+=" --channel-config name=data,type=push,method=bind,rateLogging=0,address=tcp://*:5555,address=tcp://*:5556"
 @CMAKE_CURRENT_BINARY_DIR@/$SAMPLER &
 SAMPLER_PID=$!
 
@@ -36,13 +28,10 @@ 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+=" --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"
+SINK1+=" --channel-config name=data,type=pull,method=connect,rateLogging=0,address=tcp://localhost:5555"
 @CMAKE_CURRENT_BINARY_DIR@/$SINK1 &
 SINK1_PID=$!
 
@@ -50,13 +39,10 @@ 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+=" --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"
+SINK2+=" --channel-config name=data,type=pull,method=connect,rateLogging=0,address=tcp://localhost:5556"
 @CMAKE_CURRENT_BINARY_DIR@/$SINK2 &
 SINK2_PID=$!
 
@@ -64,7 +50,3 @@ SINK2_PID=$!
 wait $SAMPLER_PID
 wait $SINK1_PID
 wait $SINK2_PID
-
-set +e
-rm $chanAddr1; rm $chanAddr2
-exit 0

examples/custom-controller/CMakeLists.txt

@@ -1,20 +0,0 @@
-################################################################################
-# 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

@@ -1,97 +0,0 @@
-/********************************************************************************
- *    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,21 +0,0 @@
-/********************************************************************************
- *    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_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 */
-

examples/custom-controller/main.cxx

@@ -1,46 +0,0 @@
-/********************************************************************************
- *    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/processor.cxx

@@ -20,7 +20,7 @@ struct Processor : fair::mq::Device
         OnData("data1", &Processor::HandleData);
     }
 
-    bool HandleData(fair::mq::MessagePtr& msg, int)
+    bool HandleData(FairMQMessagePtr& msg, int)
     {
         LOG(info) << "Received data, processing...";
 
@@ -32,7 +32,7 @@ struct Processor : fair::mq::Device
         // 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()),
+        FairMQMessagePtr msg2(NewMessage(const_cast<char*>(text->c_str()),
                                         text->length(),
                                         [](void* /*data*/, void* object) { delete static_cast<std::string*>(object); },
                                         text));

examples/dds/sampler.cxx

@@ -24,7 +24,7 @@ struct Sampler : fair::mq::Device
     {
         // 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"));
+        FairMQMessagePtr msg(NewSimpleMessage("Data"));
 
         LOG(info) << "Sending \"Data\"";
 

examples/dds/sink.cxx

@@ -25,7 +25,7 @@ struct Sink : fair::mq::Device
         fIterations = fConfig->GetValue<uint64_t>("iterations");
     }
 
-    bool HandleData(fair::mq::MessagePtr& msg, int)
+    bool HandleData(FairMQMessagePtr& msg, int)
     {
         LOG(info) << "Received: \"" << std::string(static_cast<char*>(msg->GetData()), msg->GetSize()) << "\"";
 

examples/multipart/CMakeLists.txt

@@ -1,11 +1,56 @@
-################################################################################
-# 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"                       #
-################################################################################
+ ################################################################################
+ #    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"                       #
+ ################################################################################
 
-add_example(NAME multipart
-  DEVICE sampler sink
+add_executable(fairmq-ex-multipart-sampler sampler.cxx)
+target_link_libraries(fairmq-ex-multipart-sampler PRIVATE FairMQ)
+
+add_executable(fairmq-ex-multipart-sink sink.cxx)
+target_link_libraries(fairmq-ex-multipart-sink PRIVATE FairMQ)
+
+add_custom_target(ExampleMultipart DEPENDS fairmq-ex-multipart-sampler fairmq-ex-multipart-sink)
+
+set(EX_BIN_DIR ${CMAKE_CURRENT_BINARY_DIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_BINARY_DIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-multipart.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-multipart.sh)
+
+# test
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/test-ex-multipart.sh.in ${CMAKE_CURRENT_BINARY_DIR}/test-ex-multipart.sh)
+
+add_test(NAME Example.Multipart.zeromq COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-multipart.sh zeromq)
+set_tests_properties(Example.Multipart.zeromq PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received message with 7 parts")
+
+add_test(NAME Example.Multipart.shmem COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-multipart.sh shmem)
+set_tests_properties(Example.Multipart.shmem PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received message with 7 parts")
+
+if(BUILD_OFI_TRANSPORT)
+  add_test(NAME Example.Multipart.ofi COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-multipart.sh ofi)
+  set_tests_properties(Example.Multipart.ofi PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received message with 7 parts")
+endif()
+
+# install
+
+install(
+  TARGETS
+  fairmq-ex-multipart-sampler
+  fairmq-ex-multipart-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(EX_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-multipart.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-multipart.sh_install)
+
+install(
+  PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-multipart.sh_install
+  DESTINATION ${PROJECT_INSTALL_BINDIR}
+  RENAME fairmq-start-ex-multipart.sh
 )

examples/multipart/README.md

@@ -5,7 +5,7 @@ A topology of two devices - Sampler and Sink, communicating with PUSH-PULL patte
 
 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.
+Each message part is a regular FairMQMessage. To combine them into a multi-part message use `FairMQParts`. Add messages to `FairMQParts` with `AddPart` method.
 
 All parts are guaranteed to be delivered together. The Receive call in the sink will recive the entire parts structure.
 

examples/multipart/sampler.cxx

@@ -35,15 +35,15 @@ struct Sampler : fair::mq::Device
         }
         LOG(info) << "Sending header with stopFlag: " << header.stopFlag;
 
-        fair::mq::Parts parts;
+        FairMQParts 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) };
+        // create more data parts, testing the FairMQParts in-place constructor
+        FairMQParts auxData{ NewMessage(500), NewMessage(600), NewMessage(700) };
         assert(auxData.Size() == 3);
         parts.AddPart(std::move(auxData));
         assert(auxData.Size() == 0);

examples/multipart/sink.cxx

@@ -20,14 +20,10 @@ struct Sink : fair::mq::Device
         OnData("data", &Sink::HandleData);
     }
 
-    bool HandleData(fair::mq::Parts& parts, int)
+    bool HandleData(FairMQParts& 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;
 

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

@@ -1,7 +1,5 @@
 #!/bin/bash
 
-set -e
-
 export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
 
 transport="zeromq"
@@ -10,25 +8,19 @@ if [[ $1 =~ ^[a-z]+$ ]]; then
     transport=$1
 fi
 
-session="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
-chan="data"
-chanAddr=""
-chanIpcFile="/tmp/fmq_$session""_""$chan""_""$transport"
-chanAddr="ipc://""$chanIpcFile"
+SESSION="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
 
 # 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 $chanIpcFile; exit 0' TERM
+trap 'kill -TERM $SAMPLER_PID; kill -TERM $SINK_PID; wait $SAMPLER_PID; wait $SINK_PID;' TERM
 
 SAMPLER="fairmq-ex-multipart-sampler"
 SAMPLER+=" --id sampler1"
 SAMPLER+=" --transport $transport"
 SAMPLER+=" --verbosity veryhigh"
-SAMPLER+=" --session $session"
-SAMPLER+=" --shm-segment-size 100000000"
-SAMPLER+=" --shm-monitor true"
+SAMPLER+=" --session $SESSION"
 SAMPLER+=" --max-iterations 1"
 SAMPLER+=" --control static --color false"
-SAMPLER+=" --channel-config name=$chan,type=pair,method=connect,rateLogging=0,address=$chanAddr,linger=1000"
+SAMPLER+=" --channel-config name=data,type=pair,method=connect,rateLogging=0,address=tcp://127.0.0.1:5555,linger=1000"
 @CMAKE_CURRENT_BINARY_DIR@/$SAMPLER &
 SAMPLER_PID=$!
 
@@ -36,17 +28,11 @@ SINK="fairmq-ex-multipart-sink"
 SINK+=" --id sink1"
 SINK+=" --transport $transport"
 SINK+=" --verbosity veryhigh"
-SINK+=" --session $session"
-SINK+=" --shm-segment-size 100000000"
-SINK+=" --shm-monitor true"
+SINK+=" --session $SESSION"
 SINK+=" --control static --color false"
-SINK+=" --channel-config name=$chan,type=pair,method=bind,rateLogging=0,address=$chanAddr"
+SINK+=" --channel-config name=data,type=pair,method=bind,rateLogging=0,address=tcp://127.0.0.1:5555"
 @CMAKE_CURRENT_BINARY_DIR@/$SINK &
 SINK_PID=$!
 
 wait $SAMPLER_PID
 wait $SINK_PID
-
-set +e
-rm $chanIpcFile
-exit 0

examples/multiple-channels/CMakeLists.txt

@@ -1,12 +1,52 @@
-################################################################################
-# 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"                       #
-################################################################################
+ ################################################################################
+ #    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"                       #
+ ################################################################################
 
-add_example(NAME multiple-channels
-  DEVICE sampler broadcaster sink
-  TRANSPORT zeromq
+add_executable(fairmq-ex-multiple-channels-sampler sampler.cxx)
+target_link_libraries(fairmq-ex-multiple-channels-sampler PRIVATE FairMQ)
+
+add_executable(fairmq-ex-multiple-channels-broadcaster broadcaster.cxx)
+target_link_libraries(fairmq-ex-multiple-channels-broadcaster PRIVATE FairMQ)
+
+add_executable(fairmq-ex-multiple-channels-sink sink.cxx)
+target_link_libraries(fairmq-ex-multiple-channels-sink PRIVATE FairMQ)
+
+add_custom_target(ExampleMultipleChannels DEPENDS fairmq-ex-multiple-channels-sampler fairmq-ex-multiple-channels-broadcaster fairmq-ex-multiple-channels-sink)
+
+set(EX_BIN_DIR ${CMAKE_CURRENT_BINARY_DIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_BINARY_DIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-multiple-channels.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-multiple-channels.sh)
+
+# test
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/test-ex-multiple-channels.sh.in ${CMAKE_CURRENT_BINARY_DIR}/test-ex-multiple-channels.sh)
+
+add_test(NAME Example.MultipleChannels.zeromq COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-multiple-channels.sh zeromq)
+set_tests_properties(Example.MultipleChannels.zeromq PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received messages from both sources.")
+
+# install
+
+install(
+  TARGETS
+  fairmq-ex-multiple-channels-sampler
+  fairmq-ex-multiple-channels-broadcaster
+  fairmq-ex-multiple-channels-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(EX_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-multiple-channels.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-multiple-channels.sh_install)
+
+install(
+  PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-multiple-channels.sh_install
+  DESTINATION ${PROJECT_INSTALL_BINDIR}
+  RENAME fairmq-start-ex-multiple-channels.sh
 )

examples/multiple-channels/README.md

@@ -5,4 +5,4 @@ This example demonstrates how to work with multiple channels and multiplex betwe
 
 A topology of three devices - **Sampler**, **Sink** and **Broadcaster**. The Sampler sends data to the Sink via the PUSH-PULL pattern. The Broadcaster device sends a message to both Sampler and Sink containing a string "OK" every second. The Broadcaster sends the message via PUB pattern. Both Sampler and Sink, besides doing their PUSH-PULL job, listen via SUB to the Broadcaster.
 
-The multiplexing between their data channels and the broadcast channels happens with `fair::mq::Poller`.
+The multiplexing between their data channels and the broadcast channels happens with `FairMQPoller`.

examples/multiple-channels/broadcaster.cxx

@@ -22,7 +22,7 @@ struct Broadcaster : fair::mq::Device
 
         // 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("OK"));
+        FairMQMessagePtr msg(NewSimpleMessage("OK"));
 
         LOG(info) << "Sending OK";
 

examples/multiple-channels/sampler.cxx

@@ -7,7 +7,7 @@
  ********************************************************************************/
 
 #include <fairmq/Device.h>
-#include <fairmq/Poller.h>
+#include <FairMQPoller.h>
 #include <fairmq/runDevice.h>
 
 #include <chrono>
@@ -26,13 +26,13 @@ struct Sampler : fair::mq::Device
 
     void Run() override
     {
-        fair::mq::PollerPtr poller(NewPoller("data", "broadcast"));
+        FairMQPollerPtr poller(NewPoller("data", "broadcast"));
 
         while (!NewStatePending()) {
             poller->Poll(100);
 
             if (poller->CheckInput("broadcast", 0)) {
-                fair::mq::MessagePtr msg(NewMessage());
+                FairMQMessagePtr msg(NewMessage());
 
                 if (Receive(msg, "broadcast") > 0) {
                     LOG(info) << "Received broadcast: \"" << std::string(static_cast<char*>(msg->GetData()), msg->GetSize()) << "\"";
@@ -42,7 +42,7 @@ struct Sampler : fair::mq::Device
             if (poller->CheckOutput("data", 0)) {
                 std::this_thread::sleep_for(std::chrono::seconds(1));
 
-                fair::mq::MessagePtr msg(NewSimpleMessage(fText));
+                FairMQMessagePtr msg(NewSimpleMessage(fText));
 
                 if (Send(msg, "data") > 0) {
                     LOG(info) << "Sent \"" << fText << "\"";

examples/multiple-channels/sink.cxx

@@ -27,7 +27,7 @@ struct Sink : fair::mq::Device
         fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
     }
 
-    bool HandleBroadcast(fair::mq::MessagePtr& msg, int /*index*/)
+    bool HandleBroadcast(FairMQMessagePtr& msg, int /*index*/)
     {
         LOG(info) << "Received broadcast: \"" << std::string(static_cast<char*>(msg->GetData()), msg->GetSize()) << "\"";
         fReceivedBroadcast = true;
@@ -35,7 +35,7 @@ struct Sink : fair::mq::Device
         return CheckIterations();
     }
 
-    bool HandleData(fair::mq::MessagePtr& msg, int /*index*/)
+    bool HandleData(FairMQMessagePtr& msg, int /*index*/)
     {
         LOG(info) << "Received message: \"" << std::string(static_cast<char*>(msg->GetData()), msg->GetSize()) << "\"";
         fReceivedData = true;

examples/multiple-channels/test-ex-multiple-channels.sh.in

@@ -1,7 +1,5 @@
 #!/bin/bash
 
-set -e
-
 export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
 
 transport="zeromq"
@@ -10,26 +8,18 @@ if [[ $1 =~ ^[a-z]+$ ]]; then
     transport=$1
 fi
 
-session="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
-dataChan="data"
-broadcastChan="broadcast"
-dataChanAddr="/tmp/fmq_$session""_""$dataChan""_""$transport"
-broadcastChanAddr="/tmp/fmq_$session""_""$broadcastChan""_""$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 $BROADCASTER_PID; wait $SAMPLER_PID; wait $SINK_PID; wait $BROADCASTER_PID; rm $dataChanAddr; rm $broadcastChanAddr; exit 0' TERM
+trap 'kill -TERM $SAMPLER_PID; kill -TERM $SINK_PID; kill -TERM $BROADCASTER_PID; wait $SAMPLER_PID; wait $SINK_PID; wait $BROADCASTER_PID;' TERM
+
 
 SINK="fairmq-ex-multiple-channels-sink"
 SINK+=" --id sink1"
-SINK+=" --session $session"
 SINK+=" --transport $transport"
-SINK+=" --verbosity veryhigh --severity debug"
-SINK+=" --shm-segment-size 100000000"
-SINK+=" --shm-monitor true"
+SINK+=" --verbosity veryhigh"
 SINK+=" --max-iterations 1"
 SINK+=" --control static --color false"
-SINK+=" --channel-config name=$dataChan,type=pull,method=connect,rateLogging=0,address=ipc://$dataChanAddr"
-SINK+="                  name=$broadcastChan,type=sub,method=connect,rateLogging=0,address=ipc://$broadcastChanAddr"
+SINK+=" --channel-config name=data,type=pull,method=connect,rateLogging=0,address=tcp://localhost:5555"
+SINK+="                  name=broadcast,type=sub,method=connect,rateLogging=0,address=tcp://localhost:5005"
 @CMAKE_CURRENT_BINARY_DIR@/$SINK &
 SINK_PID=$!
 
@@ -37,27 +27,21 @@ sleep 1
 
 SAMPLER="fairmq-ex-multiple-channels-sampler"
 SAMPLER+=" --id sampler1"
-SAMPLER+=" --session $session"
 SAMPLER+=" --transport $transport"
-SAMPLER+=" --verbosity veryhigh --severity debug"
-SAMPLER+=" --shm-segment-size 100000000"
-SAMPLER+=" --shm-monitor true"
+SAMPLER+=" --verbosity veryhigh"
 SAMPLER+=" --max-iterations 1"
 SAMPLER+=" --control static --color false"
-SAMPLER+=" --channel-config name=$dataChan,type=push,method=bind,rateLogging=0,address=ipc://$dataChanAddr"
-SAMPLER+="                  name=$broadcastChan,type=sub,method=connect,rateLogging=0,address=ipc://$broadcastChanAddr"
+SAMPLER+=" --channel-config name=data,type=push,method=bind,rateLogging=0,address=tcp://*:5555"
+SAMPLER+="                  name=broadcast,type=sub,method=connect,rateLogging=0,address=tcp://localhost:5005"
 @CMAKE_CURRENT_BINARY_DIR@/$SAMPLER &
 SAMPLER_PID=$!
 
 BROADCASTER="fairmq-ex-multiple-channels-broadcaster"
 BROADCASTER+=" --id broadcaster1"
-BROADCASTER+=" --session $session"
 BROADCASTER+=" --transport $transport"
-BROADCASTER+=" --verbosity veryhigh --severity debug"
-BROADCASTER+=" --shm-segment-size 100000000"
-BROADCASTER+=" --shm-monitor true"
+BROADCASTER+=" --verbosity veryhigh"
 BROADCASTER+=" --control static --color false"
-BROADCASTER+=" --channel-config name=$broadcastChan,type=pub,method=bind,rateLogging=0,address=ipc://$broadcastChanAddr"
+BROADCASTER+=" --channel-config name=broadcast,type=pub,method=bind,rateLogging=0,address=tcp://*:5005"
 @CMAKE_CURRENT_BINARY_DIR@/$BROADCASTER &
 BROADCASTER_PID=$!
 
@@ -69,7 +53,3 @@ kill -SIGINT $BROADCASTER_PID
 
 # wait for broadcaster to finish
 wait $BROADCASTER_PID
-
-set +e
-rm $dataChanAddr; rm $broadcastChanAddr
-exit 0

examples/multiple-transports/CMakeLists.txt

@@ -1,12 +1,51 @@
-################################################################################
-# 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"                       #
-################################################################################
+ ################################################################################
+ #    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"                       #
+ ################################################################################
 
-add_example(NAME multiple-transports
-  DEVICE sampler1 sampler2 sink
-  NO_TRANSPORT
+add_executable(fairmq-ex-multiple-transports-sampler1 sampler1.cxx)
+target_link_libraries(fairmq-ex-multiple-transports-sampler1 PRIVATE FairMQ)
+
+add_executable(fairmq-ex-multiple-transports-sampler2 sampler2.cxx)
+target_link_libraries(fairmq-ex-multiple-transports-sampler2 PRIVATE FairMQ)
+
+add_executable(fairmq-ex-multiple-transports-sink sink.cxx)
+target_link_libraries(fairmq-ex-multiple-transports-sink PRIVATE FairMQ)
+
+add_custom_target(ExampleMultipleTransports DEPENDS fairmq-ex-multiple-transports-sampler1 fairmq-ex-multiple-transports-sampler2 fairmq-ex-multiple-transports-sink)
+
+set(EX_BIN_DIR ${CMAKE_CURRENT_BINARY_DIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_BINARY_DIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-multiple-transports.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-multiple-transports.sh)
+
+# test
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/test-ex-multiple-transports.sh.in ${CMAKE_CURRENT_BINARY_DIR}/test-ex-multiple-transports.sh)
+add_test(NAME Example.MultipleTransports COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-multiple-transports.sh)
+set_tests_properties(Example.MultipleTransports PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received messages from both sources.")
+
+# install
+
+install(
+  TARGETS
+  fairmq-ex-multiple-transports-sampler1
+  fairmq-ex-multiple-transports-sampler2
+  fairmq-ex-multiple-transports-sink
+
+  LIBRARY DESTINATION ${PROJECT_INSTALL_LIBDIR}
+  RUNTIME DESTINATION ${PROJECT_INSTALL_BINDIR}
+)
+
+# configure run script with different executable paths for install directories
+set(EX_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-multiple-transports.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-multiple-transports.sh_install)
+
+install(
+  PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-multiple-transports.sh_install
+  DESTINATION ${PROJECT_INSTALL_BINDIR}
+  RENAME fairmq-start-ex-multiple-transports.sh
 )

examples/multiple-transports/sampler1.cxx

@@ -28,7 +28,7 @@ struct Sampler1 : fair::mq::Device
     bool ConditionalRun() override
     {
         // Creates a message using the transport of channel data1
-        fair::mq::MessagePtr msg(NewMessageFor("data1", 0, 1000000));
+        FairMQMessagePtr msg(NewMessageFor("data1", 0, 1000000));
 
         // 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).
@@ -54,7 +54,7 @@ struct Sampler1 : fair::mq::Device
         uint64_t numAcks = 0;
 
         while (!NewStatePending()) {
-            fair::mq::MessagePtr ack(NewMessageFor("ack", 0));
+            FairMQMessagePtr ack(NewMessageFor("ack", 0));
             if (Receive(ack, "ack") < 0) {
                 break;
             }

examples/multiple-transports/sampler2.cxx

@@ -22,7 +22,7 @@ struct Sampler2 : fair::mq::Device
 
     bool ConditionalRun() override
     {
-        fair::mq::MessagePtr msg(NewMessage(1000));
+        FairMQMessagePtr msg(NewMessage(1000));
 
         // 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).

examples/multiple-transports/sink.cxx

@@ -9,8 +9,6 @@
 #include <fairmq/Device.h>
 #include <fairmq/runDevice.h>
 
-#include <stdexcept>
-
 namespace bpo = boost::program_options;
 
 struct Sink : fair::mq::Device
@@ -28,13 +26,13 @@ struct Sink : fair::mq::Device
     }
 
     // handler is called whenever a message arrives on "data", with a reference to the message and a sub-channel index (here 0)
-    bool HandleData1(fair::mq::MessagePtr& /*msg*/, int /*index*/)
+    bool HandleData1(FairMQMessagePtr& /*msg*/, int /*index*/)
     {
         fNumIterations1++;
         // Creates a message using the transport of channel ack
-        fair::mq::MessagePtr ack(NewMessageFor("ack", 0));
+        FairMQMessagePtr ack(NewMessageFor("ack", 0));
         if (Send(ack, "ack") < 0) {
-            throw std::runtime_error("could not send an ack");
+            return false;
         }
 
         // return true if want to be called again (otherwise go to IDLE state)
@@ -42,7 +40,7 @@ struct Sink : fair::mq::Device
     }
 
     // handler is called whenever a message arrives on "data", with a reference to the message and a sub-channel index (here 0)
-    bool HandleData2(fair::mq::MessagePtr& /*msg*/, int /*index*/)
+    bool HandleData2(FairMQMessagePtr& /*msg*/, int /*index*/)
     {
         fNumIterations2++;
         // return true if want to be called again (otherwise go to IDLE state)

examples/multiple-transports/test-ex-multiple-transports.sh.in

@@ -1,65 +1,47 @@
 #!/bin/bash
 
-set -e
-
 export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
 
-session="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
-chan1="data1"
-chan2="data2"
-ackChan="ack"
-chan1Addr="/tmp/fmq_$session""_""$chan1"
-chan2Addr="/tmp/fmq_$session""_""$chan2"
-ackChanAddr="/tmp/fmq_$session""_""$ackChan"
+SESSION="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
 
-trap 'set +e; kill -TERM $SAMPLER1_PID; kill -TERM $SAMPLER2_PID; kill -TERM $SINK_PID; wait $SAMPLER1_PID; wait $SAMPLER2_PID; wait $SINK_PID; @CMAKE_BINARY_DIR@/fairmq/fairmq-shmmonitor --cleanup --session $SESSION; rm $chan1Addr; rm $chan2Addr; rm $ackChanAddr; exit 0' TERM
+trap 'kill -TERM $SAMPLER1_PID; kill -TERM $SAMPLER2_PID; kill -TERM $SINK_PID; wait $SAMPLER1_PID; wait $SAMPLER2_PID; wait $SINK_PID; @CMAKE_BINARY_DIR@/fairmq/fairmq-shmmonitor --cleanup --session $SESSION;' TERM
 
 SINK="fairmq-ex-multiple-transports-sink"
 SINK+=" --id sink1"
-SINK+=" --verbosity veryhigh --severity debug"
-SINK+=" --shm-segment-size 100000000"
-SINK+=" --shm-monitor true"
-SINK+=" --session $session"
+SINK+=" --verbosity veryhigh"
+SINK+=" --session $SESSION"
 SINK+=" --max-iterations 1"
 SINK+=" --control static --color false"
 SINK+=" --transport shmem"
-SINK+=" --channel-config name=$chan1,type=pull,method=connect,address=ipc://$chan1Addr"
-SINK+="                  name=$chan2,type=pull,method=connect,address=ipc://$chan2Addr,transport=zeromq"
-SINK+="                  name=$ackChan,type=pub,method=connect,address=ipc://$ackChanAddr,transport=zeromq"
+SINK+=" --channel-config name=data1,type=pull,method=connect,address=tcp://127.0.0.1:5555"
+SINK+="                  name=data2,type=pull,method=connect,address=tcp://127.0.0.1:5556,transport=zeromq"
+SINK+="                  name=ack,type=pub,method=connect,address=tcp://127.0.0.1:5557,transport=zeromq"
 @CMAKE_CURRENT_BINARY_DIR@/$SINK &
 SINK_PID=$!
 
 SAMPLER1="fairmq-ex-multiple-transports-sampler1"
 SAMPLER1+=" --id sampler1"
-SAMPLER1+=" --session $session"
-SAMPLER1+=" --verbosity veryhigh --severity debug"
-SAMPLER1+=" --shm-segment-size 100000000"
-SAMPLER1+=" --shm-monitor true"
+SAMPLER1+=" --session $SESSION"
+SAMPLER1+=" --verbosity veryhigh"
 SAMPLER1+=" --max-iterations 1"
 SAMPLER1+=" --control static --color false"
 SAMPLER1+=" --transport shmem"
-SAMPLER1+=" --channel-config name=$chan1,type=push,method=bind,address=ipc://$chan1Addr"
-SAMPLER1+="                  name=$ackChan,type=sub,method=bind,address=ipc://$ackChanAddr,transport=zeromq"
+SAMPLER1+=" --channel-config name=data1,type=push,method=bind,address=tcp://127.0.0.1:5555"
+SAMPLER1+="                  name=ack,type=sub,method=bind,address=tcp://127.0.0.1:5557,transport=zeromq"
 @CMAKE_CURRENT_BINARY_DIR@/$SAMPLER1 &
 SAMPLER1_PID=$!
 
 SAMPLER2="fairmq-ex-multiple-transports-sampler2"
 SAMPLER2+=" --id sampler2"
-SAMPLER2+=" --session $session"
-SAMPLER2+=" --verbosity veryhigh --severity debug"
-SAMPLER2+=" --shm-segment-size 100000000"
-SAMPLER2+=" --shm-monitor true"
+SAMPLER2+=" --session $SESSION"
+SAMPLER2+=" --verbosity veryhigh"
 SAMPLER2+=" --max-iterations 1"
 SAMPLER2+=" --control static --color false"
 SAMPLER2+=" --transport zeromq"
-SAMPLER2+=" --channel-config name=$chan2,type=push,method=bind,address=ipc://$chan2Addr"
+SAMPLER2+=" --channel-config name=data2,type=push,method=bind,address=tcp://127.0.0.1:5556"
 @CMAKE_CURRENT_BINARY_DIR@/$SAMPLER2 &
 SAMPLER2_PID=$!
 
 wait $SAMPLER1_PID
 wait $SAMPLER2_PID
 wait $SINK_PID
-
-set +e
-rm $chan1Addr; rm $chan2Addr; rm $ackChanAddr
-exit 0

examples/n-m/receiver.cxx

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2020-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ *    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,             *
@@ -24,7 +24,7 @@ namespace bpo = boost::program_options;
 
 struct TFBuffer
 {
-    fair::mq::Parts parts;
+    FairMQParts parts;
     chrono::steady_clock::time_point start;
     chrono::steady_clock::time_point end;
 };
@@ -43,7 +43,7 @@ struct Receiver : fair::mq::Device
         fMaxTimeframes = GetConfig()->GetValue<int>("max-timeframes");
     }
 
-    bool HandleData(fair::mq::Parts& parts, int /* index */)
+    bool HandleData(FairMQParts& parts, int /* index */)
     {
         Header& h = *(static_cast<Header*>(parts.At(0)->GetData()));
         // LOG(info) << "Received sub-time frame #" << h.id << " from Sender" << h.senderIndex;
@@ -54,7 +54,7 @@ struct Receiver : fair::mq::Device
                 fBuffer[h.id].start = chrono::steady_clock::now();
             }
             // if the received ID has not previously been discarded, store the data part in the buffer
-            fBuffer[h.id].parts.AddPart(std::move(parts.At(1)));
+            fBuffer[h.id].parts.AddPart(move(parts.At(1)));
         } else {
             // if received ID has been previously discarded.
             LOG(debug) << "Received part from an already discarded timeframe with id " << h.id;
@@ -93,7 +93,7 @@ struct Receiver : fair::mq::Device
     unordered_map<uint16_t, TFBuffer> fBuffer;
     unordered_set<uint16_t> fDiscardedSet;
 
-    unsigned int fNumSenders = 0;
+    int fNumSenders = 0;
     int fBufferTimeoutInMs = 5000;
     int fMaxTimeframes = 0;
     int fTimeframeCounter = 0;
@@ -107,7 +107,7 @@ void addCustomOptions(bpo::options_description& options)
         ("max-timeframes", bpo::value<int>()->default_value(0), "Maximum number of timeframes to receive (0 - unlimited)");
 }
 
-std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& /* config */)
+std::unique_ptr<fair::mq::Device> getDevice(FairMQProgOptions& /* config */)
 {
     return std::make_unique<Receiver>();
 }

examples/n-m/sender.cxx

@@ -28,11 +28,11 @@ struct Sender : fair::mq::Device
 
     void Run() override
     {
-        fair::mq::Channel& dataInChannel = GetChannel("sync", 0);
+        FairMQChannel& dataInChannel = fChannels.at("sync").at(0);
 
         while (!NewStatePending()) {
             Header h;
-            fair::mq::MessagePtr id(NewMessage());
+            FairMQMessagePtr id(NewMessage());
             if (dataInChannel.Receive(id) > 0) {
                 h.id = *(static_cast<uint16_t*>(id->GetData()));
                 h.senderIndex = fIndex;
@@ -40,7 +40,7 @@ struct Sender : fair::mq::Device
                 continue;
             }
 
-            fair::mq::Parts parts;
+            FairMQParts parts;
             parts.AddPart(NewSimpleMessage(h));
             parts.AddPart(NewMessage(fSubtimeframeSize));
 
@@ -66,7 +66,7 @@ void addCustomOptions(bpo::options_description& options)
         ("subtimeframe-size", bpo::value<int>()->default_value(1000), "Subtimeframe size in bytes")
         ("num-receivers", bpo::value<int>()->required(), "Number of EPNs");
 }
-std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& /* config */)
+std::unique_ptr<fair::mq::Device> getDevice(FairMQProgOptions& /* config */)
 {
     return std::make_unique<Sender>();
 }

examples/n-m/synchronizer.cxx

@@ -19,7 +19,7 @@ struct Synchronizer : fair::mq::Device
 {
     bool ConditionalRun() override
     {
-        fair::mq::MessagePtr msg(NewSimpleMessage(fTimeframeId));
+        FairMQMessagePtr msg(NewSimpleMessage(fTimeframeId));
 
         if (Send(msg, "sync") > 0) {
             if (++fTimeframeId == UINT16_MAX - 1) {
@@ -37,7 +37,7 @@ struct Synchronizer : fair::mq::Device
 };
 
 void addCustomOptions(bpo::options_description& /* options */) {}
-std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& /* config */)
+std::unique_ptr<fair::mq::Device> getDevice(FairMQProgOptions& /* config */)
 {
     return std::make_unique<Synchronizer>();
 }

examples/qc/qCDispatcher.cxx

@@ -30,10 +30,10 @@ struct QCDispatcher : fair::mq::Device
         });
     }
 
-    bool HandleData(fair::mq::MessagePtr& msg, int)
+    bool HandleData(FairMQMessagePtr& msg, int)
     {
         if (fDoQC.load() == true) {
-            fair::mq::MessagePtr msgCopy(NewMessage());
+            FairMQMessagePtr msgCopy(NewMessage());
             msgCopy->Copy(*msg);
             if (Send(msg, "qc") < 0) {
                 return false;

examples/qc/qCTask.cxx

@@ -9,12 +9,12 @@
 #include <fairmq/Device.h>
 #include <fairmq/runDevice.h>
 
-class QCTask : public fair::mq::Device
+class QCTask : public FairMQDevice
 {
   public:
     QCTask()
     {
-        OnData("qc", [](fair::mq::MessagePtr& /*msg*/, int) {
+        OnData("qc", [](FairMQMessagePtr& /*msg*/, int) {
             LOG(info) << "received data";
             return false;
         });

examples/qc/sampler.cxx

@@ -16,7 +16,7 @@ struct Sampler : fair::mq::Device
 {
     bool ConditionalRun() override
     {
-        fair::mq::MessagePtr msg(NewMessage(1000));
+        FairMQMessagePtr msg(NewMessage(1000));
 
         if (Send(msg, "data1") < 0) {
             return false;

examples/qc/sink.cxx

@@ -14,7 +14,7 @@
 struct Sink : fair::mq::Device
 {
     Sink() { OnData("data2", &Sink::HandleData); }
-    bool HandleData(fair::mq::MessagePtr& /*msg*/, int /*index*/) { return true; }
+    bool HandleData(FairMQMessagePtr& /*msg*/, int /*index*/) { return true; }
 };
 
 namespace bpo = boost::program_options;

examples/readout/CMakeLists.txt

@@ -1,13 +1,59 @@
-################################################################################
-# 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"                       #
-################################################################################
+ ################################################################################
+ #    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"                       #
+ ################################################################################
 
-add_example(NAME readout
-  DEVICE readout builder processor sender receiver
-  SCRIPT readout readout-processing
-  NO_TEST
+add_executable(fairmq-ex-readout-readout readout.cxx)
+target_link_libraries(fairmq-ex-readout-readout PRIVATE FairMQ)
+
+add_executable(fairmq-ex-readout-builder builder.cxx)
+target_link_libraries(fairmq-ex-readout-builder PRIVATE FairMQ)
+
+add_executable(fairmq-ex-readout-processor processor.cxx)
+target_link_libraries(fairmq-ex-readout-processor PRIVATE FairMQ)
+
+add_executable(fairmq-ex-readout-sender sender.cxx)
+target_link_libraries(fairmq-ex-readout-sender PRIVATE FairMQ)
+
+add_executable(fairmq-ex-readout-receiver receiver.cxx)
+target_link_libraries(fairmq-ex-readout-receiver PRIVATE FairMQ)
+
+set(EX_BIN_DIR ${CMAKE_CURRENT_BINARY_DIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_BINARY_DIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-readout.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-readout.sh)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-readout-processing.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-readout-processing.sh)
+
+# install
+
+install(
+  TARGETS
+  fairmq-ex-readout-readout
+  fairmq-ex-readout-builder
+  fairmq-ex-readout-processor
+  fairmq-ex-readout-sender
+  fairmq-ex-readout-receiver
+
+  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})
+set(FAIRMQ_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-readout.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-readout.sh_install)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-readout-processing.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-readout-processing.sh_install)
+
+install(
+  PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-readout.sh_install
+  DESTINATION ${PROJECT_INSTALL_BINDIR}
+  RENAME fairmq-start-ex-readout.sh
+)
+
+install(
+  PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-readout-processing.sh_install
+  DESTINATION ${PROJECT_INSTALL_BINDIR}
+  RENAME fairmq-start-ex-readout-processing.sh
 )

examples/readout/README.md

@@ -7,19 +7,19 @@ This examples shows two possible topologies (out of many) for a node connected t
 ```
 |------------------------------- Readout Node ---------------------------|     |- Processing Node -|
 | Readout            -->            Builder          -->          Sender | --> |     Receiver      |
-| [# shared memory segment (unused in this topology) ##################] | zmq |                   |
+| [# shared memory segment (unused in this topology) ##################] | ofi |                   |
 | [# shmem unmanaged region (readout writes here, others read) ########] |     |                   |
 |------------------------------------------------------------------------|     |-------------------|
 ```
 
-The devices one the Readout Node communicate via shared memory transport. Readout device writes into shared memory unmanaged region. The data is then forwarded through Builder to Sender process, which sends it out via zeromq transport.
+The devices one the Readout Node communicate via shared memory transport. Readout device writes into shared memory unmanaged region. The data is then forwarded through Builder to Sender process, which sends it out via OFI transport.
 
 ## Setup with generating new data on the Readout node
 
 ```
 |------------------------------- Readout Node ---------------------------|     |- Processing Node -|
 | Readout     -->     Builder      -->      Processor     -->     Sender | --> |     Receiver      |
-| [# shared memory segment (used between Proccessor and Sender) #######] | zmq |                   |
+| [# shared memory segment (used between Proccessor and Sender) #######] | ofi |                   |
 | [# shmem unmanaged region (readout writes here, builder & proc read) ] |     |                   |
 |------------------------------------------------------------------------|     |-------------------|
 ```

examples/readout/builder.cxx

@@ -13,7 +13,7 @@
 
 namespace bpo = boost::program_options;
 
-class Builder : public fair::mq::Device
+class Builder : public FairMQDevice
 {
   public:
     Builder() = default;
@@ -24,7 +24,7 @@ class Builder : public fair::mq::Device
         OnData("rb", &Builder::HandleData);
     }
 
-    bool HandleData(fair::mq::MessagePtr& msg, int /*index*/)
+    bool HandleData(FairMQMessagePtr& msg, int /*index*/)
     {
         if (Send(msg, fOutputChannelName) < 0) {
             return false;

examples/readout/fairmq-start-ex-readout-processing.sh.in

@@ -31,10 +31,12 @@ SENDER="fairmq-ex-readout-sender"
 SENDER+=" --id sender1"
 SENDER+=" --input-name ps"
 SENDER+=" --channel-config name=ps,type=pair,method=bind,address=tcp://localhost:7779,transport=shmem"
+#SENDER+="                  name=sr,type=pair,method=connect,address=tcp://localhost:7780,transport=ofi"
 SENDER+="                  name=sr,type=pair,method=connect,address=tcp://localhost:7780,transport=zeromq"
 xterm -geometry 80x23+1000+0 -hold -e @EX_BIN_DIR@/$SENDER &
 
 RECEIVER="fairmq-ex-readout-receiver"
 RECEIVER+=" --id receiver1"
+#RECEIVER+=" --channel-config name=sr,type=pair,method=bind,address=tcp://localhost:7780,transport=ofi"
 RECEIVER+=" --channel-config name=sr,type=pair,method=bind,address=tcp://localhost:7780,transport=zeromq"
 xterm -geometry 80x23+1500+0 -hold -e @EX_BIN_DIR@/$RECEIVER &

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

@@ -25,10 +25,12 @@ SENDER="fairmq-ex-readout-sender"
 SENDER+=" --id sender1"
 SENDER+=" --input-name bs"
 SENDER+=" --channel-config name=bs,type=pair,method=bind,address=tcp://localhost:7778,transport=shmem"
+# SENDER+="                  name=sr,type=pair,method=connect,address=tcp://localhost:7779,transport=ofi"
 SENDER+="                  name=sr,type=pair,method=connect,address=tcp://localhost:7779,transport=zeromq"
 xterm -geometry 80x23+1000+0 -hold -e @EX_BIN_DIR@/$SENDER &
 
 RECEIVER="fairmq-ex-readout-receiver"
 RECEIVER+=" --id receiver1"
+# RECEIVER+=" --channel-config name=sr,type=pair,method=bind,address=tcp://localhost:7779,transport=ofi"
 RECEIVER+=" --channel-config name=sr,type=pair,method=bind,address=tcp://localhost:7779,transport=zeromq"
 xterm -geometry 80x23+1500+0 -hold -e @EX_BIN_DIR@/$RECEIVER &

examples/readout/processor.cxx

@@ -18,9 +18,9 @@ struct Processor : fair::mq::Device
         OnData("bp", &Processor::HandleData);
     }
 
-    bool HandleData(fair::mq::MessagePtr& msg, int /*index*/)
+    bool HandleData(FairMQMessagePtr& msg, int /*index*/)
     {
-        fair::mq::MessagePtr msg2(NewMessageFor("ps", 0, msg->GetSize()));
+        FairMQMessagePtr msg2(NewMessageFor("ps", 0, msg->GetSize()));
         if (Send(msg2, "ps") < 0) {
             return false;
         }

examples/readout/readout.cxx

@@ -22,7 +22,7 @@ struct Readout : fair::mq::Device
         fMsgSize = fConfig->GetProperty<int>("msg-size");
         fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
 
-        fRegion = fair::mq::UnmanagedRegionPtr(NewUnmanagedRegionFor("rb",
+        fRegion = FairMQUnmanagedRegionPtr(NewUnmanagedRegionFor("rb",
                                                                 0,
                                                                 10000000,
                                                                 [this](const std::vector<fair::mq::RegionBlock>& blocks) { // callback to be called when message buffers no longer needed by transport
@@ -36,7 +36,7 @@ struct Readout : fair::mq::Device
 
     bool ConditionalRun() override
     {
-        fair::mq::MessagePtr msg(NewMessageFor("rb", // channel
+        FairMQMessagePtr msg(NewMessageFor("rb", // channel
                                             0, // sub-channel
                                             fRegion, // region
                                             fRegion->GetData(), // ptr within region
@@ -71,7 +71,7 @@ struct Readout : fair::mq::Device
     int fMsgSize = 10000;
     uint64_t fMaxIterations = 0;
     uint64_t fNumIterations = 0;
-    fair::mq::UnmanagedRegionPtr fRegion = nullptr;
+    FairMQUnmanagedRegionPtr fRegion = nullptr;
     std::atomic<uint64_t> fNumUnackedMsgs = 0;
 };
 

examples/readout/receiver.cxx

@@ -26,7 +26,7 @@ struct Receiver : Device
 
     void Run() override
     {
-        Channel& dataInChannel = GetChannel("sr", 0);
+        Channel& dataInChannel = fChannels.at("sr").at(0);
 
         while (!NewStatePending()) {
             auto msg(dataInChannel.NewMessage());

examples/readout/sender.cxx

@@ -21,7 +21,7 @@ struct Sender : fair::mq::Device
         OnData(fInputChannelName, &Sender::HandleData);
     }
 
-    bool HandleData(fair::mq::MessagePtr& msg, int /*index*/)
+    bool HandleData(FairMQMessagePtr& msg, int /*index*/)
     {
         if (Send(msg, "sr") < 0) {
             return false;

examples/region/CMakeLists.txt

@@ -1,12 +1,51 @@
-################################################################################
-# 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"                       #
-################################################################################
+ ################################################################################
+ #    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"                       #
+ ################################################################################
 
-add_example(NAME region
-  DEVICE sampler processor sink keep-alive
-  SCRIPT region region-advanced region-advanced-external
+add_executable(fairmq-ex-region-sampler sampler.cxx)
+target_link_libraries(fairmq-ex-region-sampler PRIVATE FairMQ)
+
+add_executable(fairmq-ex-region-sink sink.cxx)
+target_link_libraries(fairmq-ex-region-sink PRIVATE FairMQ)
+
+add_custom_target(ExampleRegion DEPENDS fairmq-ex-region-sampler fairmq-ex-region-sink)
+
+set(EX_BIN_DIR ${CMAKE_CURRENT_BINARY_DIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_BINARY_DIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-region.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-region.sh)
+
+# test
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/test-ex-region.sh.in ${CMAKE_CURRENT_BINARY_DIR}/test-ex-region.sh)
+
+add_test(NAME Example.Region.zeromq COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-region.sh zeromq)
+set_tests_properties(Example.Region.zeromq PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received [0-9*] acks")
+
+add_test(NAME Example.Region.shmem COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-region.sh shmem)
+set_tests_properties(Example.Region.shmem PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received [0-9*] acks")
+
+# install
+
+install(
+  TARGETS
+  fairmq-ex-region-sampler
+  fairmq-ex-region-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(EX_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-region.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-region.sh_install)
+
+install(
+  PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-region.sh_install
+  DESTINATION ${PROJECT_INSTALL_BINDIR}
+  RENAME fairmq-start-ex-region.sh
 )

examples/region/fairmq-start-ex-region-advanced-external.sh.in

@@ -1,95 +0,0 @@
-#!/bin/bash
-
-export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
-
-transport=${1:-shmem}
-msgSize=${2:-1000000}
-
-SAMPLER="fairmq-ex-region-sampler"
-SAMPLER+=" --id sampler1"
-# SAMPLER+=" --sampling-rate 10"
-SAMPLER+=" --severity debug"
-SAMPLER+=" --msg-size $msgSize"
-SAMPLER+=" --transport $transport"
-SAMPLER+=" --shmid 1"
-SAMPLER+=" --shm-monitor false"
-SAMPLER+=" --rc-segment-size 200000000"
-SAMPLER+=" --external-region true"
-SAMPLER+=" --shm-no-cleanup true"
-SAMPLER+=" --chan-name data1"
-SAMPLER+=" --channel-config name=data1,type=push,method=bind,address=tcp://127.0.0.1:7777"
-xterm -geometry 90x60+0+0 -hold -e @EX_BIN_DIR@/$SAMPLER &
-
-PROCESSOR1="fairmq-ex-region-processor"
-PROCESSOR1+=" --id processor1"
-PROCESSOR1+=" --severity debug"
-PROCESSOR1+=" --transport $transport"
-PROCESSOR1+=" --shmid 1"
-PROCESSOR1+=" --shm-segment-id 1"
-PROCESSOR1+=" --shm-monitor false"
-PROCESSOR1+=" --shm-no-cleanup true"
-PROCESSOR1+=" --channel-config name=data1,type=pull,method=connect,address=tcp://127.0.0.1:7777"
-PROCESSOR1+="                  name=data2,type=push,method=bind,address=tcp://127.0.0.1:7778"
-PROCESSOR1+="                  name=data3,type=push,method=bind,address=tcp://127.0.0.1:7779"
-xterm -geometry 90x40+550+40 -hold -e @EX_BIN_DIR@/$PROCESSOR1 &
-
-PROCESSOR2="fairmq-ex-region-processor"
-PROCESSOR2+=" --id processor2"
-PROCESSOR2+=" --severity debug"
-PROCESSOR2+=" --transport $transport"
-PROCESSOR2+=" --shmid 1"
-PROCESSOR2+=" --shm-segment-id 2"
-PROCESSOR2+=" --shm-monitor false"
-PROCESSOR2+=" --shm-no-cleanup true"
-PROCESSOR2+=" --channel-config name=data1,type=pull,method=connect,address=tcp://127.0.0.1:7777"
-PROCESSOR2+="                  name=data2,type=push,method=bind,address=tcp://127.0.0.1:7788"
-PROCESSOR2+="                  name=data3,type=push,method=bind,address=tcp://127.0.0.1:7789"
-xterm -geometry 90x40+550+600 -hold -e @EX_BIN_DIR@/$PROCESSOR2 &
-
-SINK1_1="fairmq-ex-region-sink"
-SINK1_1+=" --id sink1_1"
-SINK1_1+=" --severity debug"
-SINK1_1+=" --chan-name data2"
-SINK1_1+=" --transport $transport"
-SINK1_1+=" --shmid 1"
-SINK1_1+=" --shm-segment-id 1"
-SINK1_1+=" --shm-monitor false"
-SINK1_1+=" --shm-no-cleanup true"
-SINK1_1+=" --channel-config name=data2,type=pull,method=connect,address=tcp://127.0.0.1:7778"
-xterm -geometry 90x20+1100+0 -hold -e @EX_BIN_DIR@/$SINK1_1 &
-
-SINK1_2="fairmq-ex-region-sink"
-SINK1_2+=" --id sink1_2"
-SINK1_2+=" --severity debug"
-SINK1_2+=" --chan-name data3"
-SINK1_2+=" --transport $transport"
-SINK1_2+=" --shmid 1"
-SINK1_2+=" --shm-segment-id 1"
-SINK1_2+=" --shm-monitor false"
-SINK1_2+=" --shm-no-cleanup true"
-SINK1_2+=" --channel-config name=data3,type=pull,method=connect,address=tcp://127.0.0.1:7779"
-xterm -geometry 90x20+1100+300 -hold -e @EX_BIN_DIR@/$SINK1_2 &
-
-SINK2_1="fairmq-ex-region-sink"
-SINK2_1+=" --id sink2_1"
-SINK2_1+=" --severity debug"
-SINK2_1+=" --chan-name data2"
-SINK2_1+=" --transport $transport"
-SINK2_1+=" --shmid 1"
-SINK2_1+=" --shm-segment-id 2"
-SINK2_1+=" --shm-monitor false"
-SINK2_1+=" --shm-no-cleanup true"
-SINK2_1+=" --channel-config name=data2,type=pull,method=connect,address=tcp://127.0.0.1:7788"
-xterm -geometry 90x20+1100+600 -hold -e @EX_BIN_DIR@/$SINK2_1 &
-
-SINK2_2="fairmq-ex-region-sink"
-SINK2_2+=" --id sink2_2"
-SINK2_2+=" --severity debug"
-SINK2_2+=" --chan-name data3"
-SINK2_2+=" --transport $transport"
-SINK2_2+=" --shmid 1"
-SINK2_2+=" --shm-segment-id 2"
-SINK2_2+=" --shm-monitor false"
-SINK2_2+=" --shm-no-cleanup true"
-SINK2_2+=" --channel-config name=data3,type=pull,method=connect,address=tcp://127.0.0.1:7789"
-xterm -geometry 90x20+1100+900 -hold -e @EX_BIN_DIR@/$SINK2_2 &

examples/region/fairmq-start-ex-region-advanced.sh.in

@@ -1,80 +0,0 @@
-#!/bin/bash
-
-export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
-
-transport=${1:-shmem}
-msgSize=${2:-1000000}
-
-SAMPLER="fairmq-ex-region-sampler"
-SAMPLER+=" --id sampler1"
-# SAMPLER+=" --sampling-rate 10"
-SAMPLER+=" --severity debug"
-SAMPLER+=" --msg-size $msgSize"
-SAMPLER+=" --transport $transport"
-#SAMPLER+=" --rc-segment-size 0"
-SAMPLER+=" --shm-monitor true"
-SAMPLER+=" --chan-name data1"
-SAMPLER+=" --channel-config name=data1,type=push,method=bind,address=tcp://127.0.0.1:7777"
-xterm -geometry 90x60+0+0 -hold -e @EX_BIN_DIR@/$SAMPLER &
-
-PROCESSOR1="fairmq-ex-region-processor"
-PROCESSOR1+=" --id processor1"
-PROCESSOR1+=" --severity debug"
-PROCESSOR1+=" --transport $transport"
-PROCESSOR1+=" --shm-segment-id 1"
-PROCESSOR1+=" --shm-monitor true"
-PROCESSOR1+=" --channel-config name=data1,type=pull,method=connect,address=tcp://127.0.0.1:7777"
-PROCESSOR1+="                  name=data2,type=push,method=bind,address=tcp://127.0.0.1:7778"
-PROCESSOR1+="                  name=data3,type=push,method=bind,address=tcp://127.0.0.1:7779"
-xterm -geometry 90x40+550+40 -hold -e @EX_BIN_DIR@/$PROCESSOR1 &
-
-PROCESSOR2="fairmq-ex-region-processor"
-PROCESSOR2+=" --id processor2"
-PROCESSOR2+=" --severity debug"
-PROCESSOR2+=" --transport $transport"
-PROCESSOR2+=" --shm-segment-id 2"
-PROCESSOR2+=" --shm-monitor true"
-PROCESSOR2+=" --channel-config name=data1,type=pull,method=connect,address=tcp://127.0.0.1:7777"
-PROCESSOR2+="                  name=data2,type=push,method=bind,address=tcp://127.0.0.1:7788"
-PROCESSOR2+="                  name=data3,type=push,method=bind,address=tcp://127.0.0.1:7789"
-xterm -geometry 90x40+550+600 -hold -e @EX_BIN_DIR@/$PROCESSOR2 &
-
-SINK1_1="fairmq-ex-region-sink"
-SINK1_1+=" --id sink1_1"
-SINK1_1+=" --severity debug"
-SINK1_1+=" --chan-name data2"
-SINK1_1+=" --transport $transport"
-SINK1_1+=" --shm-segment-id 1"
-SINK1_1+=" --shm-monitor true"
-SINK1_1+=" --channel-config name=data2,type=pull,method=connect,address=tcp://127.0.0.1:7778"
-xterm -geometry 90x20+1100+0 -hold -e @EX_BIN_DIR@/$SINK1_1 &
-
-SINK1_2="fairmq-ex-region-sink"
-SINK1_2+=" --id sink1_2"
-SINK1_2+=" --severity debug"
-SINK1_2+=" --chan-name data3"
-SINK1_2+=" --transport $transport"
-SINK1_2+=" --shm-segment-id 1"
-SINK1_2+=" --shm-monitor true"
-SINK1_2+=" --channel-config name=data3,type=pull,method=connect,address=tcp://127.0.0.1:7779"
-xterm -geometry 90x20+1100+300 -hold -e @EX_BIN_DIR@/$SINK1_2 &
-
-SINK2_1="fairmq-ex-region-sink"
-SINK2_1+=" --id sink2_1"
-SINK2_1+=" --severity debug"
-SINK2_1+=" --chan-name data2"
-SINK2_1+=" --transport $transport"
-SINK2_1+=" --shm-segment-id 2"
-SINK2_1+=" --shm-monitor true"
-SINK2_1+=" --channel-config name=data2,type=pull,method=connect,address=tcp://127.0.0.1:7788"
-xterm -geometry 90x20+1100+600 -hold -e @EX_BIN_DIR@/$SINK2_1 &
-
-SINK2_2="fairmq-ex-region-sink"
-SINK2_2+=" --id sink2_2"
-SINK2_2+=" --severity debug"
-SINK2_2+=" --chan-name data3"
-SINK2_2+=" --transport $transport"
-SINK2_2+=" --shm-segment-id 2"
-SINK2_2+=" --shm-monitor true"
-SINK2_2+=" --channel-config name=data3,type=pull,method=connect,address=tcp://127.0.0.1:7789"
-xterm -geometry 90x20+1100+900 -hold -e @EX_BIN_DIR@/$SINK2_2 &

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

@@ -2,8 +2,16 @@
 
 export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
 
-transport=${1:-shmem}
-msgSize=${2:-1000000}
+transport="shmem"
+msgSize="1000000"
+
+if [[ $1 =~ ^[a-z]+$ ]]; then
+    transport=$1
+fi
+
+if [[ $2 =~ ^[0-9]+$ ]]; then
+    msgSize=$1
+fi
 
 SAMPLER="fairmq-ex-region-sampler"
 SAMPLER+=" --id sampler1"
@@ -11,10 +19,6 @@ SAMPLER+=" --severity debug"
 SAMPLER+=" --msg-size $msgSize"
 # SAMPLER+=" --rate 10"
 SAMPLER+=" --transport $transport"
-# SAMPLER+=" --external-region true"
-# SAMPLER+=" --shm-no-cleaup true"
-SAMPLER+=" --shm-monitor true"
-# SAMPLER+=" --shmid 1"
 SAMPLER+=" --channel-config name=data,type=push,method=bind,address=tcp://127.0.0.1:7777,sndKernelSize=212992"
 xterm -geometry 120x60+0+0 -hold -e @EX_BIN_DIR@/$SAMPLER &
 
@@ -22,8 +26,5 @@ SINK="fairmq-ex-region-sink"
 SINK+=" --id sink1"
 SINK+=" --severity debug"
 SINK+=" --transport $transport"
-# SINK+=" --shm-no-cleaup true"
-SINK+=" --shm-monitor true"
-# SINK+=" --shmid 1"
 SINK+=" --channel-config name=data,type=pull,method=connect,address=tcp://127.0.0.1:7777,rcvKernelSize=212992"
 xterm -geometry 120x60+750+0 -hold -e @EX_BIN_DIR@/$SINK &

examples/region/keep-alive.cxx

@@ -1,226 +0,0 @@
-/********************************************************************************
- *    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 <fairmq/shmem/Common.h>
-#include <fairmq/shmem/Monitor.h>
-#include <fairmq/shmem/Segment.h>
-#include <fairmq/shmem/UnmanagedRegion.h>
-#include <fairmq/tools/Unique.h>
-
-#include <fairlogger/Logger.h>
-
-#include <boost/algorithm/string.hpp>
-#include <boost/program_options.hpp>
-
-#include <chrono>
-#include <csignal>
-#include <map>
-#include <mutex>
-#include <string>
-#include <thread>
-
-using namespace std;
-using namespace boost::program_options;
-
-namespace {
-volatile sig_atomic_t gStopping = 0;
-volatile sig_atomic_t gResetContent = 0;
-}   // namespace
-
-void signalHandler(int /* signal */) { gStopping = 1; }
-
-void resetContentHandler(int /* signal */) { gResetContent = 1; }
-
-struct ShmManager
-{
-    ShmManager(uint64_t _shmId, const vector<string>& _segments, const vector<string>& _regions, bool zero = true)
-        : shmId(fair::mq::shmem::makeShmIdStr(_shmId))
-    {
-        LOG(info) << "Starting ShmManager for shmId: " << shmId;
-        LOG(info) << "Performing full reset...";
-        FullReset();
-        LOG(info) << "Done.";
-        LOG(info) << "Adding managed segments...";
-        AddSegments(_segments, zero);
-        LOG(info) << "Done.";
-        LOG(info) << "Adding unmanaged regions...";
-        AddRegions(_regions, zero);
-        LOG(info) << "Done.";
-        LOG(info) << "Shared memory is ready for use.";
-    }
-
-    void AddSegments(const vector<string>& _segments, bool zero)
-    {
-        for (const auto& s : _segments) {
-            vector<string> conf;
-            boost::algorithm::split(conf, s, boost::algorithm::is_any_of(","));
-            if (conf.size() != 3) {
-                LOG(error) << "incorrect format for --segments. Expecting pairs of <id>,<size><numaid>.";
-                fair::mq::shmem::Monitor::Cleanup(fair::mq::shmem::ShmId{shmId});
-                throw runtime_error("incorrect format for --segments. Expecting pairs of <id>,<size>,<numaid>.");
-            }
-            uint16_t id = stoi(conf.at(0));
-            uint64_t size = stoull(conf.at(1));
-            segmentCfgs.emplace_back(fair::mq::shmem::SegmentConfig{id, size, "rbtree_best_fit"});
-
-            auto ret = segments.emplace(id, fair::mq::shmem::Segment(shmId, id, size, fair::mq::shmem::rbTreeBestFit));
-            fair::mq::shmem::Segment& segment = ret.first->second;
-            LOG(info) << "Created segment " << id << " of size " << segment.GetSize()
-                      << ", starting at " << segment.GetData() << ". Locking...";
-            segment.Lock();
-            LOG(info) << "Done.";
-            if (zero) {
-                LOG(info) << "Zeroing...";
-                segment.Zero();
-                LOG(info) << "Done.";
-            }
-        }
-    }
-
-    void AddRegions(const vector<string>& _regions, bool zero)
-    {
-        for (const auto& r : _regions) {
-            vector<string> conf;
-            boost::algorithm::split(conf, r, boost::algorithm::is_any_of(","));
-            if (conf.size() != 3) {
-                LOG(error) << "incorrect format for --regions. Expecting pairs of <id>,<size>,<numaid>.";
-                fair::mq::shmem::Monitor::Cleanup(fair::mq::shmem::ShmId{shmId});
-                throw runtime_error("incorrect format for --regions. Expecting pairs of <id>,<size>,<numaid>.");
-            }
-            uint16_t id = stoi(conf.at(0));
-            uint64_t size = stoull(conf.at(1));
-            fair::mq::RegionConfig cfg;
-            cfg.id = id;
-            cfg.rcSegmentSize = 0;
-            cfg.size = size;
-            regionCfgs.push_back(cfg);
-
-            auto ret = regions.emplace(id, make_unique<fair::mq::shmem::UnmanagedRegion>(shmId, cfg));
-            fair::mq::shmem::UnmanagedRegion& region = *(ret.first->second);
-            LOG(info) << "Created unamanged region " << id << " of size " << region.GetSize()
-                      << ", starting at " << region.GetData() << ". Locking...";
-            region.Lock();
-            LOG(info) << "Done.";
-            if (zero) {
-                LOG(info) << "Zeroing...";
-                region.Zero();
-                LOG(info) << "Done.";
-            }
-        }
-    }
-
-    bool CheckPresence()
-    {
-        std::lock_guard<std::mutex> lock(localMtx);
-        for (const auto& sc : segmentCfgs) {
-            if (!(fair::mq::shmem::Monitor::SegmentIsPresent(fair::mq::shmem::ShmId{shmId}, sc.id))) {
-                return false;
-            }
-        }
-        for (const auto& rc : regionCfgs) {
-            if (!(fair::mq::shmem::Monitor::RegionIsPresent(fair::mq::shmem::ShmId{shmId}, rc.id.value()))) {
-                return false;
-            }
-        }
-        return true;
-    }
-
-    void ResetContent()
-    {
-        std::lock_guard<std::mutex> lock(localMtx);
-        fair::mq::shmem::Monitor::ResetContent(fair::mq::shmem::ShmId{shmId}, segmentCfgs, regionCfgs);
-    }
-
-    void FullReset()
-    {
-        segments.clear();
-        regions.clear();
-        fair::mq::shmem::Monitor::Cleanup(fair::mq::shmem::ShmId{shmId});
-    }
-
-    ~ShmManager()
-    {
-        // clean all segments, regions and any other shmem objects belonging to this shmId
-        fair::mq::shmem::Monitor::Cleanup(fair::mq::shmem::ShmId{shmId});
-    }
-
-    std::string shmId;
-    std::mutex localMtx;
-    map<uint16_t, fair::mq::shmem::Segment> segments;
-    map<uint16_t, unique_ptr<fair::mq::shmem::UnmanagedRegion>> regions;
-    std::vector<fair::mq::shmem::SegmentConfig> segmentCfgs;
-    std::vector<fair::mq::RegionConfig> regionCfgs;
-};
-
-int main(int argc, char** argv)
-{
-    fair::Logger::SetConsoleColor(true);
-
-    signal(SIGINT, signalHandler);
-    signal(SIGTERM, signalHandler);
-    signal(SIGUSR1, resetContentHandler);
-
-    try {
-        bool nozero = false;
-        bool checkPresence = true;
-        uint64_t shmId = 0;
-        vector<string> segments;
-        vector<string> regions;
-
-        options_description desc("Options");
-        desc.add_options()
-            ("shmid", value<uint64_t>(&shmId)->required(), "Shm id")
-            ("segments", value<vector<string>>(&segments)->multitoken()->composing(), "Segments, as <id>,<size>,<numaid> <id>,<size>,<numaid> <id>,<size>,<numaid> ... (numaid: -2 disabled, -1 interleave, >=0 node)")
-            ("regions", value<vector<string>>(&regions)->multitoken()->composing(), "Regions, as <id>,<size> <id>,<size>,<numaid> <id>,<size>,<numaid> ...")
-            ("nozero", value<bool>(&nozero)->default_value(false)->implicit_value(true), "Do not zero segments after initialization")
-            ("check-presence", value<bool>(&checkPresence)->default_value(true)->implicit_value(true), "Check periodically if configured segments/regions are still present, and cleanup and leave if they are not")
-            ("help,h", "Print help");
-
-        variables_map vm;
-        store(parse_command_line(argc, argv, desc), vm);
-
-        if (vm.count("help")) {
-            LOG(info) << "ShmManager" << "\n" << desc;
-            return 0;
-        }
-
-        notify(vm);
-
-        ShmManager shmManager(shmId, segments, regions, !nozero);
-
-        std::thread resetContentThread([&shmManager]() {
-            while (!gStopping) {
-                std::this_thread::sleep_for(std::chrono::milliseconds(50));
-                if (gResetContent == 1) {
-                    LOG(info) << "Resetting content for shmId " << shmManager.shmId;
-                    shmManager.ResetContent();
-                    gResetContent = 0;
-                    LOG(info) << "Done resetting content for shmId " << shmManager.shmId;
-                }
-            }
-        });
-
-        if (checkPresence) {
-            while (!gStopping) {
-                if (shmManager.CheckPresence() == false) {
-                    LOG(error) << "Failed to find segments, exiting.";
-                    gStopping = true;
-                }
-                std::this_thread::sleep_for(std::chrono::milliseconds(500));
-            }
-        }
-
-        resetContentThread.join();
-
-        LOG(info) << "stopping.";
-    } catch (exception& e) {
-        LOG(error) << "Exception reached the top of main: " << e.what() << ", exiting";
-        return 2;
-    }
-
-    return 0;
-}

examples/region/processor.cxx

@@ -1,80 +0,0 @@
-/********************************************************************************
- * Copyright (C) 2014-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 <fairmq/Device.h>
-#include <fairmq/runDevice.h>
-#include <memory>
-
-namespace bpo = boost::program_options;
-using namespace std;
-using namespace fair::mq;
-
-namespace {
-
-struct Processor : Device
-{
-    void InitTask() override
-    {
-        fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
-        GetChannel("data1", 0).Transport()->SubscribeToRegionEvents([](RegionInfo info) {
-            LOG(info) << "Region event: " << info.event << ": "
-                      << (info.managed ? "managed" : "unmanaged") << ", id: " << info.id
-                      << ", ptr: " << info.ptr << ", size: " << info.size
-                      << ", flags: " << info.flags;
-        });
-    }
-
-    void Run() override
-    {
-        Channel& dataIn = GetChannel("data1", 0);
-        Channel& dataOut1 = GetChannel("data2", 0);
-        Channel& dataOut2 = GetChannel("data3", 0);
-
-        while (!NewStatePending()) {
-            fair::mq::Parts inParts;
-            dataIn.Receive(inParts);
-
-            fair::mq::Parts outParts1;
-            fair::mq::Parts outParts2;
-
-            for (const auto& inPart : inParts) {
-                outParts1.AddPart(NewMessage());
-                outParts1.fParts.back()->Copy(*inPart);
-
-                outParts2.AddPart(NewMessage());
-                outParts2.fParts.back()->Copy(*inPart);
-            }
-
-            dataOut1.Send(outParts1);
-            dataOut2.Send(outParts2);
-
-            if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations) {
-                LOG(info) << "Configured max number of iterations reached. Leaving RUNNING state.";
-                break;
-            }
-        }
-    }
-
-    void ResetTask() override
-    {
-        GetChannel("data1", 0).Transport()->UnsubscribeFromRegionEvents();
-    }
-
-  private:
-    uint64_t fMaxIterations = 0;
-    uint64_t fNumIterations = 0;
-};
-
-}   // namespace
-
-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)");
-}
-
-unique_ptr<Device> getDevice(ProgOptions& /*config*/) { return make_unique<Processor>(); }

examples/region/sampler.cxx

@@ -8,7 +8,6 @@
 
 #include <fairmq/Device.h>
 #include <fairmq/runDevice.h>
-#include <fairmq/tools/RateLimit.h>
 
 #include <cstdint>
 #include <mutex>
@@ -20,15 +19,11 @@ struct Sampler : fair::mq::Device
 {
     void InitTask() override
     {
-        fExternalRegion = fConfig->GetProperty<bool>("external-region");
         fMsgSize = fConfig->GetProperty<int>("msg-size");
         fLinger = fConfig->GetProperty<uint32_t>("region-linger");
         fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
-        fChanName = fConfig->GetProperty<std::string>("chan-name");
-        fSamplingRate = fConfig->GetProperty<float>("sampling-rate");
-        fRCSegmentSize = fConfig->GetProperty<uint64_t>("rc-segment-size");
 
-        GetChannel(fChanName, 0).Transport()->SubscribeToRegionEvents([](fair::mq::RegionInfo info) {
+        fChannels.at("data").at(0).Transport()->SubscribeToRegionEvents([](FairMQRegionInfo info) {
             LOG(info) << "Region event: " << info.event << ": "
                     << (info.managed ? "managed" : "unmanaged")
                     << ", id: " << info.id
@@ -37,111 +32,80 @@ struct Sampler : fair::mq::Device
                     << ", flags: " << info.flags;
         });
 
-        fair::mq::RegionConfig regionCfg;
-        regionCfg.linger = fLinger; // delay in ms before region destruction to collect outstanding events
-        // options for testing with an externally-created -region
-        if (fExternalRegion) {
-            regionCfg.id = 1;
-            regionCfg.removeOnDestruction = false;
-        }
-        regionCfg.lock = !fExternalRegion; // mlock region after creation
-        regionCfg.zero = !fExternalRegion; // zero region content after creation
-        regionCfg.rcSegmentSize = fRCSegmentSize; // size of the corresponding reference count segment
-        fRegion = fair::mq::UnmanagedRegionPtr(NewUnmanagedRegionFor(
-            fChanName, // region is created using the transport of this channel...
-            0,      // ... and this sub-channel
-            10000000, // region size
-            [this](const std::vector<fair::mq::RegionBlock>& blocks) { // callback to be called when message buffers no longer needed by transport
-                std::lock_guard<std::mutex> lock(fMtx);
-                fNumUnackedMsgs -= blocks.size();
-                if (fMaxIterations > 0) {
-                    LOG(info) << "Received " << blocks.size() << " acks";
-                }
-            },
-            regionCfg
-        ));
+        fRegion = FairMQUnmanagedRegionPtr(NewUnmanagedRegionFor("data", // region is created using the transport of this channel...
+                                                                0,      // ... and this sub-channel
+                                                                10000000, // region size
+                                                                [this](const std::vector<fair::mq::RegionBlock>& blocks) { // callback to be called when message buffers no longer needed by transport
+                                                                    std::lock_guard<std::mutex> lock(fMtx);
+                                                                    fNumUnackedMsgs -= blocks.size();
+
+                                                                    if (fMaxIterations > 0) {
+                                                                        LOG(info) << "Received " << blocks.size() << " acks";
+                                                                    }
+                                                                },
+                                                                "", // path, if a region is backed by a file
+                                                                0,  // flags that are passed for region creation
+                                                                fair::mq::RegionConfig{true, true} // additional config: { call mlock on the region, zero the region memory }
+                                                                ));
+        fRegion->SetLinger(fLinger);
     }
 
-    void Run() override
+    bool ConditionalRun() override
     {
+        FairMQMessagePtr msg(NewMessageFor("data", // channel
+                                            0, // sub-channel
+                                            fRegion, // region
+                                            fRegion->GetData(), // ptr within region
+                                            fMsgSize, // offset from ptr
+                                            nullptr // hint
+                                            ));
 
-        fair::mq::tools::RateLimiter rateLimiter(fSamplingRate);
+        // static_cast<char*>(fRegion->GetData())[3] = 97;
+        // LOG(info) << "check: " << static_cast<char*>(fRegion->GetData())[3];
+        // std::this_thread::sleep_for(std::chrono::seconds(1));
 
-        while (!NewStatePending()) {
-            fair::mq::Parts parts;
-            // make 64 parts
-            for (int i = 0; i < 64; ++i) {
-                parts.AddPart(NewMessageFor(
-                    fChanName, // channel
-                    0, // sub-channel
-                    fRegion, // region
-                    fRegion->GetData(), // ptr within region
-                    fMsgSize, // offset from ptr
-                    nullptr // hint
-                    ));
-            }
-
-            std::lock_guard<std::mutex> lock(fMtx);
-            fNumUnackedMsgs += parts.Size();
-            if (Send(parts, fChanName, 0) > 0) {
-                if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations) {
-                    LOG(info) << "Configured maximum number of iterations reached. Stopping sending.";
-                    break;
-                }
-                if (fSamplingRate > 0.001) {
-                    rateLimiter.maybe_sleep();
-                }
+        std::lock_guard<std::mutex> lock(fMtx);
+        ++fNumUnackedMsgs;
+        if (Send(msg, "data", 0) > 0) {
+            if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations) {
+                LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+                return false;
             }
         }
 
-        // wait for all acks to arrive
-        while (!NewStatePending()) {
-            {
-                std::lock_guard<std::mutex> lock(fMtx);
-                if (fNumUnackedMsgs == 0) {
-                    break;
-                }
-            }
-            std::this_thread::sleep_for(std::chrono::milliseconds(25));
-        }
-
-        if (fNumUnackedMsgs != 0) {
-            LOG(info) << "Done, still not acknowledged: " << fNumUnackedMsgs;
-        } else {
-            LOG(info) << "All acknowledgements received.";
-        }
+        return true;
     }
 
     void ResetTask() override
     {
         fRegion.reset();
-        GetChannel(fChanName, 0).Transport()->UnsubscribeFromRegionEvents();
+        {
+            std::lock_guard<std::mutex> lock(fMtx);
+            if (fNumUnackedMsgs != 0) {
+                LOG(info) << "Done, still not acknowledged: " << fNumUnackedMsgs;
+            } else {
+                LOG(info) << "All acknowledgements received.";
+            }
+        }
+        fChannels.at("data").at(0).Transport()->UnsubscribeFromRegionEvents();
     }
 
   private:
-    int fExternalRegion = false;
     int fMsgSize = 10000;
     uint32_t fLinger = 100;
     uint64_t fMaxIterations = 0;
     uint64_t fNumIterations = 0;
-    uint64_t fRCSegmentSize = 10000000;
-    fair::mq::UnmanagedRegionPtr fRegion = nullptr;
+    FairMQUnmanagedRegionPtr fRegion = nullptr;
     std::mutex fMtx;
     uint64_t fNumUnackedMsgs = 0;
-    std::string fChanName;
-    float fSamplingRate = 0.;
 };
 
 void addCustomOptions(bpo::options_description& options)
 {
     options.add_options()
-        ("chan-name", bpo::value<std::string>()->default_value("data"), "name of the output channel")
         ("msg-size", bpo::value<int>()->default_value(1000), "Message size in bytes")
-        ("sampling-rate", bpo::value<float>()->default_value(0.), "Sampling rate (Hz).")
         ("region-linger", bpo::value<uint32_t>()->default_value(100), "Linger period for regions")
-        ("max-iterations", bpo::value<uint64_t>()->default_value(0), "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)")
-        ("external-region", bpo::value<bool>()->default_value(false), "Use region created by another process")
-        ("rc-segment-size", bpo::value<uint64_t>()->default_value(10000000), "Size of the reference count segment for Unamanged Region");
+        ("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*/)

examples/region/sink.cxx

@@ -22,8 +22,7 @@ struct Sink : Device
     {
         // Get the fMaxIterations value from the command line options (via fConfig)
         fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
-        fChanName = fConfig->GetProperty<std::string>("chan-name");
-        GetChannel(fChanName, 0).Transport()->SubscribeToRegionEvents([](RegionInfo info) {
+        fChannels.at("data").at(0).Transport()->SubscribeToRegionEvents([](RegionInfo info) {
             LOG(info) << "Region event: " << info.event << ": "
                       << (info.managed ? "managed" : "unmanaged") << ", id: " << info.id
                       << ", ptr: " << info.ptr << ", size: " << info.size
@@ -33,11 +32,15 @@ struct Sink : Device
 
     void Run() override
     {
-        Channel& dataIn = GetChannel(fChanName, 0);
+        Channel& dataInChannel = fChannels.at("data").at(0);
 
         while (!NewStatePending()) {
-            fair::mq::Parts parts;
-            dataIn.Receive(parts);
+            auto msg(dataInChannel.Transport()->CreateMessage());
+            dataInChannel.Receive(msg);
+
+            // void* ptr = msg->GetData();
+            // char* cptr = static_cast<char*>(ptr);
+            // LOG(info) << "check: " << cptr[3];
 
             if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations) {
                 LOG(info) << "Configured max number of iterations reached. Leaving RUNNING state.";
@@ -48,22 +51,22 @@ struct Sink : Device
 
     void ResetTask() override
     {
-        GetChannel(fChanName, 0).Transport()->UnsubscribeFromRegionEvents();
+        fChannels.at("data").at(0).Transport()->UnsubscribeFromRegionEvents();
     }
 
   private:
     uint64_t fMaxIterations = 0;
     uint64_t fNumIterations = 0;
-    std::string fChanName;
 };
 
 }   // namespace
 
 void addCustomOptions(bpo::options_description& options)
 {
-    options.add_options()
-        ("chan-name", bpo::value<std::string>()->default_value("data"), "name of the input channel")
-        ("max-iterations", bpo::value<uint64_t>()->default_value(0), "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)");
+    options.add_options()(
+        "max-iterations",
+        bpo::value<uint64_t>()->default_value(0),
+        "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)");
 }
 
 unique_ptr<Device> getDevice(ProgOptions& /*config*/) { return make_unique<Sink>(); }

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

@@ -1,7 +1,5 @@
 #!/bin/bash
 
-set -e
-
 export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
 
 transport="zeromq"
@@ -11,26 +9,22 @@ if [[ $1 =~ ^[a-z]+$ ]]; then
 fi
 
 msgSize="1000000"
-session="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
-chan="data"
-chanAddr="/tmp/fmq_$session""_""$chan""_""$transport"
+SESSION="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
 
 # 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; @CMAKE_BINARY_DIR@/fairmq/fairmq-shmmonitor --cleanup --session $SESSION; rm $chanAddr; exit 0' TERM
+trap 'kill -TERM $SAMPLER_PID; kill -TERM $SINK_PID; wait $SAMPLER_PID; wait $SINK_PID; @CMAKE_BINARY_DIR@/fairmq/fairmq-shmmonitor --cleanup --session $SESSION' TERM
 
 SAMPLER="fairmq-ex-region-sampler"
 SAMPLER+=" --id sampler1"
 SAMPLER+=" --transport $transport"
 SAMPLER+=" --severity debug"
-SAMPLER+=" --session $session"
-SAMPLER+=" --shm-segment-size 100000000"
-SAMPLER+=" --shm-monitor true"
+SAMPLER+=" --session $SESSION"
 SAMPLER+=" --verbosity veryhigh"
 SAMPLER+=" --control static --color false"
 SAMPLER+=" --max-iterations 1"
 SAMPLER+=" --msg-size $msgSize"
 SAMPLER+=" --region-linger 500"
-SAMPLER+=" --channel-config name=$chan,type=push,method=bind,address=ipc://$chanAddr"
+SAMPLER+=" --channel-config name=data,type=push,method=bind,address=tcp://127.0.0.1:7777"
 @CMAKE_CURRENT_BINARY_DIR@/$SAMPLER &
 SAMPLER_PID=$!
 
@@ -38,20 +32,14 @@ SINK="fairmq-ex-region-sink"
 SINK+=" --id sink1"
 SINK+=" --transport $transport"
 SINK+=" --severity debug"
-SINK+=" --session $session"
-SINK+=" --shm-segment-size 100000000"
-SINK+=" --shm-monitor true"
+SINK+=" --session $SESSION"
 SINK+=" --verbosity veryhigh"
 SINK+=" --control static --color false"
 SINK+=" --max-iterations 1"
-SINK+=" --channel-config name=$chan,type=pull,method=connect,address=ipc://$chanAddr"
+SINK+=" --channel-config name=data,type=pull,method=connect,address=tcp://127.0.0.1:7777"
 @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/req-rep/CMakeLists.txt

@@ -1,11 +1,52 @@
-################################################################################
-# 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"                       #
-################################################################################
+ ################################################################################
+ #    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"                       #
+ ################################################################################
 
-add_example(NAME req-rep
-  DEVICE client server
+add_executable(fairmq-ex-req-rep-client client.cxx)
+target_link_libraries(fairmq-ex-req-rep-client PRIVATE FairMQ)
+
+
+add_executable(fairmq-ex-req-rep-server server.cxx)
+target_link_libraries(fairmq-ex-req-rep-server PRIVATE FairMQ)
+
+add_custom_target(ExampleReqRep DEPENDS fairmq-ex-req-rep-client fairmq-ex-req-rep-server)
+
+set(EX_BIN_DIR ${CMAKE_CURRENT_BINARY_DIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_BINARY_DIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-req-rep.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-req-rep.sh)
+
+# test
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/test-ex-req-rep.sh.in ${CMAKE_CURRENT_BINARY_DIR}/test-ex-req-rep.sh)
+
+add_test(NAME Example.ReqRep.zeromq COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-req-rep.sh zeromq)
+set_tests_properties(Example.ReqRep.zeromq PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received reply from server: ")
+
+add_test(NAME Example.ReqRep.shmem COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-req-rep.sh shmem)
+set_tests_properties(Example.ReqRep.shmem PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received reply from server: ")
+
+# install
+
+install(
+  TARGETS
+  fairmq-ex-req-rep-client
+  fairmq-ex-req-rep-server
+
+  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})
+set(FAIRMQ_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-req-rep.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-req-rep.sh_install)
+
+install(
+  PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-req-rep.sh_install
+  DESTINATION ${PROJECT_INSTALL_BINDIR}
+  RENAME fairmq-start-ex-req-rep.sh
 )

examples/req-rep/client.cxx

@@ -32,11 +32,11 @@ struct Client : fair::mq::Device
         // its size,
         // custom deletion function (called when transfer is done),
         // and pointer to the object managing the data buffer
-        fair::mq::MessagePtr req(NewMessage(const_cast<char*>(text->c_str()), // data
+        FairMQMessagePtr req(NewMessage(const_cast<char*>(text->c_str()), // data
                                                             text->length(), // size
                                                             [](void* /*data*/, void* object) { delete static_cast<std::string*>(object); }, // deletion callback
                                                             text)); // object that manages the data
-        fair::mq::MessagePtr rep(NewMessage());
+        FairMQMessagePtr rep(NewMessage());
 
         LOG(info) << "Sending \"" << fText << "\" to server.";
 

examples/req-rep/server.cxx

@@ -26,7 +26,7 @@ struct Server : fair::mq::Device
         fMaxIterations = fConfig->GetProperty<uint64_t>("max-iterations");
     }
 
-    bool HandleData(fair::mq::MessagePtr& req, int)
+    bool HandleData(FairMQMessagePtr& req, int)
     {
         LOG(info) << "Received request from client: \"" << std::string(static_cast<char*>(req->GetData()), req->GetSize()) << "\"";
 
@@ -34,7 +34,7 @@ struct Server : fair::mq::Device
 
         LOG(info) << "Sending reply to client.";
 
-        fair::mq::MessagePtr rep(NewMessage(const_cast<char*>(text->c_str()), // data
+        FairMQMessagePtr rep(NewMessage(const_cast<char*>(text->c_str()), // data
                                                             text->length(), // size
                                                             [](void* /*data*/, void* object) { delete static_cast<std::string*>(object); }, // deletion callback
                                                             text)); // object that manages the data

examples/req-rep/test-ex-req-rep.sh.in

@@ -1,7 +1,5 @@
 #!/bin/bash
 
-set -e
-
 export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
 
 transport="zeromq"
@@ -10,23 +8,19 @@ 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"
+SESSION="$(@CMAKE_BINARY_DIR@/fairmq/fairmq-uuid-gen -h)"
 
 # setup a trap to kill everything if the test fails/timeouts
-trap 'set +e; kill -TERM $CLIENT_PID; kill -TERM $SERVER_PID; wait $CLIENT_PID; wait $SERVER_PID; rm $chanAddr; exit 0' TERM
+trap 'kill -TERM $CLIENT_PID; kill -TERM $SERVER_PID; wait $CLIENT_PID; wait $SERVER_PID;' TERM
 
 CLIENT="fairmq-ex-req-rep-client"
 CLIENT+=" --id client"
 CLIENT+=" --transport $transport"
 CLIENT+=" --verbosity veryhigh"
-CLIENT+=" --session $session"
-CLIENT+=" --shm-segment-size 100000000"
-CLIENT+=" --shm-monitor true"
+CLIENT+=" --session $SESSION"
 CLIENT+=" --control static --color false"
 CLIENT+=" --max-iterations 1"
-CLIENT+=" --channel-config name=$chan,type=req,method=connect,rateLogging=0,address=ipc://$chanAddr"
+CLIENT+=" --channel-config name=data,type=req,method=connect,rateLogging=0,address=tcp://127.0.0.1:5005"
 @CMAKE_CURRENT_BINARY_DIR@/$CLIENT &
 CLIENT_PID=$!
 
@@ -34,19 +28,13 @@ SERVER="fairmq-ex-req-rep-server"
 SERVER+=" --id server"
 SERVER+=" --transport $transport"
 SERVER+=" --verbosity veryhigh"
-SERVER+=" --session $session"
-SERVER+=" --shm-segment-size 100000000"
-SERVER+=" --shm-monitor true"
+SERVER+=" --session $SESSION"
 SERVER+=" --control static --color false"
 SERVER+=" --max-iterations 1"
-SERVER+=" --channel-config name=$chan,type=rep,method=bind,rateLogging=0,address=ipc://$chanAddr"
+SERVER+=" --channel-config name=data,type=rep,method=bind,rateLogging=0,address=tcp://127.0.0.1:5005"
 @CMAKE_CURRENT_BINARY_DIR@/$SERVER &
 SERVER_PID=$!
 
 # wait for everything to finish
 wait $CLIENT_PID
 wait $SERVER_PID
-
-set +e
-rm $chanAddr
-exit 0

extern/googletest

@@ -1 +1 @@
-Subproject commit 7d76a231b0e29caf86e68d1df858308cd53b2a66
+Subproject commit f5e592d8ee5ffb1d9af5be7f715ce3576b8bf9c4

fairmq/CMakeLists.txt

@@ -1,12 +1,12 @@
 ################################################################################
-# Copyright (C) 2012-2025 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  #
+# Copyright (C) 2012-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"                       #
 ################################################################################
 
-if(BUILD_FAIRMQ)
+if(BUILD_FAIRMQ OR BUILD_SDK)
 
   if(BUILD_TIDY_TOOL)
     include(FairMQTidy)
@@ -23,6 +23,133 @@ if(BUILD_FAIRMQ)
     DESTINATION ${PROJECT_INSTALL_INCDIR}
   )
 
+  #########
+  # Tools #
+  #########
+  set(target Tools)
+
+  set(TOOLS_PUBLIC_HEADER_FILES
+    tools/CppSTL.h
+    tools/InstanceLimit.h
+    tools/Network.h
+    tools/Process.h
+    tools/RateLimit.h
+    tools/Semaphore.h
+    tools/Strings.h
+    tools/Unique.h
+    tools/Version.h
+    Error.h
+    Tools.h
+  )
+
+  set(TOOLS_SOURCE_FILES
+    Error.cxx
+    tools/Network.cxx
+    tools/Process.cxx
+    tools/Semaphore.cxx
+    tools/Unique.cxx
+  )
+
+  add_library(${target}
+    ${TOOLS_SOURCE_FILES}
+    ${TOOLS_PUBLIC_HEADER_FILES}
+  )
+  target_compile_features(${target} PUBLIC cxx_std_17)
+  target_compile_definitions(${target} PUBLIC BOOST_ERROR_CODE_HEADER_ONLY)
+  target_include_directories(${target}
+    PUBLIC
+    $<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}>
+    $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+  )
+  target_link_libraries(${target}
+    PRIVATE
+    FairLogger::FairLogger
+    Threads::Threads
+    Boost::boost
+  )
+  set_target_properties(${target} PROPERTIES
+    VERSION ${PROJECT_VERSION}
+    SOVERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}"
+    OUTPUT_NAME FairMQ${target}
+  )
+  if(BUILD_TIDY_TOOL AND RUN_FAIRMQ_TIDY)
+    fairmq_target_tidy(TARGET ${target})
+  endif()
+  install(
+    TARGETS ${target}
+    EXPORT ${PROJECT_EXPORT_SET}
+    RUNTIME DESTINATION ${PROJECT_INSTALL_BINDIR}
+    LIBRARY DESTINATION ${PROJECT_INSTALL_LIBDIR}
+    ARCHIVE DESTINATION ${PROJECT_INSTALL_LIBDIR}
+  )
+  foreach(HEADER ${TOOLS_PUBLIC_HEADER_FILES})
+    get_filename_component(_path ${HEADER} DIRECTORY)
+    file(TO_CMAKE_PATH ${PROJECT_INSTALL_INCDIR}/${_path} _destination)
+    install(FILES ${HEADER}
+      DESTINATION ${_destination}
+    )
+  endforeach()
+
+  #################
+  # State Machine #
+  #################
+  set(target StateMachine)
+
+  set(FSM_PUBLIC_HEADER_FILES
+    StateMachine.h
+    States.h
+    StateQueue.h
+  )
+
+  set(FSM_SOURCE_FILES
+    StateMachine.cxx
+    States.cxx
+  )
+
+  add_library(${target}
+    ${FSM_SOURCE_FILES}
+    ${FSM_PUBLIC_HEADER_FILES}
+  )
+  target_compile_features(${target} PUBLIC cxx_std_17)
+  target_compile_definitions(${target} PUBLIC BOOST_ERROR_CODE_HEADER_ONLY)
+  target_include_directories(${target}
+    PUBLIC
+    $<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}>
+    $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+  )
+  target_link_libraries(${target}
+    PUBLIC
+    FairLogger::FairLogger
+
+    PRIVATE
+    Boost::boost
+    Tools
+  )
+  set_target_properties(${target} PROPERTIES
+    VERSION ${PROJECT_VERSION}
+    SOVERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}"
+    OUTPUT_NAME FairMQ${target}
+  )
+  if(BUILD_TIDY_TOOL AND RUN_FAIRMQ_TIDY)
+    fairmq_target_tidy(TARGET ${target})
+  endif()
+  install(
+    TARGETS ${target}
+    EXPORT ${PROJECT_EXPORT_SET}
+    RUNTIME DESTINATION ${PROJECT_INSTALL_BINDIR}
+    LIBRARY DESTINATION ${PROJECT_INSTALL_LIBDIR}
+    ARCHIVE DESTINATION ${PROJECT_INSTALL_LIBDIR}
+  )
+  foreach(HEADER ${FSM_PUBLIC_HEADER_FILES})
+    get_filename_component(_path ${HEADER} DIRECTORY)
+    file(TO_CMAKE_PATH ${PROJECT_INSTALL_INCDIR}/${_path} _destination)
+    install(FILES ${HEADER}
+      DESTINATION ${_destination}
+    )
+  endforeach()
+endif()
+
+if(BUILD_FAIRMQ)
   ##########################
   # libFairMQ header files #
   ##########################
@@ -30,7 +157,6 @@ if(BUILD_FAIRMQ)
     Channel.h
     Device.h
     DeviceRunner.h
-    Error.h
     EventManager.h
     FairMQChannel.h
     FairMQDevice.h
@@ -56,40 +182,14 @@ if(BUILD_FAIRMQ)
     Properties.h
     PropertyOutput.h
     Socket.h
-    StateMachine.h
-    States.h
-    StateQueue.h
     SuboptParser.h
-    Tools.h
     TransportFactory.h
     Transports.h
-    TransportEnum.h
     UnmanagedRegion.h
     options/FairMQProgOptions.h
     runDevice.h
     runFairMQDevice.h
-    shmem/Common.h
-    shmem/Manager.h
-    shmem/Message.h
     shmem/Monitor.h
-    shmem/Poller.h
-    shmem/Segment.h
-    shmem/Socket.h
-    shmem/TransportFactory.h
-    shmem/UnmanagedRegion.h
-    shmem/UnmanagedRegionImpl.h
-    tools/Compiler.h
-    tools/CppSTL.h
-    tools/Exceptions.h
-    tools/IO.h
-    tools/InstanceLimit.h
-    tools/Network.h
-    tools/Process.h
-    tools/RateLimit.h
-    tools/Semaphore.h
-    tools/Strings.h
-    tools/Unique.h
-    tools/Version.h
   )
 
   set(FAIRMQ_PRIVATE_HEADER_FILES
@@ -102,16 +202,32 @@ if(BUILD_FAIRMQ)
     plugins/Builtin.h
     plugins/config/Config.h
     plugins/control/Control.h
-    zeromq/Common.h
+    shmem/Message.h
+    shmem/Poller.h
+    shmem/UnmanagedRegion.h
+    shmem/Socket.h
+    shmem/TransportFactory.h
+    shmem/Common.h
+    shmem/Manager.h
+    shmem/Region.h
     zeromq/Context.h
     zeromq/Message.h
     zeromq/Poller.h
     zeromq/UnmanagedRegion.h
     zeromq/Socket.h
     zeromq/TransportFactory.h
-    zeromq/ZMsg.h
   )
 
+  if(BUILD_OFI_TRANSPORT)
+    set(FAIRMQ_PRIVATE_HEADER_FILES ${FAIRMQ_PRIVATE_HEADER_FILES}
+      ofi/Context.h
+      ofi/ControlMessages.h
+      ofi/Message.h
+      ofi/Socket.h
+      ofi/TransportFactory.h
+    )
+  endif()
+
   ##########################
   # libFairMQ source files #
   ##########################
@@ -119,7 +235,6 @@ if(BUILD_FAIRMQ)
     Channel.cxx
     Device.cxx
     DeviceRunner.cxx
-    EventManager.cxx
     JSONParser.cxx
     MemoryResources.cxx
     Plugin.cxx
@@ -127,21 +242,22 @@ if(BUILD_FAIRMQ)
     PluginServices.cxx
     ProgOptions.cxx
     Properties.cxx
-    StateMachine.cxx
-    States.cxx
     SuboptParser.cxx
     TransportFactory.cxx
     plugins/config/Config.cxx
     plugins/control/Control.cxx
-    shmem/Common.cxx
     shmem/Manager.cxx
     shmem/Monitor.cxx
-    tools/Network.cxx
-    tools/Process.cxx
-    tools/Semaphore.cxx
-    tools/Unique.cxx
   )
 
+  if(BUILD_OFI_TRANSPORT)
+    set(FAIRMQ_SOURCE_FILES ${FAIRMQ_SOURCE_FILES}
+      ofi/Context.cxx
+      ofi/Message.cxx
+      ofi/Socket.cxx
+    )
+  endif()
+
 
   ###################
   # configure files #
@@ -165,26 +281,14 @@ if(BUILD_FAIRMQ)
   ############################
   # preprocessor definitions #
   ############################
-  target_compile_definitions(${target} PUBLIC
-    BOOST_ERROR_CODE_HEADER_ONLY
-    BOOST_ASIO_HAS_HAS_STD_CHRONO
-  )
+  target_compile_definitions(${target} PUBLIC BOOST_ERROR_CODE_HEADER_ONLY)
   if(FAIRMQ_DEBUG_MODE)
     target_compile_definitions(${target} PUBLIC FAIRMQ_DEBUG_MODE)
   endif()
-  target_compile_definitions(${target} PUBLIC
-    FAIRMQ_HAS_STD_FILESYSTEM=${FAIRMQ_HAS_STD_FILESYSTEM}
-    FAIRMQ_HAS_STD_PMR=${FAIRMQ_HAS_STD_PMR}
-  )
-  if(DEFINED FAIRMQ_CHANNEL_DEFAULT_AUTOBIND)
-    # translate CMake boolean (TRUE, FALSE, 0, 1, OFF, ON) into C++ boolean literal (true, false)
-    if(FAIRMQ_CHANNEL_DEFAULT_AUTOBIND)
-      set(value "true")
-    else()
-      set(value "false")
-    endif()
-    target_compile_definitions(${target} PUBLIC FAIRMQ_CHANNEL_DEFAULT_AUTOBIND=${value})
+  if(BUILD_OFI_TRANSPORT)
+    target_compile_definitions(${target} PRIVATE BUILD_OFI_TRANSPORT)
   endif()
+  target_compile_definitions(${target} PUBLIC FAIRMQ_HAS_STD_FILESYSTEM=${FAIRMQ_HAS_STD_FILESYSTEM})
 
 
   #######################
@@ -202,6 +306,13 @@ if(BUILD_FAIRMQ)
   ##################
   # link libraries #
   ##################
+  if(BUILD_OFI_TRANSPORT)
+    set(OFI_DEPS
+      asio::asio
+      asiofi::asiofi
+    )
+  endif()
+
   target_link_libraries(${target}
     INTERFACE # only consumers link against interface dependencies
     Boost::container
@@ -212,17 +323,20 @@ if(BUILD_FAIRMQ)
     $<$<PLATFORM_ID:Linux>:rt>
     Boost::boost
     Boost::program_options
-    Boost::filesystem # still needed for Boost.DLL
+    Boost::filesystem
     Boost::regex
     FairLogger::FairLogger
+    Tools
+    StateMachine
 
     PRIVATE # only libFairMQ links against private dependencies
     libzmq
     PicoSHA2
+    ${OFI_DEPS}
   )
   set_target_properties(${target} PROPERTIES
     VERSION ${PROJECT_VERSION}
-    OUTPUT_NAME ${PROJECT_NAME_LOWER}
+    SOVERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}"
   )
   if(BUILD_TIDY_TOOL AND RUN_FAIRMQ_TIDY)
     fairmq_target_tidy(TARGET ${target})
@@ -268,7 +382,7 @@ if(BUILD_FAIRMQ)
     fairmq_target_tidy(TARGET fairmq-splitter)
   endif()
 
-  add_executable(fairmq-shmmonitor shmem/Common.cxx shmem/Monitor.cxx shmem/Monitor.h shmem/runMonitor.cxx)
+  add_executable(fairmq-shmmonitor shmem/Monitor.cxx shmem/Monitor.h shmem/runMonitor.cxx)
   target_compile_features(fairmq-shmmonitor PUBLIC cxx_std_17)
   target_compile_definitions(fairmq-shmmonitor PUBLIC BOOST_ERROR_CODE_HEADER_ONLY)
   if(FAIRMQ_DEBUG_MODE)
@@ -295,7 +409,7 @@ if(BUILD_FAIRMQ)
   add_executable(fairmq-uuid-gen tools/runUuidGenerator.cxx)
   target_link_libraries(fairmq-uuid-gen PUBLIC
     Boost::program_options
-    FairMQ
+    Tools
   )
   if(BUILD_TIDY_TOOL AND RUN_FAIRMQ_TIDY)
     fairmq_target_tidy(TARGET fairmq-uuid-gen)
@@ -332,3 +446,21 @@ if(BUILD_FAIRMQ)
     )
   endforeach()
 endif()
+
+if(BUILD_SDK_COMMANDS)
+  add_subdirectory(sdk/commands)
+endif()
+
+if(BUILD_SDK)
+  add_subdirectory(sdk)
+endif()
+
+####################
+# external plugins #
+####################
+if(BUILD_DDS_PLUGIN)
+  add_subdirectory(plugins/DDS)
+endif()
+if(BUILD_PMIX_PLUGIN)
+  add_subdirectory(plugins/PMIx)
+endif()

fairmq/Channel.cxx

@@ -12,7 +12,6 @@
 #include <fairmq/Channel.h>
 #include <fairmq/Properties.h>
 #include <fairmq/Tools.h>
-#include <fairmq/Transports.h>
 #include <random>
 #include <regex>
 #include <set>
@@ -40,8 +39,6 @@ constexpr int Channel::DefaultSndBufSize;
 constexpr int Channel::DefaultRcvBufSize;
 constexpr int Channel::DefaultSndKernelSize;
 constexpr int Channel::DefaultRcvKernelSize;
-constexpr int Channel::DefaultSndTimeoutMs;
-constexpr int Channel::DefaultRcvTimeoutMs;
 constexpr int Channel::DefaultLinger;
 constexpr int Channel::DefaultRateLogging;
 constexpr int Channel::DefaultPortRangeMin;
@@ -76,8 +73,6 @@ Channel::Channel(string name, string type, string method, string address, shared
     , fRcvBufSize(DefaultRcvBufSize)
     , fSndKernelSize(DefaultSndKernelSize)
     , fRcvKernelSize(DefaultRcvKernelSize)
-    , fSndTimeoutMs(DefaultSndTimeoutMs)
-    , fRcvTimeoutMs(DefaultRcvTimeoutMs)
     , fLinger(DefaultLinger)
     , fRateLogging(DefaultRateLogging)
     , fPortRangeMin(DefaultPortRangeMin)
@@ -102,8 +97,6 @@ Channel::Channel(const string& name, int index, const Properties& properties)
     fRcvBufSize = GetPropertyOrDefault(properties, string(prefix + "rcvBufSize"), DefaultRcvBufSize);
     fSndKernelSize = GetPropertyOrDefault(properties, string(prefix + "sndKernelSize"), DefaultSndKernelSize);
     fRcvKernelSize = GetPropertyOrDefault(properties, string(prefix + "rcvKernelSize"), DefaultRcvKernelSize);
-    fSndTimeoutMs = GetPropertyOrDefault(properties, string(prefix + "sndTimeoutMs"), DefaultSndTimeoutMs);
-    fRcvTimeoutMs = GetPropertyOrDefault(properties, string(prefix + "rcvTimeoutMs"), DefaultRcvTimeoutMs);
     fLinger = GetPropertyOrDefault(properties, string(prefix + "linger"), DefaultLinger);
     fRateLogging = GetPropertyOrDefault(properties, string(prefix + "rateLogging"), DefaultRateLogging);
     fPortRangeMin = GetPropertyOrDefault(properties, string(prefix + "portRangeMin"), DefaultPortRangeMin);
@@ -127,8 +120,6 @@ Channel::Channel(const Channel& chan, string newName)
     , fRcvBufSize(chan.fRcvBufSize)
     , fSndKernelSize(chan.fSndKernelSize)
     , fRcvKernelSize(chan.fRcvKernelSize)
-    , fSndTimeoutMs(chan.fSndTimeoutMs)
-    , fRcvTimeoutMs(chan.fRcvTimeoutMs)
     , fLinger(chan.fLinger)
     , fRateLogging(chan.fRateLogging)
     , fPortRangeMin(chan.fPortRangeMin)
@@ -155,8 +146,6 @@ Channel& Channel::operator=(const Channel& chan)
     fRcvBufSize = chan.fRcvBufSize;
     fSndKernelSize = chan.fSndKernelSize;
     fRcvKernelSize = chan.fRcvKernelSize;
-    fSndTimeoutMs = chan.fSndTimeoutMs;
-    fRcvTimeoutMs = chan.fRcvTimeoutMs;
     fLinger = chan.fLinger;
     fRateLogging = chan.fRateLogging;
     fPortRangeMin = chan.fPortRangeMin;
@@ -384,10 +373,4 @@ bool Channel::BindEndpoint(string& endpoint)
     }
 }
 
-std::string Channel::GetTransportName() const { return TransportName(fTransportType); }
-
-Transport Channel::GetTransportType() const { return fTransportType; }
-
-void Channel::UpdateTransport(const std::string& transport) { fTransportType = TransportType(transport); Invalidate(); }
-
 } // namespace fair::mq

fairmq/Channel.h

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2021-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ *    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,             *
@@ -9,17 +9,16 @@
 #ifndef FAIR_MQ_CHANNEL_H
 #define FAIR_MQ_CHANNEL_H
 
+#include <cstdint>   // int64_t
 #include <fairmq/Message.h>
 #include <fairmq/Parts.h>
 #include <fairmq/Properties.h>
 #include <fairmq/Socket.h>
 #include <fairmq/TransportFactory.h>
-#include <fairmq/TransportEnum.h>
+#include <fairmq/Transports.h>
 #include <fairmq/UnmanagedRegion.h>
-
-#include <cstdint>   // int64_t
 #include <memory>   // unique_ptr, shared_ptr
-#include <ostream>
+#include <mutex>
 #include <stdexcept>
 #include <string>
 #include <utility>   // std::move
@@ -74,25 +73,21 @@ class Channel
     Channel(const Channel&, std::string name);
 
     /// Move constructor
-    Channel(Channel&&) = default;
+    // Channel(Channel&&) = delete;
 
     /// Assignment operator
     Channel& operator=(const Channel&);
 
     /// Move assignment operator
-    Channel& operator=(Channel&&) = default;
+    // Channel& operator=(Channel&&) = delete;
 
     /// Destructor
-    ~Channel() = default;
+    virtual ~Channel() = default;
     // { LOG(warn) << "Destroying channel '" << fName << "'"; }
 
     struct ChannelConfigurationError : std::runtime_error { using std::runtime_error::runtime_error; };
 
-    Socket& GetSocket() const
-    {
-        assert(fSocket); // NOLINT(cppcoreguidelines-pro-bounds-array-to-pointer-decay)
-        return *fSocket;
-    }
+    Socket& GetSocket() const { assert(fSocket); return *fSocket; }
 
     bool Bind(const std::string& address)
     {
@@ -145,11 +140,11 @@ class Channel
 
     /// Get channel transport name ("default", "zeromq" or "shmem")
     /// @return Returns channel transport name (e.g. "default", "zeromq" or "shmem")
-    std::string GetTransportName() const;
+    std::string GetTransportName() const { return TransportName(fTransportType); }
 
     /// Get channel transport type
     /// @return Returns channel transport type
-    mq::Transport GetTransportType() const;
+    mq::Transport GetTransportType() const { return fTransportType; }
 
     /// Get socket send buffer size (in number of messages)
     /// @return Returns socket send buffer size (in number of messages)
@@ -167,14 +162,6 @@ class Channel
     /// @return Returns socket kernel transmit receive buffer size (in bytes)
     int GetRcvKernelSize() const { return fRcvKernelSize; }
 
-    /// Get socket default send timeout (in ms)
-    /// @return Returns socket default send timeout (in ms)
-    int GetSndTimeout() const { return fSndTimeoutMs; }
-
-    /// Get socket default receive timeout (in ms)
-    /// @return Returns socket default receive timeout (in ms)
-    int GetRcvTimeout() const { return fRcvTimeoutMs; }
-
     /// Get linger duration (in milliseconds)
     /// @return Returns linger duration (in milliseconds)
     int GetLinger() const { return fLinger; }
@@ -195,14 +182,6 @@ class Channel
     /// @return true/false, true if automatic binding is enabled
     bool GetAutoBind() const { return fAutoBind; }
 
-    /// @par Thread Safety
-    /// * @e Distinct @e objects: Safe.@n
-    /// * @e Shared @e objects: Unsafe.
-    auto GetNumberOfConnectedPeers() const
-    {
-        return fSocket ? fSocket->GetNumberOfConnectedPeers() : 0;
-    }
-
     /// Set channel name
     /// @param name Arbitrary channel name
     void UpdateName(const std::string& name) { fName = name; Invalidate(); }
@@ -221,51 +200,43 @@ class Channel
 
     /// Set channel transport
     /// @param transport transport string ("default", "zeromq" or "shmem")
-    void UpdateTransport(const std::string& transport);
+    void UpdateTransport(const std::string& transport) { fTransportType = TransportType(transport); Invalidate(); }
 
     /// Set socket send buffer size
     /// @param sndBufSize Socket send buffer size (in number of messages)
-    void UpdateSndBufSize(int sndBufSize) { fSndBufSize = sndBufSize; Invalidate(); }
+    void UpdateSndBufSize(const int sndBufSize) { fSndBufSize = sndBufSize; Invalidate(); }
 
     /// Set socket receive buffer size
     /// @param rcvBufSize Socket receive buffer size (in number of messages)
-    void UpdateRcvBufSize(int rcvBufSize) { fRcvBufSize = rcvBufSize; Invalidate(); }
+    void UpdateRcvBufSize(const int rcvBufSize) { fRcvBufSize = rcvBufSize; Invalidate(); }
 
     /// Set socket kernel transmit send buffer size (in bytes)
     /// @param sndKernelSize Socket send buffer size (in bytes)
-    void UpdateSndKernelSize(int sndKernelSize) { fSndKernelSize = sndKernelSize; Invalidate(); }
+    void UpdateSndKernelSize(const int sndKernelSize) { fSndKernelSize = sndKernelSize; Invalidate(); }
 
     /// Set socket kernel transmit receive buffer size (in bytes)
     /// @param rcvKernelSize Socket receive buffer size (in bytes)
-    void UpdateRcvKernelSize(int rcvKernelSize) { fRcvKernelSize = rcvKernelSize; Invalidate(); }
-
-    /// Set socket default send timeout (in ms)
-    /// @param sndTimeoutMs Socket default send timeout (in ms)
-    void UpdateSndTimeout(int sndTimeoutMs) { fSndTimeoutMs = sndTimeoutMs; Invalidate(); }
-
-    /// Set socket default receive timeout (in ms)
-    /// @param rcvTimeoutMs Socket default receive timeout (in ms)
-    void UpdateRcvTimeout(int rcvTimeoutMs) { fRcvTimeoutMs = rcvTimeoutMs; Invalidate(); }
+    void UpdateRcvKernelSize(const int rcvKernelSize) { fRcvKernelSize = rcvKernelSize; Invalidate(); }
 
     /// Set linger duration (in milliseconds)
     /// @param duration linger duration (in milliseconds)
-    void UpdateLinger(int duration) { fLinger = duration; Invalidate(); }
+    void UpdateLinger(const int duration) { fLinger = duration; Invalidate(); }
 
     /// Set socket rate logging interval (in seconds)
     /// @param rateLogging Socket rate logging interval (in seconds)
-    void UpdateRateLogging(int rateLogging) { fRateLogging = rateLogging; Invalidate(); }
+    void UpdateRateLogging(const int rateLogging) { fRateLogging = rateLogging; Invalidate(); }
 
     /// Set start of the port range for automatic binding
     /// @param minPort start of the port range
-    void UpdatePortRangeMin(int minPort) { fPortRangeMin = minPort; Invalidate(); }
+    void UpdatePortRangeMin(const int minPort) { fPortRangeMin = minPort; Invalidate(); }
 
     /// Set end of the port range for automatic binding
     /// @param maxPort end of the port range
-    void UpdatePortRangeMax(int maxPort) { fPortRangeMax = maxPort; Invalidate(); }
+    void UpdatePortRangeMax(const int maxPort) { fPortRangeMax = maxPort; Invalidate(); }
 
     /// Set automatic binding (pick random port if bind fails)
     /// @param autobind true/false, true to enable automatic binding
-    void UpdateAutoBind(bool autobind) { fAutoBind = autobind; Invalidate(); }
+    void UpdateAutoBind(const bool autobind) { fAutoBind = autobind; Invalidate(); }
 
     /// Checks if the configured channel settings are valid (checks the validity parameter, without running full validation (as oposed to ValidateChannel()))
     /// @return true if channel settings are valid, false otherwise.
@@ -284,52 +255,62 @@ class Channel
     /// invalidates the channel (requires validation to be used again).
     void Invalidate() { fValid = false; }
 
-    /// Send message(s) to the socket queue.
-    /// @param m reference to MessagePtr/Parts/vector<MessagePtr>
-    /// @param sndTimeoutMs send timeout in ms.
-    /// -1 will wait forever (or until interrupt (e.g. via state change)),
-    /// 0 will not wait (return immediately if cannot send).
-    /// If not provided, default timeout will be taken.
-    /// @return Number of bytes that have been queued,
-    /// TransferCode::timeout if timed out,
-    /// TransferCode::error if there was an error,
-    /// TransferCode::interrupted if interrupted (e.g. by requested state change)
-    template<typename M, typename... Timeout>
-    std::enable_if_t<is_transferrable<M>::value, int64_t>
-    Send(M& m, Timeout&&... sndTimeoutMs)
+    /// Sends a message to the socket queue.
+    /// @param msg Constant reference of unique_ptr to a Message
+    /// @param sndTimeoutInMs send timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot send)
+    /// @return Number of bytes that have been queued, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change)
+    int64_t Send(MessagePtr& msg, int sndTimeoutInMs = -1)
     {
-        static_assert(sizeof...(sndTimeoutMs) <= 1, "Send called with too many arguments");
-
-        CheckSendCompatibility(m);
-        int t = fSndTimeoutMs;
-        if constexpr (sizeof...(sndTimeoutMs) == 1) {
-            t = {sndTimeoutMs...};
-        }
-        return fSocket->Send(m, t);
+        CheckSendCompatibility(msg);
+        return fSocket->Send(msg, sndTimeoutInMs);
     }
 
-    /// Receive message(s) from the socket queue.
-    /// @param m reference to MessagePtr/Parts/vector<MessagePtr>
-    /// @param rcvTimeoutMs receive timeout in ms.
-    /// -1 will wait forever (or until interrupt (e.g. via state change)),
-    /// 0 will not wait (return immediately if cannot receive).
-    /// If not provided, default timeout will be taken.
-    /// @return Number of bytes that have been received,
-    /// TransferCode::timeout if timed out,
-    /// TransferCode::error if there was an error,
-    /// TransferCode::interrupted if interrupted (e.g. by requested state change)
-    template<typename M, typename... Timeout>
-    std::enable_if_t<is_transferrable<M>::value, int64_t>
-    Receive(M& m, Timeout&&... rcvTimeoutMs)
+    /// Receives a message from the socket queue.
+    /// @param msg Constant reference of unique_ptr to a Message
+    /// @param rcvTimeoutInMs receive timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot receive)
+    /// @return Number of bytes that have been received, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change)
+    int64_t Receive(MessagePtr& msg, int rcvTimeoutInMs = -1)
     {
-        static_assert(sizeof...(rcvTimeoutMs) <= 1, "Receive called with too many arguments");
+        CheckReceiveCompatibility(msg);
+        return fSocket->Receive(msg, rcvTimeoutInMs);
+    }
 
-        CheckReceiveCompatibility(m);
-        int t = fRcvTimeoutMs;
-        if constexpr (sizeof...(rcvTimeoutMs) == 1) {
-            t = {rcvTimeoutMs...};
-        }
-        return fSocket->Receive(m, t);
+    /// Send a vector of messages
+    /// @param msgVec message vector reference
+    /// @param sndTimeoutInMs send timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot send)
+    /// @return Number of bytes that have been queued, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change)
+    int64_t Send(std::vector<MessagePtr>& msgVec, int sndTimeoutInMs = -1)
+    {
+        CheckSendCompatibility(msgVec);
+        return fSocket->Send(msgVec, sndTimeoutInMs);
+    }
+
+    /// Receive a vector of messages
+    /// @param msgVec message vector reference
+    /// @param rcvTimeoutInMs receive timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot receive)
+    /// @return Number of bytes that have been received, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change)
+    int64_t Receive(std::vector<MessagePtr>& msgVec, int rcvTimeoutInMs = -1)
+    {
+        CheckReceiveCompatibility(msgVec);
+        return fSocket->Receive(msgVec, rcvTimeoutInMs);
+    }
+
+    /// Send Parts
+    /// @param parts Parts reference
+    /// @param sndTimeoutInMs send timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot send)
+    /// @return Number of bytes that have been queued, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change)
+    int64_t Send(Parts& parts, int sndTimeoutInMs = -1)
+    {
+        return Send(parts.fParts, sndTimeoutInMs);
+    }
+
+    /// Receive Parts
+    /// @param parts Parts reference
+    /// @param rcvTimeoutInMs receive timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot receive)
+    /// @return Number of bytes that have been received, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change)
+    int64_t Receive(Parts& parts, int rcvTimeoutInMs = -1)
+    {
+        return Receive(parts.fParts, rcvTimeoutInMs);
     }
 
     unsigned long GetBytesTx() const { return fSocket->GetBytesTx(); }
@@ -373,25 +354,11 @@ class Channel
     static constexpr int DefaultRcvBufSize = 1000;
     static constexpr int DefaultSndKernelSize = 0;
     static constexpr int DefaultRcvKernelSize = 0;
-    static constexpr int DefaultSndTimeoutMs = -1;
-    static constexpr int DefaultRcvTimeoutMs = -1;
     static constexpr int DefaultLinger = 500;
     static constexpr int DefaultRateLogging = 1;
     static constexpr int DefaultPortRangeMin = 22000;
     static constexpr int DefaultPortRangeMax = 23000;
-#ifdef FAIRMQ_CHANNEL_DEFAULT_AUTOBIND
-    static constexpr bool DefaultAutoBind = FAIRMQ_CHANNEL_DEFAULT_AUTOBIND;
-#else
     static constexpr bool DefaultAutoBind = true;
-#endif
-
-    friend std::ostream& operator<<(std::ostream& os, const Channel& ch)
-    {
-        return os << "name: " << ch.fName
-                  << ", type: "  << ch.fType
-                  << ", method: "  << ch.fMethod
-                  << ", address: "  << ch.fAddress;
-    }
 
   private:
     std::shared_ptr<TransportFactory> fTransportFactory;
@@ -406,8 +373,6 @@ class Channel
     int fRcvBufSize;
     int fSndKernelSize;
     int fRcvKernelSize;
-    int fSndTimeoutMs;
-    int fRcvTimeoutMs;
     int fLinger;
     int fRateLogging;
     int fPortRangeMin;
@@ -429,16 +394,15 @@ class Channel
                     msg.get()
                 ));
                 msg.release();
-                msg = std::move(msgWrapper);
+                msg = move(msgWrapper);
             } else {
                 MessagePtr newMsg(NewMessage());
-                msg = std::move(newMsg);
+                msg = move(newMsg);
             }
         }
     }
 
-    void CheckSendCompatibility(Parts& parts) { CheckSendCompatibility(parts.fParts); }
-    void CheckSendCompatibility(Parts::container & msgVec)
+    void CheckSendCompatibility(std::vector<MessagePtr>& msgVec)
     {
         for (auto& msg : msgVec) {
             if (fTransportType != msg->GetType()) {
@@ -450,10 +414,10 @@ class Channel
                         msg.get()
                     ));
                     msg.release();
-                    msg = std::move(msgWrapper);
+                    msg = move(msgWrapper);
                 } else {
                     MessagePtr newMsg(NewMessage());
-                    msg = std::move(newMsg);
+                    msg = move(newMsg);
                 }
             }
         }
@@ -463,18 +427,17 @@ class Channel
     {
         if (fTransportType != msg->GetType()) {
             MessagePtr newMsg(NewMessage());
-            msg = std::move(newMsg);
+            msg = move(newMsg);
         }
     }
 
-    void CheckReceiveCompatibility(Parts& parts) { CheckReceiveCompatibility(parts.fParts); }
-    void CheckReceiveCompatibility(Parts::container& msgVec)
+    void CheckReceiveCompatibility(std::vector<MessagePtr>& msgVec)
     {
         for (auto& msg : msgVec) {
             if (fTransportType != msg->GetType()) {
 
                 MessagePtr newMsg(NewMessage());
-                msg = std::move(newMsg);
+                msg = move(newMsg);
             }
         }
     }
@@ -488,6 +451,7 @@ class Channel
 
 } // namespace fair::mq
 
-using FairMQChannel [[deprecated("Use fair::mq::Channel")]] = fair::mq::Channel;
+// using FairMQChannel [[deprecated("Use fair::mq::Channel")]] = fair::mq::Channel;
+using FairMQChannel = fair::mq::Channel;
 
 #endif   // FAIR_MQ_CHANNEL_H

fairmq/Device.cxx

@@ -1,25 +1,19 @@
 /********************************************************************************
- * Copyright (C) 2012-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ * Copyright (C) 2012-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
+#include <algorithm>                    // std::max
+#include <boost/algorithm/string.hpp>   // join/split
+#include <chrono>
 #include <fairmq/Device.h>
 #include <fairmq/Tools.h>
-#include <fairmq/Transports.h>
-
-// boost
-#include <boost/algorithm/string.hpp>   // join/split
-
-// std
-#include <algorithm>   // std::max, std::any_of
-#include <chrono>
+#include <future>
 #include <iomanip>
 #include <list>
-#include <memory>   // std::make_unique
 #include <mutex>
 #include <thread>
 
@@ -33,6 +27,7 @@ constexpr const char* Device::DefaultTransportName;
 constexpr mq::Transport Device::DefaultTransportType;
 constexpr const char* Device::DefaultNetworkInterface;
 constexpr int Device::DefaultInitTimeout;
+constexpr uint64_t Device::DefaultMaxRunTime;
 constexpr float Device::DefaultRate;
 constexpr const char* Device::DefaultSession;
 
@@ -52,11 +47,6 @@ struct StateSubscription
         });
     }
 
-    StateSubscription(const StateSubscription&) = delete;
-    StateSubscription(StateSubscription&&) = delete;
-    StateSubscription& operator=(const StateSubscription&) = delete;
-    StateSubscription& operator=(StateSubscription&&) = delete;
-
     ~StateSubscription() {
         fStateMachine.UnsubscribeFromStateChange(fId);
     }
@@ -70,18 +60,15 @@ Device::Device(ProgOptions& config)
     : Device(&config, {0, 0, 0})
 {}
 
-Device::Device(tools::Version version)
+Device::Device(const tools::Version version)
     : Device(nullptr, version)
 {}
 
-Device::Device(ProgOptions& config, tools::Version version)
+Device::Device(ProgOptions& config, const tools::Version version)
     : Device(&config, version)
 {}
 
-/// TODO: Remove this once Device::fChannels is no longer public
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
-Device::Device(ProgOptions* config, tools::Version version)
+Device::Device(ProgOptions* config, const tools::Version version)
     : fTransportFactory(nullptr)
     , fInternalConfig(config ? nullptr : make_unique<ProgOptions>())
     , fConfig(config ? config : fInternalConfig.get())
@@ -91,16 +78,20 @@ Device::Device(ProgOptions* config, tools::Version version)
     , fMultitransportProceed(false)
     , fVersion(version)
     , fRate(DefaultRate)
+    , fMaxRunRuntimeInS(DefaultMaxRunTime)
     , fInitializationTimeoutInS(DefaultInitTimeout)
+    , fTransitioning(false)
 {
     SubscribeToNewTransition("device", [&](Transition transition) {
         LOG(trace) << "device notified on new transition: " << transition;
-        InterruptTransports();
-    });
 
-    fStateMachine.PrepareState([&](State state) {
-        LOG(trace) << "Resuming transports for " << state << " state";
-        ResumeTransports();
+        switch (transition) {
+            case Transition::Stop:
+                UnblockTransports();
+                break;
+            default:
+                break;
+        }
     });
 
     fStateMachine.HandleStates([&](State state) {
@@ -141,7 +132,73 @@ Device::Device(ProgOptions* config, tools::Version version)
 
     fStateMachine.Start();
 }
-#pragma GCC diagnostic pop
+
+void Device::TransitionTo(const State s)
+{
+    {
+        lock_guard<mutex> lock(fTransitionMtx);
+        if (fTransitioning) {
+            LOG(debug) << "Attempting a transition with TransitionTo() while another one is already in progress";
+            throw OngoingTransition("Attempting a transition with TransitionTo() while another one is already in progress");
+        }
+        fTransitioning = true;
+    }
+
+    using mq::State;
+
+    StateQueue sq;
+    StateSubscription ss(tools::ToString(fId, ".TransitionTo"), fStateMachine, sq);
+
+    State currentState = GetCurrentState();
+
+    while (s != currentState) {
+        switch (currentState) {
+            case State::Idle:
+                if (s == State::Exiting) { ChangeState(Transition::End); }
+                else { ChangeState(Transition::InitDevice); }
+            break;
+            case State::InitializingDevice:
+                ChangeState(Transition::CompleteInit);
+            break;
+            case State::Initialized:
+                if (s == State::Exiting || s == State::Idle) { ChangeState(Transition::ResetDevice); }
+                else { ChangeState(Transition::Bind); }
+            break;
+            case State::Bound:
+                if (s == State::DeviceReady || s == State::Ready || s == State::Running) { ChangeState(Transition::Connect); }
+                else { ChangeState(Transition::ResetDevice); }
+            break;
+            case State::DeviceReady:
+                if (s == State::Running || s == State::Ready) { ChangeState(Transition::InitTask); }
+                else { ChangeState(Transition::ResetDevice); }
+            break;
+            case State::Ready:
+                if (s == State::Running) { ChangeState(Transition::Run); }
+                else { ChangeState(Transition::ResetTask); }
+            break;
+            case State::Running:
+                ChangeState(Transition::Stop);
+            break;
+            case State::Binding:
+            case State::Connecting:
+            case State::InitializingTask:
+            case State::ResettingDevice:
+            case State::ResettingTask:
+                LOG(debug) << "TransitionTo ignoring state: " << currentState << " (expected, automatic transition).";
+            break;
+            default:
+                LOG(debug) << "TransitionTo ignoring state: " << currentState;
+            break;
+        }
+
+        currentState = sq.WaitForNext();
+    }
+
+    {
+        lock_guard<mutex> lock(fTransitionMtx);
+        fTransitioning = false;
+    }
+}
 
 void Device::InitWrapper()
 {
@@ -153,6 +210,7 @@ void Device::InitWrapper()
     Init();
 
     fRate = fConfig->GetProperty<float>("rate", DefaultRate);
+    fMaxRunRuntimeInS = fConfig->GetProperty<uint64_t>("max-run-time", DefaultMaxRunTime);
     fInitializationTimeoutInS = fConfig->GetProperty<int>("init-timeout", DefaultInitTimeout);
 
     try {
@@ -166,7 +224,7 @@ void Device::InitWrapper()
     unordered_map<string, int> infos = fConfig->GetChannelInfo();
     for (const auto& info : infos) {
         for (int i = 0; i < info.second; ++i) {
-            GetChannels()[info.first].emplace_back(info.first, i, fConfig->GetPropertiesStartingWith(tools::ToString("chans.", info.first, ".", i, ".")));
+            fChannels[info.first].emplace_back(info.first, i, fConfig->GetPropertiesStartingWith(tools::ToString("chans.", info.first, ".", i, ".")));
         }
     }
 
@@ -176,7 +234,8 @@ void Device::InitWrapper()
     string networkInterface = fConfig->GetProperty<string>("network-interface", DefaultNetworkInterface);
 
     // Fill the uninitialized channel containers
-    for (auto& channel : GetChannels()) {
+    for (auto& channel : fChannels) {
+        int subChannelIndex = 0;
         for (auto& subChannel : channel.second) {
             // set channel transport
             LOG(debug) << "Initializing transport for channel " << subChannel.fName << ": " << TransportNames.at(subChannel.fTransportType);
@@ -208,10 +267,12 @@ void Device::InitWrapper()
                 LOG(error) << "Cannot update configuration. Socket method (bind/connect) for channel '" << subChannel.fName << "' not specified.";
                 throw runtime_error(tools::ToString("Cannot update configuration. Socket method (bind/connect) for channel ", subChannel.fName, " not specified."));
             }
+
+            subChannelIndex++;
         }
     }
 
-    // ChangeStateOrThrow(Transition::Auto);
+    // ChangeState(Transition::Auto);
 }
 
 void Device::BindWrapper()
@@ -227,9 +288,7 @@ void Device::BindWrapper()
 
     Bind();
 
-    if (!NewStatePending()) {
-        ChangeStateOrThrow(Transition::Auto);
-    }
+    ChangeState(Transition::Auto);
 }
 
 void Device::ConnectWrapper()
@@ -241,7 +300,7 @@ void Device::ConnectWrapper()
     // first attempt
     AttachChannels(fUninitializedConnectingChannels);
     // if not all channels could be connected, update their address values from config and retry
-    while (!fUninitializedConnectingChannels.empty() && !NewStatePending()) {
+    while (!fUninitializedConnectingChannels.empty()) {
         this_thread::sleep_for(chrono::milliseconds(sleepTimeInMS));
 
         for (auto& chan : fUninitializedConnectingChannels) {
@@ -254,25 +313,19 @@ void Device::ConnectWrapper()
 
         if (numAttempts++ > maxAttempts) {
             LOG(error) << "could not connect all channels after " << fInitializationTimeoutInS << " attempts";
-            LOG(error) << "following channels are still invalid:";
-            for (auto& chan : fUninitializedConnectingChannels) {
-                LOG(error) << "channel: " << *chan;
-            }
             throw runtime_error(tools::ToString("could not connect all channels after ", fInitializationTimeoutInS, " attempts"));
         }
 
         AttachChannels(fUninitializedConnectingChannels);
     }
 
-    if (GetChannels().empty()) {
+    if (fChannels.empty()) {
         LOG(warn) << "No channels created after finishing initialization";
     }
 
     Connect();
 
-    if (!NewStatePending()) {
-        ChangeStateOrThrow(Transition::Auto);
-    }
+    ChangeState(Transition::Auto);
 }
 
 void Device::AttachChannels(vector<Channel*>& chans)
@@ -286,7 +339,7 @@ void Device::AttachChannels(vector<Channel*>& chans)
                 // remove the channel from the uninitialized container
                 itr = chans.erase(itr);
             } else {
-                LOG(error) << "failed to attach channel " << (*itr)->fName << " (" << (*itr)->fMethod << " on " << (*itr)->fAddress << ")";
+                LOG(error) << "failed to attach channel " << (*itr)->fName << " (" << (*itr)->fMethod << ")";
                 ++itr;
             }
         } else {
@@ -372,63 +425,62 @@ void Device::InitTaskWrapper()
 {
     InitTask();
 
-    if (!NewStatePending()) {
-        ChangeStateOrThrow(Transition::Auto);
-    }
+    ChangeState(Transition::Auto);
 }
 
 void Device::RunWrapper()
 {
-    LOG(info) << "fair::mq::Device running...";
+    LOG(info) << "DEVICE: Running...";
 
-    unique_ptr<thread> rateLogger;
-    // Check if rate logging thread is needed
-    const bool rateLogging = any_of(GetChannels().cbegin(), GetChannels().cend(), [](auto ch) {
-        return any_of(ch.second.cbegin(), ch.second.cend(), [](auto sub) { return sub.fRateLogging > 0; });
-    });
+    // start the rate logger thread
+    future<void> rateLogger = async(launch::async, &Device::LogSocketRates, this);
 
-    if (rateLogging) {
-        rateLogger = make_unique<thread>(&Device::LogSocketRates, this);
+    // notify transports to resume transfers
+    for (auto& t : fTransports) {
+        t.second->Resume();
     }
-    tools::CallOnDestruction joinRateLogger([&](){
-        if (rateLogging && rateLogger->joinable()) { rateLogger->join(); }
-    });
 
-    // change to Error state in case of an exception, to release LogSocketRates
-    tools::CallOnDestruction cod([&](){
-        ChangeStateOrThrow(Transition::ErrorFound);
-    });
+    try {
+        PreRun();
 
-    PreRun();
-
-    // process either data callbacks or ConditionalRun/Run
-    if (fDataCallbacks) {
-        // if only one input channel, do lightweight handling without additional polling.
-        if (fInputChannelKeys.size() == 1 && GetChannels().at(fInputChannelKeys.at(0)).size() == 1) {
-            HandleSingleChannelInput();
-        } else {// otherwise do full handling with polling
-            HandleMultipleChannelInput();
-        }
-    } else {
-        tools::RateLimiter rateLimiter(fRate);
-
-        while (!NewStatePending() && ConditionalRun()) {
-            if (fRate > 0.001) {
-                rateLimiter.maybe_sleep();
+        // process either data callbacks or ConditionalRun/Run
+        if (fDataCallbacks) {
+            // if only one input channel, do lightweight handling without additional polling.
+            if (fInputChannelKeys.size() == 1 && fChannels.at(fInputChannelKeys.at(0)).size() == 1) {
+                HandleSingleChannelInput();
+            } else {// otherwise do full handling with polling
+                HandleMultipleChannelInput();
             }
+        } else {
+            tools::RateLimiter rateLimiter(fRate);
+
+            while (!NewStatePending() && ConditionalRun()) {
+                if (fRate > 0.001) {
+                    rateLimiter.maybe_sleep();
+                }
+            }
+
+            Run();
         }
 
-        Run();
+        // if Run() exited and the state is still RUNNING, transition to READY.
+        if (!NewStatePending()) {
+            UnblockTransports();
+            ChangeState(Transition::Stop);
+        }
+
+        PostRun();
+    } catch (const out_of_range& oor) {
+        LOG(error) << "out of range: " << oor.what();
+        LOG(error) << "incorrect/incomplete channel configuration?";
+        ChangeState(Transition::ErrorFound);
+        throw;
+    } catch (...) {
+        ChangeState(Transition::ErrorFound);
+        throw;
     }
 
-    // if Run() exited and the state is still RUNNING, transition to READY.
-    if (!NewStatePending()) {
-        ChangeStateOrThrow(Transition::Stop);
-    }
-
-    PostRun();
-
-    cod.disable();
+    rateLogger.get();
 }
 
 void Device::HandleSingleChannelInput()
@@ -451,7 +503,7 @@ void Device::HandleMultipleChannelInput()
     // check if more than one transport is used
     fMultitransportInputs.clear();
     for (const auto& k : fInputChannelKeys) {
-        mq::Transport t = GetChannel(k, 0).fTransportType;
+        mq::Transport t = fChannels.at(k).at(0).fTransportType;
         if (fMultitransportInputs.find(t) == fMultitransportInputs.end()) {
             fMultitransportInputs.insert(pair<mq::Transport, vector<string>>(t, vector<string>()));
             fMultitransportInputs.at(t).push_back(k);
@@ -461,13 +513,13 @@ void Device::HandleMultipleChannelInput()
     }
 
     for (const auto& mi : fMsgInputs) {
-        for (auto& i : GetChannels().at(mi.first)) {
+        for (auto& i : fChannels.at(mi.first)) {
             i.fMultipart = false;
         }
     }
 
     for (const auto& mi : fMultipartInputs) {
-        for (auto& i : GetChannels().at(mi.first)) {
+        for (auto& i : fChannels.at(mi.first)) {
             i.fMultipart = true;
         }
     }
@@ -478,16 +530,16 @@ void Device::HandleMultipleChannelInput()
     } else { // otherwise poll directly
         bool proceed = true;
 
-        PollerPtr poller(GetChannel(fInputChannelKeys.at(0), 0).fTransportFactory->CreatePoller(GetChannels(), fInputChannelKeys));
+        PollerPtr poller(fChannels.at(fInputChannelKeys.at(0)).at(0).fTransportFactory->CreatePoller(fChannels, fInputChannelKeys));
 
         while (!NewStatePending() && proceed) {
             poller->Poll(200);
 
             // check which inputs are ready and call their data handlers if they are.
             for (const auto& ch : fInputChannelKeys) {
-                for (unsigned int i = 0; i < GetChannels().at(ch).size(); ++i) {
+                for (unsigned int i = 0; i < fChannels.at(ch).size(); ++i) {
                     if (poller->CheckInput(ch, i)) {
-                        if (GetChannel(ch, i).fMultipart) {
+                        if (fChannels.at(ch).at(i).fMultipart) {
                             proceed = HandleMultipartInput(ch, fMultipartInputs.at(ch), i);
                         } else {
                             proceed = HandleMsgInput(ch, fMsgInputs.at(ch), i);
@@ -524,13 +576,13 @@ void Device::HandleMultipleTransportInput()
 void Device::PollForTransport(const TransportFactory* factory, const vector<string>& channelKeys)
 {
     try {
-        PollerPtr poller(factory->CreatePoller(GetChannels(), channelKeys));
+        PollerPtr poller(factory->CreatePoller(fChannels, channelKeys));
 
         while (!NewStatePending() && fMultitransportProceed) {
             poller->Poll(500);
 
             for (const auto& ch : channelKeys) {
-                for (unsigned int i = 0; i < GetChannels().at(ch).size(); ++i) {
+                for (unsigned int i = 0; i < fChannels.at(ch).size(); ++i) {
                     if (poller->CheckInput(ch, i)) {
                         lock_guard<mutex> lock(fMultitransportMutex);
 
@@ -538,7 +590,7 @@ void Device::PollForTransport(const TransportFactory* factory, const vector<stri
                             break;
                         }
 
-                        if (GetChannel(ch, i).fMultipart) {
+                        if (fChannels.at(ch).at(i).fMultipart) {
                             fMultitransportProceed = HandleMultipartInput(ch, fMultipartInputs.at(ch), i);
                         } else {
                             fMultitransportProceed = HandleMsgInput(ch, fMsgInputs.at(ch), i);
@@ -562,7 +614,7 @@ void Device::PollForTransport(const TransportFactory* factory, const vector<stri
 
 bool Device::HandleMsgInput(const string& chName, const InputMsgCallback& callback, int i)
 {
-    unique_ptr<Message> input(GetChannel(chName, i).fTransportFactory->CreateMessage());
+    unique_ptr<Message> input(fChannels.at(chName).at(i).fTransportFactory->CreateMessage());
 
     if (Receive(input, chName, i) >= 0) {
         return callback(input, i);
@@ -584,8 +636,6 @@ bool Device::HandleMultipartInput(const string& chName, const InputMultipartCall
 
 shared_ptr<TransportFactory> Device::AddTransport(mq::Transport transport)
 {
-    lock_guard<mutex> lock(fTransportMtx);
-
     if (transport == mq::Transport::DEFAULT) {
         transport = fDefaultTransportType;
     }
@@ -619,7 +669,7 @@ void Device::LogSocketRates()
     size_t chanNameLen = 0;
 
     // iterate over the channels map
-    for (auto& channel : GetChannels()) {
+    for (auto& channel : fChannels) {
         // iterate over the channels vector
         for (auto& subChannel : channel.second) {
             if (subChannel.fRateLogging > 0) {
@@ -658,6 +708,7 @@ void Device::LogSocketRates()
 
     chrono::time_point<chrono::high_resolution_clock> t0(chrono::high_resolution_clock::now());
     chrono::time_point<chrono::high_resolution_clock> t1;
+    uint64_t secondsElapsed = 0;
 
     while (!NewStatePending()) {
         WaitFor(chrono::seconds(1));
@@ -690,7 +741,7 @@ void Device::LogSocketRates()
                     bytesOut.at(i) = bytesOutNew.at(i);
                     msgOut.at(i) = msgOutNew.at(i);
 
-                    LOG(info) << setw(static_cast<int>(chanNameLen)) << filteredChannelNames.at(i) << ": "
+                    LOG(info) << setw(chanNameLen) << filteredChannelNames.at(i) << ": "
                               << "in: " << msgPerSecIn.at(i) << " (" << mbPerSecIn.at(i) << " MB) "
                               << "out: " << msgPerSecOut.at(i) << " (" << mbPerSecOut.at(i) << " MB)";
                 }
@@ -700,22 +751,16 @@ void Device::LogSocketRates()
         }
 
         t0 = t1;
+        if (fMaxRunRuntimeInS > 0 && ++secondsElapsed >= fMaxRunRuntimeInS) {
+            ChangeState(Transition::Stop);
+        }
     }
 }
 
-void Device::InterruptTransports()
+void Device::UnblockTransports()
 {
-    lock_guard<mutex> lock(fTransportMtx);
-    for (auto& [transportType, transport] : fTransports) {
-        transport->Interrupt();
-    }
-}
-
-void Device::ResumeTransports()
-{
-    lock_guard<mutex> lock(fTransportMtx);
-    for (auto& [transportType, transport] : fTransports) {
-        transport->Resume();
+    for (auto& transport : fTransports) {
+        transport.second->Interrupt();
     }
 }
 
@@ -723,39 +768,28 @@ void Device::ResetTaskWrapper()
 {
     ResetTask();
 
-    if (!NewStatePending()) {
-        ChangeStateOrThrow(Transition::Auto);
-    }
+    ChangeState(Transition::Auto);
 }
 
 void Device::ResetWrapper()
 {
-    {
-        lock_guard<mutex> lock(fTransportMtx);
-        for (auto& [transportType, transport] : fTransports) {
-            transport->Reset();
-        }
-        fTransports.clear();
+    for (auto& transport : fTransports) {
+        transport.second->Reset();
     }
 
     Reset();
 
-    GetChannels().clear();
+    fChannels.clear();
+    fTransports.clear();
     fTransportFactory.reset();
-    if (!NewStatePending()) {
-        ChangeStateOrThrow(Transition::Auto);
-    }
+    ChangeState(Transition::Auto);
 }
 
-/// TODO: Remove this once Device::fChannels is no longer public
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
 Device::~Device()
 {
     UnsubscribeFromNewTransition("device");
     fStateMachine.StopHandlingStates();
     LOG(debug) << "Shutting down device " << fId;
 }
-#pragma GCC diagnostic pop
 
 } // namespace fair::mq