Change unregistered options warning to debug

Transport has meaningful defaults if FairMQProgOptions is missing

.gitignore

@@ -1 +1,3 @@
 build
+
+.DS_Store

CMakeLists.txt

@@ -26,26 +26,34 @@ include(CTest)
 
 
 # Build options ################################################################
-option(BUILD_NANOMSG_TRANSPORT "Build nanomsg transport." OFF)
-option(BUILD_OFI_TRANSPORT "Build experimental OFI transport." OFF)
-option(BUILD_DDS_PLUGIN "Build DDS plugin." OFF)
+include(CMakeDependentOption)
+option(BUILD_FAIRMQ "Build FairMQ library and devices." ON)
+cmake_dependent_option(BUILD_TESTING "Build tests." OFF "BUILD_FAIRMQ" OFF)
+cmake_dependent_option(BUILD_NANOMSG_TRANSPORT "Build nanomsg transport." OFF "BUILD_FAIRMQ" OFF)
+cmake_dependent_option(BUILD_OFI_TRANSPORT "Build experimental OFI transport." OFF "BUILD_FAIRMQ" OFF)
+cmake_dependent_option(BUILD_DDS_PLUGIN "Build DDS plugin." OFF "BUILD_FAIRMQ" OFF)
+cmake_dependent_option(BUILD_EXAMPLES "Build FairMQ examples." ON "BUILD_FAIRMQ" OFF)
+option(BUILD_DOCS "Build FairMQ documentation." OFF)
 ################################################################################
 
 
 # Dependencies #################################################################
-find_package2(PUBLIC Boost VERSION 1.64 REQUIRED
-  COMPONENTS program_options thread system filesystem regex date_time signals
-)
-find_package2(PUBLIC FairLogger VERSION 1.0.2 REQUIRED)
-find_package2(PRIVATE ZeroMQ VERSION 4.2.2 REQUIRED)
+if(BUILD_FAIRMQ)
+  find_package2(PUBLIC Boost VERSION 1.64 REQUIRED
+    COMPONENTS program_options thread system filesystem regex date_time signals
+  )
+  find_package2(PUBLIC FairLogger VERSION 1.2.0 REQUIRED)
+  find_package2(PRIVATE ZeroMQ VERSION 4.1.5 REQUIRED)
+endif()
 
 if(BUILD_NANOMSG_TRANSPORT)
   find_package2(PRIVATE nanomsg VERSION 1.0.0 REQUIRED)
   find_package2(PRIVATE msgpack VERSION 2.1.5 REQUIRED)
+  set(msgpack_ROOT ${PACKAGE_PREFIX_DIR})
 endif()
 
 if(BUILD_OFI_TRANSPORT)
-  find_package2(PRIVATE OFI VERSION 1.6.0 REQUIRED COMPONENTS fi_sockets)
+  find_package2(PRIVATE OFI VERSION 1.6.0 REQUIRED COMPONENTS fi_sockets fi_verbs)
   find_package2(PRIVATE Protobuf VERSION 3.4.0 REQUIRED)
 endif()
 
@@ -56,26 +64,50 @@ endif()
 if(BUILD_TESTING)
   find_package2(PRIVATE GTest VERSION 1.7.0 REQUIRED)
 endif()
+
+if(BUILD_DOCS)
+  find_package2(PRIVATE Doxygen VERSION 1.8.8 REQUIRED COMPONENTS dot OPTIONAL_COMPONENTS mscgen dia)
+endif()
 ################################################################################
 
 
 # Targets ######################################################################
-configure_file(${PROJECT_NAME_LOWER}/Version.h.in
-  ${CMAKE_BINARY_DIR}/${PROJECT_NAME_LOWER}/Version.h
-  @ONLY
-)
+if(BUILD_FAIRMQ)
+  configure_file(${PROJECT_NAME_LOWER}/Version.h.in
+    ${CMAKE_BINARY_DIR}/${PROJECT_NAME_LOWER}/Version.h
+    @ONLY
+  )
 
-add_subdirectory(fairmq)
+  add_subdirectory(fairmq)
+endif()
 
 if(BUILD_TESTING)
   add_subdirectory(test)
 endif()
+
+if(BUILD_EXAMPLES)
+  add_subdirectory(examples)
+endif()
+
+if(BUILD_DOCS)
+  set(DOXYGEN_OUTPUT_DIRECTORY doxygen)
+  set(DOXYGEN_PROJECT_NUMBER ${PROJECT_GIT_VERSION})
+  set(DOXYGEN_PROJECT_BRIEF "C++ Message Passing Framework")
+  set(DOXYGEN_USE_MDFILE_AS_MAINPAGE README.md)
+  set(DOXYGEN_HTML_FOOTER docs/footer.html)
+  doxygen_add_docs(doxygen README.md fairmq)
+  add_custom_target(docs ALL DEPENDS doxygen)
+endif()
 ################################################################################
 
 
 # Package components ###########################################################
-list(APPEND PROJECT_PACKAGE_COMPONENTS fairmq)
-list(APPEND PROJECT_PACKAGE_COMPONENTS tests)
+if(BUILD_FAIRMQ)
+  list(APPEND PROJECT_PACKAGE_COMPONENTS fairmq)
+endif()
+if(BUILD_TESTING)
+  list(APPEND PROJECT_PACKAGE_COMPONENTS tests)
+endif()
 if(BUILD_DDS_PLUGIN)
   list(APPEND PROJECT_PACKAGE_COMPONENTS dds_plugin)
 endif()
@@ -85,18 +117,25 @@ 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()
 ################################################################################
 
 
 # Installation #################################################################
-install(FILES ${CMAKE_BINARY_DIR}/${PROJECT_NAME_LOWER}/Version.h
-  DESTINATION ${PROJECT_INSTALL_INCDIR}
-)
+if(BUILD_FAIRMQ)
+  install(FILES ${CMAKE_BINARY_DIR}/${PROJECT_NAME_LOWER}/Version.h
+    DESTINATION ${PROJECT_INSTALL_INCDIR}
+  )
 
-# Install cmake modules
-install(FILES cmake/FindZeroMQ.cmake
-  DESTINATION ${PROJECT_INSTALL_CMAKEMODDIR}
-)
+  install(FILES cmake/FindZeroMQ.cmake
+    DESTINATION ${PROJECT_INSTALL_CMAKEMODDIR}
+  )
+endif()
 if(BUILD_DDS_PLUGIN)
   install(FILES cmake/FindDDS.cmake
     DESTINATION ${PROJECT_INSTALL_CMAKEMODDIR}
@@ -112,35 +151,68 @@ if(BUILD_OFI_TRANSPORT)
     DESTINATION ${PROJECT_INSTALL_CMAKEMODDIR}
   )
 endif()
+if(BUILD_DOCS)
+  install(DIRECTORY ${CMAKE_BINARY_DIR}/doxygen/html
+    DESTINATION ${PROJECT_INSTALL_DATADIR}/docs
+  )
+endif()
 
 install_cmake_package()
 ################################################################################
 
 
 # Summary ######################################################################
-message(STATUS "  ")
-message(STATUS "  ${Cyan}DEPENDENCY      VERSION              ${CR}")
-foreach(dep IN LISTS PROJECT_PACKAGE_DEPENDENCIES)
-  if(${dep}_VERSION)
-    if(${dep} STREQUAL Boost)
-      set(version_str "${BGreen}${${dep}_MAJOR_VERSION}.${${dep}_MINOR_VERSION}${CR}")
+if(PROJECT_PACKAGE_DEPENDENCIES)
+  message(STATUS "  ")
+  message(STATUS "  ${Cyan}DEPENDENCY FOUND     VERSION                   PREFIX${CR}")
+  foreach(dep IN LISTS PROJECT_PACKAGE_DEPENDENCIES)
+    if(${dep}_VERSION)
+      if(${dep} STREQUAL Boost)
+        set(version_str "${BGreen}${${dep}_MAJOR_VERSION}.${${dep}_MINOR_VERSION}${CR}")
+      else()
+        set(version_str "${BGreen}${${dep}_VERSION}${CR}")
+      endif()
     else()
-      set(version_str "${BGreen}${${dep}_VERSION}${CR}")
+      set(version_str "${BYellow}unknown${CR}")
     endif()
-  else()
-    set(version_str "${BYellow}unknown${CR}")
-  endif()
-  if(PROJECT_${dep}_VERSION)
-    set(version_req_str " (>= ${PROJECT_${dep}_VERSION})")
-  endif()
-  pad(${dep} 15 " " dep_padded)
-  pad("${version_str}${version_req_str}" 20 " " version_padded)
-  message(STATUS "  ${BWhite}${dep_padded}${CR}${version_padded}")
-  unset(version_str)
-endforeach()
+    if(PROJECT_${dep}_VERSION)
+      set(version_req_str " (>= ${PROJECT_${dep}_VERSION})")
+    endif()
+    pad(${dep} 20 " " dep_padded)
+    if(DISABLE_COLOR)
+      pad("${version_str}${version_req_str}" 25 " " version_padded)
+    else()
+      pad("${version_str}${version_req_str}" 25 " " version_padded COLOR 1)
+    endif()
+    if(${dep} STREQUAL FairLogger)
+      set(prefix ${FairLogger_ROOT})
+    elseif(${dep} STREQUAL GTest)
+      get_filename_component(prefix ${GTEST_INCLUDE_DIRS}/.. ABSOLUTE)
+    elseif(${dep} STREQUAL msgpack)
+      set(prefix ${msgpack_ROOT})
+    elseif(${dep} STREQUAL OFI)
+      get_filename_component(prefix ${${dep}_INCLUDE_DIRS}/.. ABSOLUTE)
+    elseif(${dep} STREQUAL Doxygen)
+      get_target_property(doxygen_bin Doxygen::doxygen INTERFACE_LOCATION)
+      get_filename_component(prefix ${doxygen_bin} DIRECTORY)
+      get_filename_component(prefix ${prefix}/.. ABSOLUTE)
+    else()
+      get_filename_component(prefix ${${dep}_INCLUDE_DIR}/.. ABSOLUTE)
+    endif()
+    message(STATUS "  ${BWhite}${dep_padded}${CR}${version_padded}${prefix}")
+    unset(version_str)
+    unset(version_padded)
+    unset(version_req_str)
+  endforeach()
+endif()
 message(STATUS "  ")
 message(STATUS "  ${Cyan}COMPONENT         BUILT?  INFO${CR}")
-message(STATUS "  ${BWhite}fairmq${CR}             ${BGreen}YES${CR}    (default, always built)")
+if(BUILD_FAIRMQ)
+  set(fairmq_summary "${BGreen}YES${CR}    (default, disable with ${BMagenta}-DBUILD_FAIRMQ=OFF${CR})")
+else()
+  set(fairmq_summary "${BRed} NO${CR}    (enable with ${BMagenta}-DBUILD_FAIRMQ=ON${CR})")
+endif()
+message(STATUS "  ${BWhite}fairmq${CR}             ${fairmq_summary}")
 if(BUILD_TESTING)
   set(tests_summary "${BGreen}YES${CR}    (default, disable with ${BMagenta}-DBUILD_TESTING=OFF${CR})")
 else()
@@ -165,5 +237,17 @@ 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_EXAMPLES)
+  set(examples_summary "${BGreen}YES${CR}    (default, disable with ${BMagenta}-DBUILD_EXAMPLES=OFF${CR})")
+else()
+  set(examples_summary "${BRed} NO${CR}    (enable with ${BMagenta}-DBUILD_EXAMPLES=ON${CR})")
+endif()
+message(STATUS "  ${BWhite}examples${CR}           ${examples_summary}")
+if(BUILD_DOCS)
+  set(docs_summary "${BGreen}YES${CR}    (disable with ${BMagenta}-DBUILD_DOCS=OFF${CR})")
+else()
+  set(docs_summary "${BRed} NO${CR}    (default, enable with ${BMagenta}-DBUILD_DOCS=ON${CR})")
+endif()
+message(STATUS "  ${BWhite}docs${CR}               ${docs_summary}")
 message(STATUS "  ")
 ################################################################################

CONTRIBUTORS

@@ -1,3 +1,4 @@
+Aphecetche, Laurent
 Binet, Sebastien
 Eulisse, Giulio
 Karabowicz, Radoslaw

CTestConfig.cmake

@@ -0,0 +1,9 @@
+set(CTEST_PROJECT_NAME "FairMQ")
+set(CTEST_NIGHTLY_START_TIME "00:00:00 CEST")
+
+set(CTEST_DROP_METHOD "https")
+set(CTEST_DROP_SITE "cdash.gsi.de")
+set(CTEST_DROP_LOCATION "/submit.php?project=FairMQ")
+set(CTEST_DROP_SITE_CDASH TRUE)
+
+set(CTEST_TESTING_TIMEOUT 60)

Dart.sh

@@ -0,0 +1,133 @@
+#!/bin/bash
+
+
+function print_example(){
+echo "##################################################################"
+echo "# To set the required parameters as source and the build         #"
+echo "# directory for ctest, the linux flavour and the SIMPATH         #"
+echo "# put the export commands below to a separate file which is read #"
+echo "# during execution and which is defined on the command line.     #"
+echo "# Set all parameters according to your needs.                    #"
+echo "# LINUX_FLAVOUR should be set to the distribution you are using  #"
+echo "# eg Debian, SuSe etc.                                           #"
+echo "# An additional varibale NCPU can overwrite the default number   #"
+echo "# of parallel processes used to compile the project.             #"
+echo "# This can be usefull if one can use a distributed build system  #"
+echo "# like icecream.                                                 #"
+echo "# For example                                                    #"
+echo "#!/bin/bash                                                      #"
+echo "export LINUX_FLAVOUR=<your linux flavour>                        #"
+echo "export FAIRSOFT_VERSION=<version of FairSoft>                    #"
+echo "export SIMPATH=<path to your FairSoft version>                   #"
+echo "export GIT_BRANCH=< master or dev>                               #"
+echo "export BUILDDIR=<dir where the build files go>                   #"
+echo "export SOURCEDIR=<location of the FairRoot sources>              #"
+echo "#export NCPU=100                                                 #"
+echo "##################################################################"
+}
+
+if [ "$#" -lt "2" ]; then
+  echo ""
+  echo "-- Error -- Please start script with two parameters"
+  echo "-- Error -- The first parameter is the ctest model."
+  echo "-- Error -- Possible arguments are Nightly, Experimental, "
+  echo "-- Error -- Continuous or Profile."
+  echo "-- Error -- The second parameter is the file containg the"
+  echo "-- Error -- Information about the setup at the client"
+  echo "-- Error -- installation (see example below)."
+  echo ""
+  print_example
+  exit 1
+fi
+
+# test if a valid ctest model is defined
+if [ "$1" == "Experimental" -o "$1" == "Nightly" -o "$1" == "Continuous" -o "$1" == "Profile" -o "$1" == "alfa_ci" ]; then
+  echo ""
+else
+  echo "-- Error -- This ctest model is not supported."
+  echo "-- Error -- Possible arguments are Nightly, Experimental, Continuous or Profile."
+  exit 1
+fi
+
+# test if the input file exists and execute it
+if [ -e "$2" ];then
+  source $2
+else
+  echo "-- Error -- Input file does not exist."
+  echo "-- Error -- Please choose existing input file."
+  exit 1
+fi
+
+# set the ctest model to command line parameter
+if [ "$1" == "alfa_ci" ]; then
+  export ctest_model=Experimental
+else
+  export ctest_model=$1
+fi
+
+
+# test for architecture
+arch=$(uname -s | tr '[A-Z]' '[a-z]')
+chip=$(uname -m | tr '[A-Z]' '[a-z]')
+
+# extract information about the system and the machine and set
+# environment variables used by ctest
+SYSTEM=$arch-$chip
+if test -z $CXX ; then
+  if [ "$arch" == "darwin" ]; then
+    COMPILER=$(clang --version | head -n 1 | cut -d' ' -f1,2,4 | tr -d ' ')
+  else
+    COMPILER=gcc$(gcc -dumpversion)
+  fi
+else
+  COMPILER=$CXX$($CXX -dumpversion)
+fi
+
+if [ "$1" == "alfa_ci" ]; then
+  export LABEL1=alfa_ci-$COMPILER-FairMQ_$GIT_BRANCH
+  export LABEL=$(echo $LABEL1 | sed -e 's#/#_#g')
+else
+  export LABEL1=${LINUX_FLAVOUR}-$chip-$COMPILER-FairMQ_$GIT_BRANCH
+  export LABEL=$(echo $LABEL1 | sed -e 's#/#_#g')
+fi
+
+# get the number of processors
+# and information about the host
+if [ "$arch" = "linux" ];
+then
+  if [ "$NCPU" != "" ];
+  then
+    export number_of_processors=$NCPU
+  else
+    export number_of_processors=$(cat /proc/cpuinfo | grep processor | wc -l)
+  fi
+  if [ -z "$SITE" ]; then
+    export SITE=$(hostname -f)
+    if [ -z "$SITE" ]; then
+      export SITE=$(uname -n)
+    fi
+  fi
+elif [ "$arch" = "darwin" ];
+then
+  if [ "$NCPU" != "" ];
+  then
+    export number_of_processors=$NCPU
+  else
+    export number_of_processors=$(sysctl -n hw.ncpu)
+  fi
+  if [ -z "$SITE" ]; then
+    export SITE=$(hostname -s)
+  fi
+fi
+
+echo "************************"
+date
+echo "LABEL: " $LABEL
+echo "SITE: " $SITE
+echo "Model: " ${ctest_model}
+echo "Nr. of processes: " $number_of_processors
+echo "************************"
+
+cd $SOURCEDIR
+
+ctest -S FairMQTest.cmake -V --VV

FairMQTest.cmake

@@ -0,0 +1,72 @@
+################################################################################
+#    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(CTEST_SOURCE_DIRECTORY $ENV{SOURCEDIR})
+Set(CTEST_BINARY_DIRECTORY $ENV{BUILDDIR})
+Set(CTEST_SITE $ENV{SITE})
+Set(CTEST_BUILD_NAME $ENV{LABEL})
+Set(CTEST_CMAKE_GENERATOR "Unix Makefiles")
+Set(CTEST_PROJECT_NAME "FairMQ")
+
+Find_Program(CTEST_GIT_COMMAND NAMES git)
+Set(CTEST_UPDATE_COMMAND "${CTEST_GIT_COMMAND}")
+
+Set(BUILD_COMMAND "make")
+Set(CTEST_BUILD_COMMAND "${BUILD_COMMAND} -j$ENV{number_of_processors}")
+
+String(TOUPPER $ENV{ctest_model} _Model)
+Set(configure_options "-DCMAKE_BUILD_TYPE=${_Model}")
+
+Set(CTEST_USE_LAUNCHERS 1)
+Set(configure_options "${configure_options};-DCTEST_USE_LAUNCHERS=${CTEST_USE_LAUNCHERS}")
+
+Set(configure_options "${configure_options};-DDISABLE_COLOR=ON")
+Set(configure_options "${configure_options};-DCMAKE_PREFIX_PATH=$ENV{SIMPATH}")
+Set(configure_options "${configure_options};-DBUILD_NANOMSG_TRANSPORT=ON")
+Set(configure_options "${configure_options};-DBUILD_DDS_PLUGIN=ON")
+
+Set(EXTRA_FLAGS $ENV{EXTRA_FLAGS})
+If(EXTRA_FLAGS)
+  Set(configure_options "${configure_options};${EXTRA_FLAGS}") 
+EndIf()
+
+If($ENV{ctest_model} MATCHES Nightly OR $ENV{ctest_model} MATCHES Profile)
+
+  Find_Program(GCOV_COMMAND gcov)
+  If(GCOV_COMMAND)
+    Message("Found GCOV: ${GCOV_COMMAND}")
+    Set(CTEST_COVERAGE_COMMAND ${GCOV_COMMAND})
+  EndIf(GCOV_COMMAND)
+
+  Set(ENV{ctest_model} Nightly)
+
+  CTEST_EMPTY_BINARY_DIRECTORY(${CTEST_BINARY_DIRECTORY})
+
+EndIf()
+
+Ctest_Start($ENV{ctest_model})
+
+Ctest_Configure(BUILD "${CTEST_BINARY_DIRECTORY}"
+                OPTIONS "${configure_options}"
+               )
+
+Ctest_Build(BUILD "${CTEST_BINARY_DIRECTORY}")
+
+Ctest_Test(BUILD "${CTEST_BINARY_DIRECTORY}" 
+           PARALLEL_LEVEL $ENV{number_of_processors}
+           RETURN_VALUE _ctest_test_ret_val
+          )
+
+If(GCOV_COMMAND)
+  Ctest_Coverage(BUILD "${CTEST_BINARY_DIRECTORY}")
+EndIf()
+
+Ctest_Submit()
+ 
+if (_ctest_test_ret_val)
+  Message(FATAL_ERROR "Some tests failed.")
+endif()

Jenkinsfile

@@ -0,0 +1,56 @@
+#!groovy
+
+def specToLabel(Map spec) {
+  return "${spec.os}-${spec.arch}-${spec.compiler}-FairSoft_${spec.fairsoft}"
+}
+
+def buildMatrix(List specs, Closure callback) {
+  def nodes = [:]
+  for (spec in specs) {
+    def label = specToLabel(spec)
+    nodes[label] = {
+      node(label) {
+        githubNotify(context: "alfa-ci/${label}", description: 'Building ...', status: 'PENDING')
+        try {
+          deleteDir()
+          checkout scm
+
+          callback.call(spec, label)
+
+          deleteDir()
+          githubNotify(context: "alfa-ci/${label}", description: 'Success', status: 'SUCCESS')
+        } catch (e) {
+          deleteDir()
+          githubNotify(context: "alfa-ci/${label}", description: 'Error', status: 'ERROR')
+          throw e
+        }
+      }
+    }
+  }
+  return nodes
+}
+
+pipeline{
+  agent none
+  stages {
+    stage("Run Build/Test Matrix") {
+      steps{
+        script {
+          parallel(buildMatrix([
+            [os: 'Debian8',    arch: 'x86_64', compiler: 'gcc4.9',         fairsoft: 'may18'],
+            [os: 'MacOS10.11', arch: 'x86_64', compiler: 'AppleLLVM8.0.0', fairsoft: 'may18'],
+            [os: 'MacOS10.13', arch: 'x86_64', compiler: 'AppleLLVM9.0.0', fairsoft: 'may18'],
+          ]) { spec, label ->
+            sh '''\
+              echo "export BUILDDIR=$PWD/build" >> Dart.cfg
+              echo "export SOURCEDIR=$PWD" >> Dart.cfg
+              echo "export PATH=$SIMPATH/bin:$PATH" >> Dart.cfg
+              echo "export GIT_BRANCH=$JOB_BASE_NAME" >> Dart.cfg
+            '''
+            sh './Dart.sh alfa_ci Dart.cfg'
+          })
+        }
+      }
+    }
+  }
+}

Jenkinsfile.nightly

@@ -0,0 +1,55 @@
+#!groovy
+
+def specToLabel(Map spec) {
+  return "${spec.os}-${spec.arch}-${spec.compiler}-FairSoft_${spec.fairsoft}"
+}
+
+def buildMatrix(List specs, Closure callback) {
+  def nodes = [:]
+  for (spec in specs) {
+    def label = specToLabel(spec)
+    nodes[label] = {
+      node(label) {
+        try {
+          deleteDir()
+          checkout scm
+
+          callback.call(spec, label)
+
+          deleteDir()
+        } catch (e) {
+          deleteDir()
+          throw e
+        }
+      }
+    }
+  }
+  return nodes
+}
+
+pipeline{
+  agent none
+  triggers { cron('H 2 * * *') }
+  stages {
+    stage("Run Nightly Build/Test Matrix") {
+      steps{
+        script {
+          parallel(buildMatrix([
+            [os: 'Debian8',    arch: 'x86_64', compiler: 'gcc4.9',         fairsoft: 'may18'],
+            [os: 'MacOS10.11', arch: 'x86_64', compiler: 'AppleLLVM8.0.0', fairsoft: 'may18'],
+            [os: 'MacOS10.13', arch: 'x86_64', compiler: 'AppleLLVM9.0.0', fairsoft: 'may18'],
+          ]) { spec, label ->
+            sh '''\
+              echo "export BUILDDIR=$PWD/build" >> Dart.cfg
+              echo "export SOURCEDIR=$PWD" >> Dart.cfg
+              echo "export PATH=$SIMPATH/bin:$PATH" >> Dart.cfg
+              echo "export GIT_BRANCH=dev" >> Dart.cfg
+            '''
+            sh './Dart.sh Nightly Dart.cfg'
+            sh './Dart.sh Profile Dart.cfg'
+          })
+        }
+      }
+    }
+  }
+}

LICENSE

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

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+Replace me with your description.
+
+---
+
+Checklist:
+
+* [ ] Rebased against `dev` branch
+* [ ] My name is in the resp. CONTRIBUTORS/AUTHORS file
+* [ ] Followed [the seven rules of great commit messages](https://chris.beams.io/posts/git-commit/#seven-rules)

README.md

@@ -1,39 +1,70 @@
+<!-- {#mainpage} -->
 # FairMQ
 
-C++ Message Queuing Library
+C++ Message passing framework
+
+| Branch | Build Status |
+| :---: | :--- |
+| `master` | ![build status master branch](https://alfa-ci.gsi.de/buildStatus/icon?job=FairRootGroup/FairMQ/master) |
+| `dev` | ![build status dev branch](https://alfa-ci.gsi.de/buildStatus/icon?job=FairRootGroup/FairMQ/dev) |
+
+FairMQ is designed to help implementing large-scale data processing workflows needed in next-generation Particle Physics experiments. FairMQ is written in C++ and aims to
+  * provide **an asynchronous message passing abstraction** of different data transport technologies,
+  * provide a reasonably **efficient data transport** service (zero-copy, high throughput),
+  * be **data format agnostic**, and
+  * provide **basic building blocks** that can be used to implement higher level data processing workflows.
+
+The core of FairMQ provides an abstract asynchronous message passing API with scalability protocols
+inspired by [ZeroMQ](https://github.com/zeromq/libzmq) (e.g. PUSH/PULL, PUB/SUB).
+FairMQ provides multiple implementations for its API (so-called "transports",
+e.g. `zeromq`, `shmem`, `nanomsg`, 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 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.
 
 ## Dependencies
 
-  * **Boost** (PUBLIC)
-  * **FairLogger** (PUBLIC)
-  * CMake
-  * dl
-  * pthread
-  * rt (Linux)
-  * ZeroMQ
-  * GTest (optional, `tests`)
-  * Msgpack (optional, `nanomsg_transport`)
-  * nanomsg (optional, `nanomsg_transport`)
-  * OFI (optional, `ofi_transport`)
-  * Protobuf (optional, `ofi_transport`)
-  * DDS (optional, `dds_plugin`)
+  * [**Boost**](https://www.boost.org/) (PUBLIC)
+  * [**FairLogger**](https://github.com/FairRootGroup/FairLogger) (PUBLIC)
+  * [CMake](https://cmake.org/) (BUILD)
+  * [GTest](https://github.com/google/googletest) (BUILD, optional, `tests`)
+  * [Doxygen](http://www.doxygen.org/) (BUILD, optional, `docs`)
+  * [ZeroMQ](http://zeromq.org/) (PRIVATE)
+  * [Msgpack](https://msgpack.org/index.html) (PRIVATE, optional, `nanomsg_transport`)
+  * [nanomsg](http://nanomsg.org/) (PRIVATE, optional, `nanomsg_transport`)
+  * [OFI](https://ofiwg.github.io/libfabric/) (PRIVATE, optional, `ofi_transport`)
+  * [Protobuf](https://developers.google.com/protocol-buffers/) (PRIVATE, optional, `ofi_transport`)
+  * [DDS](http://dds.gsi.de) (PRIVATE, optional, `dds_plugin`)
 
-## Installation
+  Supported platforms: Linux and MacOS.
+
+## Releases
+
+| Stable release | Date | API Docs |
+| --- | --- | --- |
+| [**1.2.3**](https://github.com/FairRootGroup/FairMQ/releases/tag/v1.2.3) | May 2018 | [link](https://fairrootgroup.github.io/FairMQ/v1.2.3/index.html) |
+| [**1.2.1**](https://github.com/FairRootGroup/FairMQ/releases/tag/v1.2.1) | May 2018 | [link](https://fairrootgroup.github.io/FairMQ/v1.2.1/index.html) |
+| [**1.2.0**](https://github.com/FairRootGroup/FairMQ/releases/tag/v1.2.0) | May 2018 | [link](https://fairrootgroup.github.io/FairMQ/v1.2.0/index.html) |
+
+Find all FairMQ stable and development releases [here](https://github.com/FairRootGroup/FairMQ/releases).
+
+## Installation from Source
 
 ```bash
-git clone https://github.com/FairRootGroup/FairMQ
+git clone https://github.com/FairRootGroup/FairMQ fairmq
 mkdir fairmq_build && cd fairmq_build
 cmake -DCMAKE_INSTALL_PREFIX=./fairmq_install ../fairmq
 cmake --build . --target install
 ```
 
-If dependencies are not installed in standard system
-directories, you can hint the installation location
-via `-DCMAKE_PREFIX_PATH=...` or per dependency via
-`-D{DEPENDENCY}_ROOT=...`. `{DEPENDENCY}` can be `GTEST`,
-`BOOST`, `FAIRLOGGER`, `ZEROMQ`, `MSGPACK`, `NANOMSG`,
-`OFI`, `PROTOBUF`, or `DDS` (`*_ROOT` variables can also
-be environment variables).
+If dependencies are not installed in standard system directories, you can hint the installation location via `-DCMAKE_PREFIX_PATH=...` or per dependency via `-D{DEPENDENCY}_ROOT=...`. `{DEPENDENCY}` can be `GTEST`, `BOOST`, `FAIRLOGGER`, `ZEROMQ`, `MSGPACK`, `NANOMSG`, `OFI`, `PROTOBUF`, or `DDS` (`*_ROOT` variables can also be environment variables).
 
 ## Usage
 
@@ -50,16 +81,16 @@ set(CMAKE_PREFIX_PATH /path/to/FairMQ_install_prefix ${CMAKE_PREFIX_PATH})
 find_package(FairMQ)
 ```
 
-`find_package(FairMQ)` will define an imported target `FairMQ::FairMQ` (An alias `FairRoot::FairMQ`
-is also defined for backwards compatibility, but it is deprecated).
+`find_package(FairMQ)` will define an imported target `FairMQ::FairMQ`.
 
-In order to succesfully compile and link against the `FairMQ::FairMQ` target,
-you need to discover its public package dependencies, too.
+In order to succesfully compile and link against the `FairMQ::FairMQ` target, you need to discover its public package dependencies, too.
 
 ```cmake
 find_package(FairMQ)
-find_package(FairLogger ${FairMQ_FairLogger_VERSION})
-find_package(Boost ${FairMQ_Boost_VERSION} COMPONENTS ${FairMQ_BOOST_COMPONENTS})
+if(FairMQ_FOUND)
+  find_package(FairLogger ${FairMQ_FairLogger_VERSION})
+  find_package(Boost ${FairMQ_Boost_VERSION} COMPONENTS ${FairMQ_BOOST_COMPONENTS})
+endif()
 ```
 
 Of course, feel free to customize the above commands to your needs.
@@ -68,8 +99,10 @@ Optionally, you can require certain FairMQ package components and a minimum vers
 
 ```cmake
 find_package(FairMQ 1.1.0 COMPONENTS nanomsg_transport dds_plugin)
-find_package(FairLogger ${FairMQ_FairLogger_VERSION})
-find_package(Boost ${FairMQ_Boost_VERSION} COMPONENTS ${FairMQ_BOOST_COMPONENTS})
+if(FairMQ_FOUND)
+  find_package(FairLogger ${FairMQ_FairLogger_VERSION})
+  find_package(Boost ${FairMQ_Boost_VERSION} COMPONENTS ${FairMQ_BOOST_COMPONENTS})
+endif()
 ```
 
 When building FairMQ, CMake will print a summary table of all available package components.
@@ -80,22 +113,37 @@ 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_NANOMSG_TRANSPORT=ON` enables building of nanomsg transport.
   * `-DBUILD_OFI_TRANSPORT=ON` enables building of the experimental OFI transport.
   * `-DBUILD_DDS_PLUGIN=ON` enables building of the DDS plugin.
+  * `-DBUILD_DOCS=ON` enables building of API docs.
   * You can hint non-system installations for dependent packages, see the #Installation section above
 
 After the `find_package(FairMQ)` call the following CMake variables are defined:
 
-  * `${FairMQ_Boost_VERSION}` contains the minimum Boost version FairMQ requires.
-  * `${FairMQ_Boost_COMPONENTS}` contains the list of Boost components FairMQ depends on.
-  * `${FairMQ_FairLogger_VERSION}` contains the minimum FairLogger version FairMQ requires.
-  * ... TODO
+| Variable | Info |
+| --- | --- |
+| `${FairMQ_PACKAGE_DEPENDENCIES}` | the list of public package dependencies |
+| `${FairMQ_Boost_VERSION}` | the minimum Boost version FairMQ requires |
+| `${FairMQ_Boost_COMPONENTS}` | the list of Boost components FairMQ depends on |
+| `${FairMQ_FairLogger_VERSION}` | the minimum FairLogger version FairMQ requires |
+| `${FairMQ_PACKAGE_COMPONENTS}` | the list of components FairMQ consists of |
+| `${FairMQ_#COMPONENT#_FOUND}` | `TRUE` if this component was built |
+| `${FairMQ_VERSION}` | the version in format `MAJOR.MINOR.PATCH` |
+| `${FairMQ_GIT_VERSION}` | the version in the format returned by `git describe --tags --dirty --match "v*"` |
+| `${FairMQ_ROOT}` | the actual installation prefix, notice the difference to the hint variable `FAIRMQ_ROOT` |
+| `${FairMQ_BINDIR}` | the installation bin directory |
+| `${FairMQ_INCDIR}` | the installation include directory |
+| `${FairMQ_LIBDIR}` | the installation lib directory |
+| `${FairMQ_DATADIR}` | the installation data directory (`../share/fairmq`) |
+| `${FairMQ_CMAKEMODDIR}` | the installation directory of shipped CMake find modules |
+| `${FairMQ_CXX_STANDARD_REQUIRED}` | the value of `CMAKE_CXX_STANDARD_REQUIRED` at built-time |
+| `${FairMQ_CXX_STANDARD}` | the value of `CMAKE_CXX_STANDARD` at built-time |
+| `${FairMQ_CXX_EXTENSIONS}` | the values of `CMAKE_CXX_EXTENSIONS` at built-time |
 
 ## Documentation
 
-Standard [FairRoot](https://github.com/FairRootGroup/FairRoot) is running all the different analysis tasks within one process. FairMQ ([Message Queue](http://en.wikipedia.org/wiki/Message_queue)) allows starting tasks on different processes and provides the communication layer between these processes.
-
 1. [Device](docs/Device.md#1-device)
    1. [Topology](docs/Device.md#11-topology)
    2. [Communication Patterns](docs/Device.md#12-communication-patterns)

cmake/FairMQConfig.cmake.in

@@ -6,8 +6,6 @@
 #                  copied verbatim in the file "LICENSE"                       #
 ################################################################################
 
-cmake_minimum_required(VERSION 3.9.4 FATAL_ERROR)
-
 @PACKAGE_INIT@
 
 ### General variables for project discovery/inspection
@@ -22,6 +20,10 @@ set_and_check(@PROJECT_NAME@_LIBDIR @PACKAGE_CMAKE_INSTALL_PREFIX@/@PROJECT_INST
 set_and_check(@PROJECT_NAME@_DATADIR @PACKAGE_CMAKE_INSTALL_PREFIX@/@PROJECT_INSTALL_DATADIR@)
 set_and_check(@PROJECT_NAME@_CMAKEMODDIR @PACKAGE_CMAKE_INSTALL_PREFIX@/@PROJECT_INSTALL_CMAKEMODDIR@)
 
+set(@PROJECT_NAME@_CXX_STANDARD_REQUIRED @CMAKE_CXX_STANDARD_REQUIRED@)
+set(@PROJECT_NAME@_CXX_STANDARD @CMAKE_CXX_STANDARD@)
+set(@PROJECT_NAME@_CXX_EXTENSIONS @CMAKE_CXX_EXTENSIONS@)
+
 ### Import cmake modules
 set(CMAKE_MODULE_PATH ${@PROJECT_NAME@_CMAKEMODDIR} ${CMAKE_MODULE_PATH})
 
@@ -30,9 +32,4 @@ set(CMAKE_MODULE_PATH ${@PROJECT_NAME@_CMAKEMODDIR} ${CMAKE_MODULE_PATH})
 ### Import targets
 include(@PACKAGE_CMAKE_INSTALL_PREFIX@/@PACKAGE_INSTALL_DESTINATION@/@PROJECT_EXPORT_SET@.cmake)
 
-### Alias target for backwards compat (DEPRECATED)
-if(NOT TARGET FairRoot::@PROJECT_NAME@)
-  add_library(FairRoot::@PROJECT_NAME@ ALIAS @PROJECT_NAME@::@PROJECT_NAME@)
-endif()
-
 @PACKAGE_COMPONENTS@

cmake/FairMQLib.cmake

@@ -112,18 +112,19 @@ macro(set_fairmq_defaults)
     set(CMAKE_BUILD_TYPE RelWithDebInfo)
   endif()
 
+
   # Handle C++ standard level
   set(CMAKE_CXX_STANDARD_REQUIRED ON)
   if(NOT CMAKE_CXX_STANDARD)
     set(CMAKE_CXX_STANDARD 11)
   elseif(${CMAKE_CXX_STANDARD} LESS 11)
     message(FATAL_ERROR "A minimum CMAKE_CXX_STANDARD of 11 is required.")
+  elseif(${CMAKE_CXX_STANDARD} GREATER 11)
+    message(WARNING "A CMAKE_CXX_STANDARD of ${CMAKE_CXX_STANDARD} (greater than 11) is not tested. Use on your own risk.")
   endif()
-  if(NOT CMAKE_CXX_EXTENSIONS)
-    set(CMAKE_CXX_EXTENSIONS OFF)
-  endif()
+  set(CMAKE_CXX_EXTENSIONS OFF)
 
-  # Set -fpic as default for all library types
+  # Set -fPIC as default for all library types
   set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
   # Generate compile_commands.json file (https://clang.llvm.org/docs/JSONCompilationDatabase.html)
@@ -134,20 +135,32 @@ macro(set_fairmq_defaults)
 
   # Define install dirs
   set(PROJECT_INSTALL_BINDIR ${CMAKE_INSTALL_BINDIR})
-  set(PROJECT_INSTALL_LIBDIR ${CMAKE_INSTALL_LIBDIR}/${PROJECT_NAME_LOWER})
+  set(PROJECT_INSTALL_LIBDIR ${CMAKE_INSTALL_LIBDIR})
   set(PROJECT_INSTALL_INCDIR ${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME_LOWER})
   set(PROJECT_INSTALL_DATADIR ${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME_LOWER})
   set(PROJECT_INSTALL_CMAKEMODDIR ${PROJECT_INSTALL_DATADIR}/cmake)
 
-  # https://cmake.org/Wiki/CMake_RPATH_handling#Always_full_RPATH
+  # https://cmake.org/Wiki/CMake_RPATH_handling
   set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
   list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_LIBDIR}" isSystemDir)
   if("${isSystemDir}" STREQUAL "-1")
-    set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_LIBDIR}")
+    if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
+      set(CMAKE_EXE_LINKER_FLAGS ${CMAKE_EXE_LINKER_FLAGS} "-Wl,--enable-new-dtags")
+      set(CMAKE_SHARED_LINKER_FLAGS ${CMAKE_SHARED_LINKER_FLAGS} "-Wl,--enable-new-dtags")
+      set(CMAKE_INSTALL_RPATH "$ORIGIN/../${PROJECT_INSTALL_LIBDIR}")
+    elseif(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
+      set(CMAKE_INSTALL_RPATH "@loader_path/../${PROJECT_INSTALL_LIBDIR}")
+    else()
+      set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_LIBDIR}")
+    endif()
   endif()
 
   # Define export set, only one for now
   set(PROJECT_EXPORT_SET ${PROJECT_NAME}Targets)
+
+  # Override CMake defaults
+  set(CMAKE_CXX_FLAGS_NIGHTLY "-O2 -g -Wshadow -Wall -Wextra")
+  set(CMAKE_CXX_FLAGS_PROFILE "-g3 -fno-inline -ftest-coverage -fprofile-arcs -Wshadow -Wall -Wextra -Wunused-variable")
 endmacro()
 
 function(join VALUES GLUE OUTPUT)
@@ -157,8 +170,13 @@ function(join VALUES GLUE OUTPUT)
 endfunction()
 
 function(pad str width char out)
+  cmake_parse_arguments(ARGS "" "COLOR" "" ${ARGN})
   string(LENGTH ${str} length)
-  math(EXPR padding "${width}-${length}")
+  if(ARGS_COLOR)
+    math(EXPR padding "${width}-(${length}-10*${ARGS_COLOR})")
+  else()
+    math(EXPR padding "${width}-${length}")
+  endif()
   if(padding GREATER 0)
     foreach(i RANGE ${padding})
       set(str "${str}${char}")
@@ -221,11 +239,13 @@ macro(install_cmake_package)
   set(PACKAGE_INSTALL_DESTINATION
     ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}-${PROJECT_VERSION}
   )
-  install(EXPORT ${PROJECT_EXPORT_SET}
-    NAMESPACE ${PROJECT_NAME}::
-    DESTINATION ${PACKAGE_INSTALL_DESTINATION}
-    EXPORT_LINK_INTERFACE_LIBRARIES
-  )
+  if(BUILD_FAIRMQ)
+    install(EXPORT ${PROJECT_EXPORT_SET}
+      NAMESPACE ${PROJECT_NAME}::
+      DESTINATION ${PACKAGE_INSTALL_DESTINATION}
+      EXPORT_LINK_INTERFACE_LIBRARIES
+    )
+  endif()
   write_basic_package_version_file(
     ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake
     VERSION ${PROJECT_VERSION}
@@ -246,34 +266,34 @@ macro(install_cmake_package)
   )
 endmacro()
 
-function(find_package2 qualifier pkgname)
+macro(find_package2 qualifier pkgname)
   cmake_parse_arguments(ARGS "" "VERSION" "COMPONENTS" ${ARGN})
 
   string(TOUPPER ${pkgname} pkgname_upper)
+  set(old_CPP ${CMAKE_PREFIX_PATH})
   set(CMAKE_PREFIX_PATH ${${pkgname_upper}_ROOT} $ENV{${pkgname_upper}_ROOT} ${CMAKE_PREFIX_PATH})
   if(ARGS_COMPONENTS)
     find_package(${pkgname} ${ARGS_VERSION} QUIET COMPONENTS ${ARGS_COMPONENTS} ${ARGS_UNPARSED_ARGUMENTS})
   else()
     find_package(${pkgname} ${ARGS_VERSION} QUIET ${ARGS_UNPARSED_ARGUMENTS})
   endif()
+  set(CMAKE_PREFIX_PATH ${old_CPP})
+  unset(old_CPP)
 
-  set(${pkgname}_VERSION ${${pkgname}_VERSION} PARENT_SCOPE)
-  set(${pkgname}_MAJOR_VERSION ${${pkgname}_MAJOR_VERSION} PARENT_SCOPE)
-  set(${pkgname}_MINOR_VERSION ${${pkgname}_MINOR_VERSION} PARENT_SCOPE)
-  if(qualifier STREQUAL PRIVATE)
-    set(PROJECT_${pkgname}_VERSION ${ARGS_VERSION} PARENT_SCOPE)
-    set(PROJECT_${pkgname}_COMPONENTS ${ARGS_COMPONENTS} PARENT_SCOPE)
-    set(PROJECT_PACKAGE_DEPENDENCIES ${PROJECT_PACKAGE_DEPENDENCIES} ${pkgname} PARENT_SCOPE)
-  elseif(qualifier STREQUAL PUBLIC)
-    set(PROJECT_${pkgname}_VERSION ${ARGS_VERSION} PARENT_SCOPE)
-    set(PROJECT_${pkgname}_COMPONENTS ${ARGS_COMPONENTS} PARENT_SCOPE)
-    set(PROJECT_PACKAGE_DEPENDENCIES ${PROJECT_PACKAGE_DEPENDENCIES} ${pkgname} PARENT_SCOPE)
-    set(PROJECT_INTERFACE_${pkgname}_VERSION ${ARGS_VERSION} PARENT_SCOPE)
-    set(PROJECT_INTERFACE_${pkgname}_COMPONENTS ${ARGS_COMPONENTS} PARENT_SCOPE)
-    set(PROJECT_INTERFACE_PACKAGE_DEPENDENCIES ${PROJECT_INTERFACE_PACKAGE_DEPENDENCIES} ${pkgname} PARENT_SCOPE)
-  elseif(qualifier STREQUAL INTERFACE)
-    set(PROJECT_INTERFACE_${pkgname}_VERSION ${ARGS_VERSION} PARENT_SCOPE)
-    set(PROJECT_INTERFACE_${pkgname}_COMPONENTS ${ARGS_COMPONENTS} PARENT_SCOPE)
-    set(PROJECT_INTERFACE_PACKAGE_DEPENDENCIES ${PROJECT_INTERFACE_PACKAGE_DEPENDENCIES} ${pkgname} PARENT_SCOPE)
+  if(${qualifier} STREQUAL PRIVATE)
+    set(PROJECT_${pkgname}_VERSION ${ARGS_VERSION})
+    set(PROJECT_${pkgname}_COMPONENTS ${ARGS_COMPONENTS})
+    set(PROJECT_PACKAGE_DEPENDENCIES ${PROJECT_PACKAGE_DEPENDENCIES} ${pkgname})
+  elseif(${qualifier} STREQUAL PUBLIC)
+    set(PROJECT_${pkgname}_VERSION ${ARGS_VERSION})
+    set(PROJECT_${pkgname}_COMPONENTS ${ARGS_COMPONENTS})
+    set(PROJECT_PACKAGE_DEPENDENCIES ${PROJECT_PACKAGE_DEPENDENCIES} ${pkgname})
+    set(PROJECT_INTERFACE_${pkgname}_VERSION ${ARGS_VERSION})
+    set(PROJECT_INTERFACE_${pkgname}_COMPONENTS ${ARGS_COMPONENTS})
+    set(PROJECT_INTERFACE_PACKAGE_DEPENDENCIES ${PROJECT_INTERFACE_PACKAGE_DEPENDENCIES} ${pkgname})
+  elseif(${qualifier} STREQUAL INTERFACE)
+    set(PROJECT_INTERFACE_${pkgname}_VERSION ${ARGS_VERSION})
+    set(PROJECT_INTERFACE_${pkgname}_COMPONENTS ${ARGS_COMPONENTS})
+    set(PROJECT_INTERFACE_PACKAGE_DEPENDENCIES ${PROJECT_INTERFACE_PACKAGE_DEPENDENCIES} ${pkgname})
   endif()
-endfunction()
+endmacro()

cmake/FindZeroMQ.cmake

@@ -93,11 +93,12 @@ find_package_handle_standard_args(ZeroMQ
     VERSION_VAR ZeroMQ_VERSION
 )
 
-if(ZeroMQ_FOUND AND NOT TARGET ZeroMQ)
-  add_library(ZeroMQ SHARED IMPORTED)
-  set_target_properties(ZeroMQ PROPERTIES
+if(ZeroMQ_FOUND AND NOT TARGET libzmq)
+  add_library(libzmq SHARED IMPORTED)
+  set_target_properties(libzmq PROPERTIES
     IMPORTED_LOCATION ${ZeroMQ_LIBRARY_SHARED}
     INTERFACE_INCLUDE_DIRECTORIES ${ZeroMQ_INCLUDE_DIR}
+    INTERFACE_LINK_LIBRARIES "$<$<PLATFORM_ID:Linux>:rt>;pthread"
   )
 endif()
 

cmake/Findnanomsg.cmake

@@ -6,14 +6,14 @@
 #                  copied verbatim in the file "LICENSE"                       #
 ################################################################################
 
-find_path(NANOMSG_INCLUDE_DIR
+find_path(nanomsg_INCLUDE_DIR
   NAMES nanomsg/nn.h
   HINTS ${NANOMSG_ROOT} $ENV{NANOMSG_ROOT}
   PATH_SUFFIXES include
   DOC "Path to nanomsg include header files."
 )
 
-find_library(NANOMSG_LIBRARY_SHARED
+find_library(nanomsg_LIBRARY_SHARED
   NAMES libnanomsg.dylib libnanomsg.so
   HINTS ${NANOMSG_ROOT} $ENV{NANOMSG_ROOT}
   PATH_SUFFIXES lib
@@ -22,13 +22,13 @@ find_library(NANOMSG_LIBRARY_SHARED
 
 include(FindPackageHandleStandardArgs)
 find_package_handle_standard_args(nanomsg
-  REQUIRED_VARS NANOMSG_LIBRARY_SHARED NANOMSG_INCLUDE_DIR
+  REQUIRED_VARS nanomsg_LIBRARY_SHARED nanomsg_INCLUDE_DIR
 )
 
 if(NOT TARGET nanomsg AND nanomsg_FOUND)
   add_library(nanomsg SHARED IMPORTED)
   set_target_properties(nanomsg PROPERTIES
-    IMPORTED_LOCATION ${NANOMSG_LIBRARY_SHARED}
-    INTERFACE_INCLUDE_DIRECTORIES ${NANOMSG_INCLUDE_DIR}
+    IMPORTED_LOCATION ${nanomsg_LIBRARY_SHARED}
+    INTERFACE_INCLUDE_DIRECTORIES ${nanomsg_INCLUDE_DIR}
   )
 endif()

docs/footer.html

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

examples/1-1/CMakeLists.txt

@@ -0,0 +1,65 @@
+################################################################################
+#    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+add_library(Example11Lib STATIC
+    "Sampler.cxx"
+    "Sampler.h"
+    "Sink.cxx"
+    "Sink.h"
+)
+
+target_link_libraries(Example11Lib PUBLIC FairMQ)
+
+add_executable(fairmq-ex-1-1-sampler runSampler.cxx)
+target_link_libraries(fairmq-ex-1-1-sampler PRIVATE Example11Lib)
+
+add_executable(fairmq-ex-1-1-sink runSink.cxx)
+target_link_libraries(fairmq-ex-1-1-sink PRIVATE Example11Lib)
+
+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: ")
+
+if(BUILD_NANOMSG_TRANSPORT)
+  add_test(NAME Example-1-1-nanomsg COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-1-1.sh nanomsg)
+  set_tests_properties(Example-1-1-nanomsg PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received: ")
+endif()
+
+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/README.md

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

examples/1-1/Sampler.cxx

@@ -0,0 +1,76 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sampler.cpp
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include <thread> // this_thread::sleep_for
+#include <chrono>
+
+#include "Sampler.h"
+
+using namespace std;
+
+namespace example_1_1
+{
+
+Sampler::Sampler()
+    : fText()
+    , fMaxIterations(0)
+    , fNumIterations(0)
+{
+}
+
+void Sampler::InitTask()
+{
+    // Get the fText and fMaxIterations values from the command line options (via fConfig)
+    fText = fConfig->GetValue<string>("text");
+    fMaxIterations = fConfig->GetValue<uint64_t>("max-iterations");
+}
+
+bool Sampler::ConditionalRun()
+{
+    // create a copy of the data with new(), that will be deleted after the transfer is complete
+    string* text = new string(fText);
+
+    // create message object with a pointer to the data buffer,
+    // its size,
+    // custom deletion function (called when transfer is done),
+    // and pointer to the object managing the data buffer
+    FairMQMessagePtr msg(NewMessage(const_cast<char*>(text->c_str()),
+                                    text->length(),
+                                    [](void* /*data*/, void* object) { delete static_cast<string*>(object); },
+                                    text));
+
+    LOG(info) << "Sending \"" << fText << "\"";
+
+    // in case of error or transfer interruption, return false to go to IDLE state
+    // successfull transfer will return number of bytes transfered (can be 0 if sending an empty message).
+    if (Send(msg, "data") < 0)
+    {
+        return false;
+    }
+    else if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations)
+    {
+        LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+        return false;
+    }
+
+    this_thread::sleep_for(chrono::seconds(1));
+
+    return true;
+}
+
+Sampler::~Sampler()
+{
+}
+
+} // namespace example_1_1

examples/1-1/Sampler.h

@@ -0,0 +1,42 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sampler.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLE11SAMPLER_H
+#define FAIRMQEXAMPLE11SAMPLER_H
+
+#include <string>
+
+#include "FairMQDevice.h"
+
+namespace example_1_1
+{
+
+class Sampler : public FairMQDevice
+{
+  public:
+    Sampler();
+    virtual ~Sampler();
+
+  protected:
+    std::string fText;
+    uint64_t fMaxIterations;
+    uint64_t fNumIterations;
+
+    void InitTask() override;
+    bool ConditionalRun() override;
+};
+
+} // namespace example_1_1
+
+#endif /* FAIRMQEXAMPLE11SAMPLER_H */

examples/1-1/Sink.cxx

@@ -0,0 +1,55 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sink.cxx
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include "Sink.h"
+
+using namespace std;
+
+namespace example_1_1
+{
+
+Sink::Sink()
+    : fMaxIterations(0)
+    , fNumIterations(0)
+{
+    // register a handler for data arriving on "data" channel
+    OnData("data", &Sink::HandleData);
+}
+
+void Sink::InitTask()
+{
+    // Get the fMaxIterations value from the command line options (via fConfig)
+    fMaxIterations = fConfig->GetValue<uint64_t>("max-iterations");
+}
+
+// handler is called whenever a message arrives on "data", with a reference to the message and a sub-channel index (here 0)
+bool Sink::HandleData(FairMQMessagePtr& msg, int /*index*/)
+{
+    LOG(info) << "Received: \"" << string(static_cast<char*>(msg->GetData()), msg->GetSize()) << "\"";
+
+    if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations)
+    {
+        LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+        return false;
+    }
+
+    // return true if want to be called again (otherwise return false go to IDLE state)
+    return true;
+}
+
+Sink::~Sink()
+{
+}
+
+} // namespace example_1_1

examples/1-1/Sink.h

@@ -0,0 +1,40 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sink.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLE11SINK_H
+#define FAIRMQEXAMPLE11SINK_H
+
+#include "FairMQDevice.h"
+
+namespace example_1_1
+{
+
+class Sink : public FairMQDevice
+{
+  public:
+    Sink();
+    virtual ~Sink();
+
+  protected:
+    virtual void InitTask();
+    bool HandleData(FairMQMessagePtr&, int);
+
+  private:
+    uint64_t fMaxIterations;
+    uint64_t fNumIterations;
+};
+
+} // namespace example_1_1
+
+#endif /* FAIRMQEXAMPLE11SINK_H */

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

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

examples/1-1/runSampler.cxx

@@ -0,0 +1,24 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Sampler.h"
+
+namespace bpo = boost::program_options;
+
+void addCustomOptions(bpo::options_description& options)
+{
+    options.add_options()
+        ("text", bpo::value<std::string>()->default_value("Hello"), "Text to send out")
+        ("max-iterations", bpo::value<uint64_t>()->default_value(0), "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)");
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_1_1::Sampler();
+}

examples/1-1/runSink.cxx

@@ -0,0 +1,23 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Sink.h"
+
+namespace bpo = boost::program_options;
+
+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)");
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_1_1::Sink();
+}

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

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+transport="zeromq"
+
+if [[ $1 =~ ^[a-z]+$ ]]; then
+    transport=$1
+fi
+
+# setup a trap to kill everything if the test fails/timeouts
+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+=" --transport $transport"
+SAMPLER+=" --verbosity veryhigh"
+SAMPLER+=" --control static --color false"
+SAMPLER+=" --max-iterations 1"
+SAMPLER+=" --channel-config name=data,type=push,method=bind,address=tcp://*:5555,rateLogging=0"
+@CMAKE_CURRENT_BINARY_DIR@/$SAMPLER &
+SAMPLER_PID=$!
+
+SINK="fairmq-ex-1-1-sink"
+SINK+=" --id sink1"
+SINK+=" --transport $transport"
+SINK+=" --verbosity veryhigh"
+SINK+=" --control static --color false"
+SINK+=" --max-iterations 1"
+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

examples/1-n-1/CMakeLists.txt

@@ -0,0 +1,80 @@
+################################################################################
+#    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_library(Example1N1Lib STATIC
+    "Sampler.cxx"
+    "Sampler.h"
+    "Processor.cxx"
+    "Processor.h"
+    "Sink.cxx"
+    "Sink.h"
+)
+
+target_link_libraries(Example1N1Lib PUBLIC FairMQ)
+
+add_executable(fairmq-ex-1-n-1-sampler runSampler.cxx)
+target_link_libraries(fairmq-ex-1-n-1-sampler PRIVATE Example1N1Lib)
+
+add_executable(fairmq-ex-1-n-1-processor runProcessor.cxx)
+target_link_libraries(fairmq-ex-1-n-1-processor PRIVATE Example1N1Lib)
+
+add_executable(fairmq-ex-1-n-1-sink runSink.cxx)
+target_link_libraries(fairmq-ex-1-n-1-sink PRIVATE Example1N1Lib)
+
+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: ")
+
+if(BUILD_NANOMSG_TRANSPORT)
+  add_test(NAME Example-1-n-1-nanomsg COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-1-n-1.sh nanomsg)
+  set_tests_properties(Example-1-n-1-nanomsg PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received: ")
+endif()
+
+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

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

examples/1-n-1/Processor.h

@@ -0,0 +1,29 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+
+#ifndef FAIRMQEXAMPLE1N1PROCESSOR_H_
+#define FAIRMQEXAMPLE1N1PROCESSOR_H_
+
+#include "FairMQDevice.h"
+
+namespace example_1_n_1
+{
+
+class Processor : public FairMQDevice
+{
+  public:
+    Processor();
+    virtual ~Processor();
+
+  protected:
+    bool HandleData(FairMQMessagePtr&, int);
+};
+
+} // namespace example_1_n_1
+
+#endif /* FAIRMQEXAMPLE1N1PROCESSOR_H_ */

examples/1-n-1/README.md

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

examples/1-n-1/Sampler.cxx

@@ -0,0 +1,68 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sampler.cpp
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include <thread> // this_thread::sleep_for
+#include <chrono>
+
+#include "Sampler.h"
+
+using namespace std;
+
+namespace example_1_n_1
+{
+
+Sampler::Sampler()
+    : fText()
+    , fMaxIterations(0)
+    , fNumIterations(0)
+{
+}
+
+void Sampler::InitTask()
+{
+    // Get the fText and fMaxIterations values from the command line options (via fConfig)
+    fText = fConfig->GetValue<string>("text");
+    fMaxIterations = fConfig->GetValue<uint64_t>("max-iterations");
+}
+
+bool Sampler::ConditionalRun()
+{
+    // Initializing message with NewStaticMessage will avoid copy
+    // but won't delete the data after the sending is completed.
+    FairMQMessagePtr msg(NewStaticMessage(fText));
+
+    LOG(info) << "Sending \"" << fText << "\"";
+
+    // in case of error or transfer interruption, return false to go to IDLE state
+    // successfull transfer will return number of bytes transfered (can be 0 if sending an empty message).
+    if (Send(msg, "data1") < 0)
+    {
+        return false;
+    }
+    else if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations)
+    {
+        LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+        return false;
+    }
+
+    this_thread::sleep_for(chrono::seconds(1));
+
+    return true;
+}
+
+Sampler::~Sampler()
+{
+}
+
+} // namespace example_1_n_1

examples/1-n-1/Sampler.h

@@ -0,0 +1,42 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sampler.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLE1N1SAMPLER_H_
+#define FAIRMQEXAMPLE1N1SAMPLER_H_
+
+#include <string>
+
+#include "FairMQDevice.h"
+
+namespace example_1_n_1
+{
+
+class Sampler : public FairMQDevice
+{
+  public:
+    Sampler();
+    virtual ~Sampler();
+
+  protected:
+    std::string fText;
+    uint64_t fMaxIterations;
+    uint64_t fNumIterations;
+
+    virtual void InitTask();
+    virtual bool ConditionalRun();
+};
+
+} // namespace example_1_n_1
+
+#endif /* FAIRMQEXAMPLE1N1SAMPLER_H_ */

examples/1-n-1/Sink.cxx

@@ -0,0 +1,55 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sink.cxx
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include "Sink.h"
+
+using namespace std;
+
+namespace example_1_n_1
+{
+
+Sink::Sink()
+    : fMaxIterations(0)
+    , fNumIterations(0)
+{
+    // register a handler for data arriving on "data2" channel
+    OnData("data2", &Sink::HandleData);
+}
+
+void Sink::InitTask()
+{
+    // Get the fMaxIterations value from the command line options (via fConfig)
+    fMaxIterations = fConfig->GetValue<uint64_t>("max-iterations");
+}
+
+// handler is called whenever a message arrives on "data2", with a reference to the message and a sub-channel index (here 0)
+bool Sink::HandleData(FairMQMessagePtr& msg, int /*index*/)
+{
+    LOG(info) << "Received: \"" << string(static_cast<char*>(msg->GetData()), msg->GetSize()) << "\"";
+
+    if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations)
+    {
+        LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+        return false;
+    }
+
+    // return true if want to be called again (otherwise return false go to IDLE state)
+    return true;
+}
+
+Sink::~Sink()
+{
+}
+
+} // namespace example_1_n_1

examples/1-n-1/Sink.h

@@ -0,0 +1,40 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sink.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLE1N1SINK_H
+#define FAIRMQEXAMPLE1N1SINK_H
+
+#include "FairMQDevice.h"
+
+namespace example_1_n_1
+{
+
+class Sink : public FairMQDevice
+{
+  public:
+    Sink();
+    virtual ~Sink();
+
+  protected:
+    virtual void InitTask();
+    bool HandleData(FairMQMessagePtr&, int);
+
+  private:
+    uint64_t fMaxIterations;
+    uint64_t fNumIterations;
+};
+
+} // namespace example_1_n_1
+
+#endif /* FAIRMQEXAMPLE1N1SINK_H */

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

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

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

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

examples/1-n-1/runProcessor.cxx

@@ -0,0 +1,21 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Processor.h"
+
+namespace bpo = boost::program_options;
+
+void addCustomOptions(bpo::options_description& /*options*/)
+{
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_1_n_1::Processor();
+}

examples/1-n-1/runSampler.cxx

@@ -0,0 +1,24 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Sampler.h"
+
+namespace bpo = boost::program_options;
+
+void addCustomOptions(bpo::options_description& options)
+{
+    options.add_options()
+        ("text", bpo::value<std::string>()->default_value("Hello"), "Text to send out")
+        ("max-iterations", bpo::value<uint64_t>()->default_value(0), "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)");
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_1_n_1::Sampler();
+}

examples/1-n-1/runSink.cxx

@@ -0,0 +1,23 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Sink.h"
+
+namespace bpo = boost::program_options;
+
+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)");
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_1_n_1::Sink();
+}

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

@@ -0,0 +1,66 @@
+#!/bin/bash
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+transport="zeromq"
+
+if [[ $1 =~ ^[a-z]+$ ]]; then
+    transport=$1
+fi
+
+ex2config="@CMAKE_CURRENT_BINARY_DIR@/ex-1-n-1.json"
+
+# setup a trap to kill everything if the test fails/timeouts
+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+=" --control static --color false"
+SAMPLER+=" --max-iterations 2"
+SAMPLER+=" --mq-config $ex2config"
+@CMAKE_CURRENT_BINARY_DIR@/$SAMPLER &
+SAMPLER_PID=$!
+
+PROCESSOR1="fairmq-ex-1-n-1-processor"
+PROCESSOR1+=" --id processor1"
+PROCESSOR1+=" --transport $transport"
+PROCESSOR1+=" --verbosity veryhigh"
+PROCESSOR1+=" --control static --color false"
+PROCESSOR1+=" --mq-config $ex2config"
+PROCESSOR1+=" --config-key processor"
+@CMAKE_CURRENT_BINARY_DIR@/$PROCESSOR1 &
+PROCESSOR1_PID=$!
+
+PROCESSOR2="fairmq-ex-1-n-1-processor"
+PROCESSOR2+=" --id processor2"
+PROCESSOR2+=" --transport $transport"
+PROCESSOR2+=" --verbosity veryhigh"
+PROCESSOR2+=" --control static --color false"
+PROCESSOR2+=" --mq-config $ex2config"
+PROCESSOR2+=" --config-key processor"
+@CMAKE_CURRENT_BINARY_DIR@/$PROCESSOR2 &
+PROCESSOR2_PID=$!
+
+SINK="fairmq-ex-1-n-1-sink"
+SINK+=" --id sink1"
+SINK+=" --transport $transport"
+SINK+=" --verbosity veryhigh"
+SINK+=" --control static --color false"
+SINK+=" --max-iterations 2"
+SINK+=" --mq-config $ex2config"
+@CMAKE_CURRENT_BINARY_DIR@/$SINK &
+SINK_PID=$!
+
+# wait for sampler and sink to finish
+wait $SAMPLER_PID
+wait $SINK_PID
+
+# stop processors
+kill -SIGINT $PROCESSOR1_PID
+kill -SIGINT $PROCESSOR2_PID
+
+# wait for everything to finish
+wait $PROCESSOR1_PID
+wait $PROCESSOR2_PID

examples/CMakeLists.txt

@@ -0,0 +1,19 @@
+################################################################################
+#    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"                       #
+################################################################################
+
+add_subdirectory(1-1)
+add_subdirectory(1-n-1)
+add_subdirectory(copypush)
+add_subdirectory(dds)
+add_subdirectory(multipart)
+add_subdirectory(multiple-channels)
+if(BUILD_NANOMSG_TRANSPORT)
+  add_subdirectory(multiple-transports)
+endif()
+add_subdirectory(region)
+add_subdirectory(req-rep)

examples/README.md

@@ -0,0 +1,46 @@
+# FairMQ Examples
+
+Set of FairMQ examples. More examples that combine FairMQ with FairRoot can be found in the [FairRoot repository](https://github.com/FairRootGroup/FairRoot/tree/dev/examples/).
+
+## 1-1
+
+A simple topology of two devices - **Sampler** and **Sink**. **Sampler** sends data to **Sink** with the **PUSH-PULL** pattern.
+
+
+## 1-n-1
+
+A simple topology of three device types - **Sampler**, **Processor** and **Sink**. **Sampler** sends data to one or more **Processor**s, who modify the data and send it to one **Sink**. Transport with the **PUSH-PULL** pattern. The example also shows the configuration via JSON files, as oposed to `--channel-config` that is used by other examples.
+
+
+## DDS
+
+This example demonstrates usage of the Dynamic Deployment System ([DDS](http://dds.gsi.de/)) to dynamically deploy and configure a topology of devices. The topology is similar to those of Example 2, but now it can be easily distributed on different computing nodes without the need for manual reconfiguration of the devices.
+
+
+## Copy & Push
+
+A topology consisting of one **Sampler** and two **Sink**s. The **Sampler** uses the `Copy` method to send the same data to both sinks with the **PUSH-PULL** pattern. In countrary to the **PUB-SUB** pattern, this ensures that all receivers are connected and no data is lost, but requires additional channels to be configured.
+
+
+## Request & Reply
+
+This topology contains two devices that communicate with each other via the **REQ-REP** pettern. Bidirectional communication via a single socket.
+
+
+## Multiple Channels
+
+This example demonstrates how to work with multiple channels and multiplex between them.
+
+
+## Sending Multipart messages
+
+This example shows how to send a multipart message from one device to the other. (two parts message parts - header and body).
+
+
+## Multiple Transports example
+
+This examples shows how to combine different channel transports (zeromq/nanomsg/shmem) inside of one device and/or topology.
+
+## Region example
+
+This example demonstrates the use of a more advanced feature - UnmanagedRegion, that can be used to create a buffer through one of FairMQ transports. The contents of this buffer are managed by the user, who can also create messages out of sub-buffers of the created buffer. Such feature can be interesting in environments that have special requirements by the hardware that writes the data, to keep the transfer efficient (e.g. shared memory).

examples/copypush/CMakeLists.txt

@@ -0,0 +1,66 @@
+################################################################################
+#    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_library(ExampleCopyPushLib STATIC
+    "Sampler.cxx"
+    "Sampler.h"
+    "Sink.cxx"
+    "Sink.h"
+)
+
+target_link_libraries(ExampleCopyPushLib PUBLIC FairMQ)
+
+add_executable(fairmq-ex-copypush-sampler runSampler.cxx)
+target_link_libraries(fairmq-ex-copypush-sampler PRIVATE ExampleCopyPushLib)
+
+
+add_executable(fairmq-ex-copypush-sink runSink.cxx)
+target_link_libraries(fairmq-ex-copypush-sink PRIVATE ExampleCopyPushLib)
+
+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: ")
+
+if(BUILD_NANOMSG_TRANSPORT)
+  add_test(NAME Example-CopyPush-nanomsg COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-copypush.sh nanomsg)
+  set_tests_properties(Example-CopyPush-nanomsg PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received message: ")
+endif()
+
+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/README.md

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

examples/copypush/Sampler.cxx

@@ -0,0 +1,69 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+/**
+ * Sampler.cpp
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include <thread> // this_thread::sleep_for
+#include <chrono>
+
+#include "Sampler.h"
+
+using namespace std;
+
+namespace example_copypush
+{
+
+Sampler::Sampler()
+    : fNumDataChannels(0)
+    , fCounter(0)
+    , fMaxIterations(0)
+    , fNumIterations(0)
+{
+}
+
+void Sampler::InitTask()
+{
+    fNumDataChannels = fChannels.at("data").size();
+    fMaxIterations = fConfig->GetValue<uint64_t>("max-iterations");
+}
+
+bool Sampler::ConditionalRun()
+{
+
+    // 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
+    FairMQMessagePtr msg(NewSimpleMessage(fCounter++));
+
+    for (int i = 0; i < fNumDataChannels - 1; ++i)
+    {
+        FairMQMessagePtr msgCopy(NewMessage());
+        msgCopy->Copy(*msg);
+        Send(msgCopy, "data", i);
+    }
+    Send(msg, "data", fNumDataChannels - 1);
+
+    if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations)
+    {
+        LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+        return false;
+    }
+
+    this_thread::sleep_for(chrono::seconds(1));
+
+    return true;
+}
+
+Sampler::~Sampler()
+{
+}
+
+} // namespace example_copypush

examples/copypush/Sampler.h

@@ -0,0 +1,43 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sampler.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLECOPYPUSHSAMPLER_H
+#define FAIRMQEXAMPLECOPYPUSHSAMPLER_H
+
+#include "FairMQDevice.h"
+
+#include <stdint.h> // uint64_t
+
+namespace example_copypush
+{
+
+class Sampler : public FairMQDevice
+{
+  public:
+    Sampler();
+    virtual ~Sampler();
+
+  protected:
+    virtual void InitTask();
+    virtual bool ConditionalRun();
+
+    int fNumDataChannels;
+    uint64_t fCounter;
+    uint64_t fMaxIterations;
+    uint64_t fNumIterations;
+};
+
+} // namespace example_copypush
+
+#endif /* FAIRMQEXAMPLECOPYPUSHSAMPLER_H */

examples/copypush/Sink.cxx

@@ -0,0 +1,51 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sink.cxx
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include "Sink.h"
+
+namespace example_copypush
+{
+
+Sink::Sink()
+    : fMaxIterations(0)
+    , fNumIterations(0)
+{
+    OnData("data", &Sink::HandleData);
+}
+
+void Sink::InitTask()
+{
+    // Get the fMaxIterations value from the command line options (via fConfig)
+    fMaxIterations = fConfig->GetValue<uint64_t>("max-iterations");
+}
+
+bool Sink::HandleData(FairMQMessagePtr& msg, int /*index*/)
+{
+    LOG(info) << "Received message: \"" << *(static_cast<uint64_t*>(msg->GetData())) << "\"";
+
+    if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations)
+    {
+        LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+        return false;
+    }
+
+    // return true if want to be called again (otherwise go to IDLE state)
+    return true;
+}
+
+Sink::~Sink()
+{
+}
+
+} // namespace example_copypush

examples/copypush/Sink.h

@@ -0,0 +1,42 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sink.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLECOPYPUSHSINK_H
+#define FAIRMQEXAMPLECOPYPUSHSINK_H
+
+#include "FairMQDevice.h"
+
+#include <stdint.h> // uint64_t
+
+namespace example_copypush
+{
+
+class Sink : public FairMQDevice
+{
+  public:
+    Sink();
+    virtual ~Sink();
+
+  protected:
+    virtual void InitTask();
+    bool HandleData(FairMQMessagePtr&, int);
+
+  private:
+    uint64_t fMaxIterations;
+    uint64_t fNumIterations;
+};
+
+} // namespace example_copypush
+
+#endif /* FAIRMQEXAMPLECOPYPUSHSINK_H */

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

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

examples/copypush/runSampler.cxx

@@ -0,0 +1,23 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Sampler.h"
+
+namespace bpo = boost::program_options;
+
+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)");
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_copypush::Sampler();
+}

examples/copypush/runSink.cxx

@@ -0,0 +1,23 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Sink.h"
+
+namespace bpo = boost::program_options;
+
+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)");
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_copypush::Sink();
+}

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

@@ -0,0 +1,47 @@
+#!/bin/bash
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+transport="zeromq"
+
+if [[ $1 =~ ^[a-z]+$ ]]; then
+    transport=$1
+fi
+
+# setup a trap to kill everything if the test fails/timeouts
+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+=" --control static --color false"
+SAMPLER+=" --max-iterations 1"
+SAMPLER+=" --channel-config name=data,type=push,method=bind,rateLogging=0,address=tcp://*:5555,address=tcp://*:5556"
+@CMAKE_CURRENT_BINARY_DIR@/$SAMPLER &
+SAMPLER_PID=$!
+
+SINK1="fairmq-ex-copypush-sink"
+SINK1+=" --id sink1"
+SINK1+=" --transport $transport"
+SINK1+=" --verbosity veryhigh"
+SINK1+=" --control static --color false"
+SINK1+=" --max-iterations 1"
+SINK1+=" --channel-config name=data,type=pull,method=connect,rateLogging=0,address=tcp://localhost:5555"
+@CMAKE_CURRENT_BINARY_DIR@/$SINK1 &
+SINK1_PID=$!
+
+SINK2="fairmq-ex-copypush-sink"
+SINK2+=" --id sink2"
+SINK2+=" --transport $transport"
+SINK2+=" --verbosity veryhigh"
+SINK2+=" --control static --color false"
+SINK2+=" --max-iterations 1"
+SINK2+=" --channel-config name=data,type=pull,method=connect,rateLogging=0,address=tcp://localhost:5556"
+@CMAKE_CURRENT_BINARY_DIR@/$SINK2 &
+SINK2_PID=$!
+
+# wait for everything to finish
+wait $SAMPLER_PID
+wait $SINK1_PID
+wait $SINK2_PID

examples/dds/CMakeLists.txt

@@ -0,0 +1,67 @@
+################################################################################
+#    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_library(ExampleDDSLib STATIC
+    "Sampler.cxx"
+    "Sampler.h"
+    "Processor.cxx"
+    "Processor.h"
+    "Sink.cxx"
+    "Sink.h"
+)
+
+target_link_libraries(ExampleDDSLib PUBLIC FairMQ)
+
+add_executable(fairmq-ex-dds-sampler runSampler.cxx)
+target_link_libraries(fairmq-ex-dds-sampler PRIVATE ExampleDDSLib)
+
+add_executable(fairmq-ex-dds-processor runProcessor.cxx)
+target_link_libraries(fairmq-ex-dds-processor PRIVATE ExampleDDSLib)
+
+add_executable(fairmq-ex-dds-sink runSink.cxx)
+target_link_libraries(fairmq-ex-dds-sink PRIVATE ExampleDDSLib)
+
+add_custom_target(ExampleDDS DEPENDS fairmq-ex-dds-sampler fairmq-ex-dds-processor fairmq-ex-dds-sink)
+
+set(EX_BIN_DIR ${CMAKE_CURRENT_BINARY_DIR})
+set(DDS_PLUGIN_LIB_DIR ${CMAKE_BINARY_DIR}/fairmq/plugins/DDS)
+set(FAIRMQ_BIN_DIR ${CMAKE_BINARY_DIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/ex-dds-topology.xml ${CMAKE_CURRENT_BINARY_DIR}/ex-dds-topology.xml @ONLY)
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/ex-dds-hosts.cfg ${CMAKE_CURRENT_BINARY_DIR}/ex-dds-hosts.cfg COPYONLY)
+
+# test
+
+# install
+
+install(
+    TARGETS
+    fairmq-ex-dds-sampler
+    fairmq-ex-dds-processor
+    fairmq-ex-dds-sink
+
+    LIBRARY DESTINATION ${PROJECT_INSTALL_LIBDIR}
+    RUNTIME DESTINATION ${PROJECT_INSTALL_BINDIR}
+)
+
+# configure run script with different executable paths for build and for install directories
+set(EX_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR})
+set(DDS_PLUGIN_LIB_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_LIBDIR})
+set(FAIRMQ_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR}/fairmq)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/ex-dds-topology.xml ${CMAKE_CURRENT_BINARY_DIR}/ex-dds-topology.xml_install @ONLY)
+
+install(
+    FILES ${CMAKE_CURRENT_BINARY_DIR}/ex-dds-topology.xml_install
+    DESTINATION ${PROJECT_INSTALL_DATADIR}
+    RENAME ex-dds-topology.xml
+)
+
+install(
+    FILES ${CMAKE_CURRENT_BINARY_DIR}/ex-dds-hosts.cfg
+    DESTINATION ${PROJECT_INSTALL_DATADIR}
+)

examples/dds/Processor.cxx

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

examples/dds/Processor.h

@@ -0,0 +1,29 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+
+#ifndef FAIRMQEXAMPLEDDSPROCESSOR_H
+#define FAIRMQEXAMPLEDDSPROCESSOR_H
+
+#include "FairMQDevice.h"
+
+namespace example_dds
+{
+
+class Processor : public FairMQDevice
+{
+  public:
+    Processor();
+    virtual ~Processor();
+
+  protected:
+    bool HandleData(FairMQMessagePtr&, int);
+};
+
+}
+
+#endif /* FAIRMQEXAMPLEDDSPROCESSOR_H */

examples/dds/README.md

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

examples/dds/Sampler.cxx

@@ -0,0 +1,53 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sampler.cpp
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include <thread> // this_thread::sleep_for
+#include <chrono>
+
+#include "Sampler.h"
+
+using namespace std;
+
+namespace example_dds
+{
+
+Sampler::Sampler()
+{
+}
+
+bool Sampler::ConditionalRun()
+{
+    std::this_thread::sleep_for(std::chrono::seconds(1));
+
+    // 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
+    FairMQMessagePtr msg(NewSimpleMessage("Data"));
+
+    LOG(info) << "Sending \"Data\"";
+
+    // in case of error or transfer interruption, return false to go to IDLE state
+    // successfull transfer will return number of bytes transfered (can be 0 if sending an empty message).
+    if (Send(msg, "data1") < 0)
+    {
+        return false;
+    }
+
+    return true;
+}
+
+Sampler::~Sampler()
+{
+}
+
+}

examples/dds/Sampler.h

@@ -0,0 +1,35 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sampler.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLEDDSSAMPLER_H
+#define FAIRMQEXAMPLEDDSSAMPLER_H
+
+#include "FairMQDevice.h"
+
+namespace example_dds
+{
+
+class Sampler : public FairMQDevice
+{
+  public:
+    Sampler();
+    virtual ~Sampler();
+
+  protected:
+    virtual bool ConditionalRun();
+};
+
+} // namespace example_dds
+
+#endif /* FAIRMQEXAMPLEDDSSAMPLER_H */

examples/dds/Sink.cxx

@@ -0,0 +1,41 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sink.cxx
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include "Sink.h"
+
+using namespace std;
+
+namespace example_dds
+{
+
+Sink::Sink()
+{
+    // register a handler for data arriving on "data2" channel
+    OnData("data2", &Sink::HandleData);
+}
+
+// handler is called whenever a message arrives on "data2", with a reference to the message and a sub-channel index (here 0)
+bool Sink::HandleData(FairMQMessagePtr& msg, int /*index*/)
+{
+    LOG(info) << "Received: \"" << string(static_cast<char*>(msg->GetData()), msg->GetSize()) << "\"";
+
+    // return true if want to be called again (otherwise go to IDLE state)
+    return true;
+}
+
+Sink::~Sink()
+{
+}
+
+} // namespace example_dds

examples/dds/Sink.h

@@ -0,0 +1,35 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sink.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLEDDSSINK_H
+#define FAIRMQEXAMPLEDDSSINK_H
+
+#include "FairMQDevice.h"
+
+namespace example_dds
+{
+
+class Sink : public FairMQDevice
+{
+  public:
+    Sink();
+    virtual ~Sink();
+
+  protected:
+    bool HandleData(FairMQMessagePtr&, int);
+};
+
+} // namespace example_dds
+
+#endif /* FAIRMQEXAMPLEDDSSINK_H */

examples/dds/ex-dds-hosts.cfg

@@ -0,0 +1,7 @@
+@bash_begin@
+# source setup.sh
+@bash_end@
+
+sampler, username@localhost, , /path/to/dds-work-dir/, 1
+processor, username@localhost, , /path/to/dds-work-dir/, 10
+sink, username@localhost, , /path/to/dds-work-dir/, 1

examples/dds/ex-dds-topology.xml

@@ -0,0 +1,49 @@
+<topology id="ExampleDDS">
+
+    <property id="data1" />
+    <property id="data2" />
+
+    <declrequirement id="SamplerWorker" type="wnname" value="sampler"/>
+    <declrequirement id="ProcessorWorker" type="wnname" value="processor"/>
+    <declrequirement id="SinkWorker" type="wnname" value="sink"/>
+
+    <decltask id="Sampler">
+        <exe reachable="true">@EX_BIN_DIR@/fairmq-ex-dds-sampler --id sampler --color false --channel-config name=data1,type=push,method=bind -S "&lt;@DDS_PLUGIN_LIB_DIR@/" -P dds</exe>
+        <requirements>
+            <id>SamplerWorker</id>
+        </requirements>
+        <properties>
+            <id access="write">data1</id>
+        </properties>
+    </decltask>
+
+    <decltask id="Processor">
+        <exe reachable="true">@EX_BIN_DIR@/fairmq-ex-dds-processor --id processor_%taskIndex% --config-key processor --color false --channel-config name=data1,type=pull,method=connect name=data2,type=push,method=connect -S "&lt;@DDS_PLUGIN_LIB_DIR@/" -P dds</exe>
+        <requirements>
+            <id>ProcessorWorker</id>
+        </requirements>
+        <properties>
+            <id access="read">data1</id>
+            <id access="read">data2</id>
+        </properties>
+    </decltask>
+
+    <decltask id="Sink">
+        <exe reachable="true">@EX_BIN_DIR@/fairmq-ex-dds-sink --id sink --color false --channel-config name=data2,type=pull,method=bind -S "&lt;@DDS_PLUGIN_LIB_DIR@/" -P dds</exe>
+        <requirements>
+            <id>SinkWorker</id>
+        </requirements>
+        <properties>
+            <id access="write">data2</id>
+        </properties>
+    </decltask>
+
+    <main id="main">
+        <task>Sampler</task>
+        <task>Sink</task>
+        <group id="ProcessorGroup" n="10">
+            <task>Processor</task>
+        </group>
+    </main>
+
+</topology>

examples/dds/runProcessor.cxx

@@ -0,0 +1,21 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Processor.h"
+
+namespace bpo = boost::program_options;
+
+void addCustomOptions(bpo::options_description& /*options*/)
+{
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_dds::Processor();
+}

examples/dds/runSampler.cxx

@@ -0,0 +1,21 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Sampler.h"
+
+namespace bpo = boost::program_options;
+
+void addCustomOptions(bpo::options_description& /*options*/)
+{
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_dds::Sampler();
+}

examples/dds/runSink.cxx

@@ -0,0 +1,21 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Sink.h"
+
+namespace bpo = boost::program_options;
+
+void addCustomOptions(bpo::options_description& /*options*/)
+{
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_dds::Sink();
+}

examples/multipart/CMakeLists.txt

@@ -0,0 +1,65 @@
+ ################################################################################
+ #    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    #
+ #                                                                              #
+ #              This software is distributed under the terms of the             #
+ #              GNU Lesser General Public Licence (LGPL) version 3,             #
+ #                  copied verbatim in the file "LICENSE"                       #
+ ################################################################################
+
+add_library(ExampleMultipartLib STATIC
+    "Sampler.cxx"
+    "Sampler.h"
+    "Sink.cxx"
+    "Sink.h"
+)
+
+target_link_libraries(ExampleMultipartLib PUBLIC FairMQ)
+
+add_executable(fairmq-ex-multipart-sampler runSampler.cxx)
+target_link_libraries(fairmq-ex-multipart-sampler PRIVATE ExampleMultipartLib)
+
+add_executable(fairmq-ex-multipart-sink runSink.cxx)
+target_link_libraries(fairmq-ex-multipart-sink PRIVATE ExampleMultipartLib)
+
+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 2 parts")
+
+if(BUILD_NANOMSG_TRANSPORT)
+  add_test(NAME Example-Multipart-nanomsg COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-multipart.sh nanomsg)
+  set_tests_properties(Example-Multipart-nanomsg PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received message with 2 parts")
+endif()
+
+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 2 parts")
+
+# 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/Header.h

@@ -0,0 +1,22 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+
+#ifndef FAIRMQEXAMPLEMULTIPARTHEADER_H
+#define FAIRMQEXAMPLEMULTIPARTHEADER_H
+
+namespace example_multipart
+{
+
+struct Header
+{
+    int32_t stopFlag;
+};
+
+}
+
+#endif /* FAIRMQEXAMPLEMULTIPARTHEADER_H */

examples/multipart/README.md

@@ -0,0 +1,12 @@
+Sending Multipart messages
+==========================
+
+A topology of two devices - Sampler and Sink, communicating with PUSH-PULL pattern.
+
+The Sampler sends a multipart message to the Sink, consisting of two message parts - header and body.
+
+Each message part is a regular 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.
+
+The header contains a simple data structure with one integer. The integer in this structure is used as a stop flag for the sink. As long as its value is 0, the Sink will keep processing the data. Once its value is 1, the data handler method of the Sink will return false, which will exit the RUNNING state of the device.

examples/multipart/Sampler.cxx

@@ -0,0 +1,77 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sampler.cpp
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include <thread> // this_thread::sleep_for
+#include <chrono>
+
+#include "Sampler.h"
+#include "Header.h"
+
+using namespace std;
+
+namespace example_multipart
+{
+
+Sampler::Sampler()
+    : fMaxIterations(5)
+    , fNumIterations(0)
+{
+}
+
+void Sampler::InitTask()
+{
+    fMaxIterations = fConfig->GetValue<uint64_t>("max-iterations");
+}
+
+bool Sampler::ConditionalRun()
+{
+    Header header;
+    header.stopFlag = 0;
+
+    // Set stopFlag to 1 for last message.
+    if (fMaxIterations > 0 && fNumIterations == fMaxIterations - 1)
+    {
+        header.stopFlag = 1;
+    }
+    LOG(info) << "Sending header with stopFlag: " << header.stopFlag;
+
+    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));
+
+    LOG(info) << "Sending body of size: " << parts.At(1)->GetSize();
+
+    Send(parts, "data");
+
+    // Go out of the sending loop if the stopFlag was sent.
+    if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations)
+    {
+        LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+        return false;
+    }
+
+    // Wait a second to keep the output readable.
+    this_thread::sleep_for(chrono::seconds(1));
+
+    return true;
+}
+
+Sampler::~Sampler()
+{
+}
+
+} // namespace example_multipart

examples/multipart/Sampler.h

@@ -0,0 +1,40 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sampler.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLEDDSSAMPLER_H
+#define FAIRMQEXAMPLEDDSSAMPLER_H
+
+#include "FairMQDevice.h"
+
+namespace example_multipart
+{
+
+class Sampler : public FairMQDevice
+{
+  public:
+    Sampler();
+    virtual ~Sampler();
+
+  protected:
+    virtual void InitTask();
+    virtual bool ConditionalRun();
+
+  private:
+    uint64_t fMaxIterations;
+    uint64_t fNumIterations;
+};
+
+} // namespace example_multipart
+
+#endif /* FAIRMQEXAMPLEDDSSAMPLER_H */

examples/multipart/Sink.cxx

@@ -0,0 +1,51 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sink.cxx
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include "Sink.h"
+#include "Header.h"
+
+using namespace std;
+
+namespace example_multipart
+{
+
+Sink::Sink()
+{
+    OnData("data", &Sink::HandleData);
+}
+
+bool Sink::HandleData(FairMQParts& parts, int /*index*/)
+{
+    Header header;
+    header.stopFlag = (static_cast<Header*>(parts.At(0)->GetData()))->stopFlag;
+
+    LOG(info) << "Received message with " << parts.Size() << " parts";
+
+    LOG(info) << "Received header with stopFlag: " << header.stopFlag;
+    LOG(info) << "Received body of size: " << parts.At(1)->GetSize();
+
+    if (header.stopFlag == 1)
+    {
+        LOG(info) << "stopFlag is 1, going IDLE";
+        return false;
+    }
+
+    return true;
+}
+
+Sink::~Sink()
+{
+}
+
+}

examples/multipart/Sink.h

@@ -0,0 +1,34 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sink.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLEMULTIPARTSINK_H
+#define FAIRMQEXAMPLEMULTIPARTSINK_H
+
+#include "FairMQDevice.h"
+
+namespace example_multipart
+{
+
+class Sink : public FairMQDevice
+{
+  public:
+    Sink();
+    virtual ~Sink();
+
+  protected:
+    bool HandleData(FairMQParts&, int);
+};
+
+}
+#endif /* FAIRMQEXAMPLEMULTIPARTSINK_H */

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

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

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

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

examples/multipart/runSampler.cxx

@@ -0,0 +1,23 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Sampler.h"
+
+namespace bpo = boost::program_options;
+
+void addCustomOptions(bpo::options_description& options)
+{
+    options.add_options()
+        ("max-iterations", bpo::value<uint64_t>()->default_value(5), "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)");
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_multipart::Sampler();
+}

examples/multipart/runSink.cxx

@@ -0,0 +1,21 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Sink.h"
+
+namespace bpo = boost::program_options;
+
+void addCustomOptions(bpo::options_description& /*options*/)
+{
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_multipart::Sink();
+}

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

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+transport="zeromq"
+
+if [[ $1 =~ ^[a-z]+$ ]]; then
+    transport=$1
+fi
+
+# setup a trap to kill everything if the test fails/timeouts
+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+=" --max-iterations 1"
+SAMPLER+=" --control static --color false"
+SAMPLER+=" --channel-config name=data,type=push,method=connect,rateLogging=0,address=tcp://127.0.0.1:5555"
+@CMAKE_CURRENT_BINARY_DIR@/$SAMPLER &
+SAMPLER_PID=$!
+
+SINK="fairmq-ex-multipart-sink"
+SINK+=" --id sink1"
+SINK+=" --transport $transport"
+SINK+=" --verbosity veryhigh"
+SINK+=" --control static --color false"
+SINK+=" --channel-config name=data,type=pull,method=bind,rateLogging=0,address=tcp://127.0.0.1:5555"
+@CMAKE_CURRENT_BINARY_DIR@/$SINK &
+SINK_PID=$!
+
+wait $SAMPLER_PID
+wait $SINK_PID

examples/multiple-channels/Broadcaster.cxx

@@ -0,0 +1,48 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Broadcaster.cpp
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include <thread> // this_thread::sleep_for
+#include <chrono>
+
+#include "Broadcaster.h"
+
+using namespace std;
+
+namespace example_multiple_channels
+{
+
+Broadcaster::Broadcaster()
+{
+}
+
+bool Broadcaster::ConditionalRun()
+{
+    this_thread::sleep_for(chrono::seconds(1));
+
+    // 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
+    FairMQMessagePtr msg(NewSimpleMessage("OK"));
+
+    LOG(info) << "Sending OK";
+
+    Send(msg, "broadcast");
+
+    return true;
+}
+
+Broadcaster::~Broadcaster()
+{
+}
+
+}

examples/multiple-channels/Broadcaster.h

@@ -0,0 +1,35 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Broadcaster.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLEMULTIPLECHANNELSBROADCASTER_H
+#define FAIRMQEXAMPLEMULTIPLECHANNELSBROADCASTER_H
+
+#include "FairMQDevice.h"
+
+namespace example_multiple_channels
+{
+
+class Broadcaster : public FairMQDevice
+{
+  public:
+    Broadcaster();
+    virtual ~Broadcaster();
+
+  protected:
+    virtual bool ConditionalRun();
+};
+
+}
+
+#endif /* FAIRMQEXAMPLEMULTIPLECHANNELSBROADCASTER_H */

examples/multiple-channels/CMakeLists.txt

@@ -0,0 +1,68 @@
+ ################################################################################
+ #    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_library(ExampleMultipleChannelsLib STATIC
+    "Sampler.cxx"
+    "Sampler.h"
+    "Broadcaster.cxx"
+    "Broadcaster.h"
+    "Sink.cxx"
+    "Sink.h"
+)
+
+target_link_libraries(ExampleMultipleChannelsLib PUBLIC FairMQ)
+
+add_executable(fairmq-ex-multiple-channels-sampler runSampler.cxx)
+target_link_libraries(fairmq-ex-multiple-channels-sampler PRIVATE ExampleMultipleChannelsLib)
+
+add_executable(fairmq-ex-multiple-channels-broadcaster runBroadcaster.cxx)
+target_link_libraries(fairmq-ex-multiple-channels-broadcaster PRIVATE ExampleMultipleChannelsLib)
+
+add_executable(fairmq-ex-multiple-channels-sink runSink.cxx)
+target_link_libraries(fairmq-ex-multiple-channels-sink PRIVATE ExampleMultipleChannelsLib)
+
+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-Multiple-Channels-zeromq COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-multiple-channels.sh zeromq)
+set_tests_properties(Example-Multiple-Channels-zeromq PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received messages from both sources.")
+
+if(BUILD_NANOMSG_TRANSPORT)
+  add_test(NAME Example-Multiple-Channels-nanomsg COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-multiple-channels.sh nanomsg)
+  set_tests_properties(Example-Multiple-Channels-nanomsg PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received messages from both sources.")
+endif()
+
+# 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

@@ -0,0 +1,8 @@
+Multiple Channels
+=================
+
+This example demonstrates how to work with multiple channels and multiplex between them.
+
+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 `FairMQPoller`.

examples/multiple-channels/Sampler.cxx

@@ -0,0 +1,82 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sampler.cpp
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include <memory> // unique_ptr
+#include <thread> // this_thread::sleep_for
+#include <chrono>
+
+#include "Sampler.h"
+#include "FairMQPoller.h"
+
+using namespace std;
+
+namespace example_multiple_channels
+{
+
+Sampler::Sampler()
+    : fText()
+    , fMaxIterations(0)
+    , fNumIterations(0)
+{
+}
+
+void Sampler::InitTask()
+{
+    fText = fConfig->GetValue<string>("text");
+    fMaxIterations = fConfig->GetValue<uint64_t>("max-iterations");
+}
+
+void Sampler::Run()
+{
+    FairMQPollerPtr poller(NewPoller("data", "broadcast"));
+
+    while (CheckCurrentState(RUNNING))
+    {
+        poller->Poll(100);
+
+        if (poller->CheckInput("broadcast", 0))
+        {
+            FairMQMessagePtr msg(NewMessage());
+
+            if (Receive(msg, "broadcast") > 0)
+            {
+                LOG(info) << "Received broadcast: \"" << string(static_cast<char*>(msg->GetData()), msg->GetSize()) << "\"";
+            }
+        }
+
+        if (poller->CheckOutput("data", 0))
+        {
+            this_thread::sleep_for(chrono::seconds(1));
+
+            FairMQMessagePtr msg(NewSimpleMessage(fText));
+
+            if (Send(msg, "data") > 0)
+            {
+                LOG(info) << "Sent \"" << fText << "\"";
+
+                if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations)
+                {
+                    LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+                    break;
+                }
+            }
+        }
+    }
+}
+
+Sampler::~Sampler()
+{
+}
+
+}

examples/multiple-channels/Sampler.h

@@ -0,0 +1,42 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sampler.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLEMULTIPLECHANNELSSAMPLER_H
+#define FAIRMQEXAMPLEMULTIPLECHANNELSSAMPLER_H
+
+#include <string>
+
+#include "FairMQDevice.h"
+
+namespace example_multiple_channels
+{
+
+class Sampler : public FairMQDevice
+{
+  public:
+    Sampler();
+    virtual ~Sampler();
+
+  protected:
+    std::string fText;
+    uint64_t fMaxIterations;
+    uint64_t fNumIterations;
+
+    virtual void Run();
+    virtual void InitTask();
+};
+
+}
+
+#endif /* FAIRMQEXAMPLEMULTIPLECHANNELSSAMPLER_H */

examples/multiple-channels/Sink.cxx

@@ -0,0 +1,71 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sink.cxx
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include "Sink.h"
+
+using namespace std;
+
+namespace example_multiple_channels
+{
+
+Sink::Sink()
+    : fReceivedData(false)
+    , fReceivedBroadcast(false)
+    , fMaxIterations(0)
+    , fNumIterations(0)
+{
+    OnData("broadcast", &Sink::HandleBroadcast);
+    OnData("data", &Sink::HandleData);
+}
+
+void Sink::InitTask()
+{
+    fMaxIterations = fConfig->GetValue<uint64_t>("max-iterations");
+}
+
+bool Sink::HandleBroadcast(FairMQMessagePtr& msg, int /*index*/)
+{
+    LOG(info) << "Received broadcast: \"" << string(static_cast<char*>(msg->GetData()), msg->GetSize()) << "\"";
+    fReceivedBroadcast = true;
+
+    return CheckIterations();
+}
+
+bool Sink::HandleData(FairMQMessagePtr& msg, int /*index*/)
+{
+    LOG(info) << "Received message: \"" << string(static_cast<char*>(msg->GetData()), msg->GetSize()) << "\"";
+    fReceivedData = true;
+
+    return CheckIterations();
+}
+
+bool Sink::CheckIterations()
+{
+    if (fMaxIterations > 0)
+    {
+        if (fReceivedData && fReceivedBroadcast && ++fNumIterations >= fMaxIterations)
+        {
+            LOG(info) << "Configured maximum number of iterations reached & Received messages from both sources. Leaving RUNNING state.";
+            return false;
+        }
+    }
+
+    return true;
+}
+
+Sink::~Sink()
+{
+}
+
+}

examples/multiple-channels/Sink.h

@@ -0,0 +1,44 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sink.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLEMULTIPLECHANNELSSINK_H
+#define FAIRMQEXAMPLEMULTIPLECHANNELSSINK_H
+
+#include "FairMQDevice.h"
+
+namespace example_multiple_channels
+{
+
+class Sink : public FairMQDevice
+{
+  public:
+    Sink();
+    virtual ~Sink();
+
+  protected:
+    bool HandleBroadcast(FairMQMessagePtr&, int);
+    bool HandleData(FairMQMessagePtr&, int);
+    bool CheckIterations();
+    virtual void InitTask();
+
+  private:
+    bool fReceivedData;
+    bool fReceivedBroadcast;
+    uint64_t fMaxIterations;
+    uint64_t fNumIterations;
+};
+
+}
+
+#endif /* FAIRMQEXAMPLEMULTIPLECHANNELSSINK_H */

examples/multiple-channels/fairmq-start-ex-multiple-channels.sh.in

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+SAMPLER="fairmq-ex-multiple-channels-sampler"
+SAMPLER+=" --id sampler1"
+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"
+xterm -geometry 80x23+0+0 -hold -e @EX_BIN_DIR@/$SAMPLER &
+
+SINK="fairmq-ex-multiple-channels-sink"
+SINK+=" --id sink1"
+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"
+xterm -geometry 80x23+500+0 -hold -e @EX_BIN_DIR@/$SINK &
+
+BROADCASTER="fairmq-ex-multiple-channels-broadcaster"
+BROADCASTER+=" --id broadcaster1"
+BROADCASTER+=" --channel-config name=broadcast,type=pub,method=bind,rateLogging=0,address=tcp://*:5005"
+xterm -geometry 80x23+250+330 -hold -e @EX_BIN_DIR@/$BROADCASTER &

examples/multiple-channels/runBroadcaster.cxx

@@ -0,0 +1,21 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Broadcaster.h"
+
+namespace bpo = boost::program_options;
+
+void addCustomOptions(bpo::options_description& /*options*/)
+{
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_multiple_channels::Broadcaster();
+}

examples/multiple-channels/runSampler.cxx

@@ -0,0 +1,24 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Sampler.h"
+
+namespace bpo = boost::program_options;
+
+void addCustomOptions(bpo::options_description& options)
+{
+    options.add_options()
+        ("text", bpo::value<std::string>()->default_value("Hello"), "Text to send out")
+        ("max-iterations", bpo::value<uint64_t>()->default_value(0), "Maximum number of iterations of Run/ConditionalRun/OnData (0 - infinite)");
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_multiple_channels::Sampler();
+}

examples/multiple-channels/runSink.cxx

@@ -0,0 +1,23 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Sink.h"
+
+namespace bpo = boost::program_options;
+
+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)");
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_multiple_channels::Sink();
+}

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

@@ -0,0 +1,55 @@
+#!/bin/bash
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+transport="zeromq"
+
+if [[ $1 =~ ^[a-z]+$ ]]; then
+    transport=$1
+fi
+
+# setup a trap to kill everything if the test fails/timeouts
+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+=" --transport $transport"
+SINK+=" --verbosity veryhigh"
+SINK+=" --max-iterations 1"
+SINK+=" --control static --color false"
+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=$!
+
+sleep 1
+
+SAMPLER="fairmq-ex-multiple-channels-sampler"
+SAMPLER+=" --id sampler1"
+SAMPLER+=" --transport $transport"
+SAMPLER+=" --verbosity veryhigh"
+SAMPLER+=" --max-iterations 1"
+SAMPLER+=" --control static --color false"
+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+=" --transport $transport"
+BROADCASTER+=" --verbosity veryhigh"
+BROADCASTER+=" --control static --color false"
+BROADCASTER+=" --channel-config name=broadcast,type=pub,method=bind,rateLogging=0,address=tcp://*:5005"
+@CMAKE_CURRENT_BINARY_DIR@/$BROADCASTER &
+BROADCASTER_PID=$!
+
+wait $SAMPLER_PID
+wait $SINK_PID
+
+# stop broadcaster
+kill -SIGINT $BROADCASTER_PID
+
+# wait for broadcaster to finish
+wait $BROADCASTER_PID

examples/multiple-transports/CMakeLists.txt

@@ -0,0 +1,62 @@
+ ################################################################################
+ #    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_library(ExampleMultipleTransportsLib STATIC
+    "Sampler1.cxx"
+    "Sampler1.h"
+    "Sampler2.cxx"
+    "Sampler2.h"
+    "Sink.cxx"
+    "Sink.h"
+)
+
+target_link_libraries(ExampleMultipleTransportsLib PUBLIC FairMQ)
+
+add_executable(fairmq-ex-multiple-transports-sampler1 runSampler1.cxx)
+target_link_libraries(fairmq-ex-multiple-transports-sampler1 PRIVATE ExampleMultipleTransportsLib)
+
+add_executable(fairmq-ex-multiple-transports-sampler2 runSampler2.cxx)
+target_link_libraries(fairmq-ex-multiple-transports-sampler2 PRIVATE ExampleMultipleTransportsLib)
+
+add_executable(fairmq-ex-multiple-transports-sink runSink.cxx)
+target_link_libraries(fairmq-ex-multiple-transports-sink PRIVATE ExampleMultipleTransportsLib)
+
+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-Multiple-Transports COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-multiple-transports.sh)
+set_tests_properties(Example-Multiple-Transports 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/README.md

@@ -0,0 +1,12 @@
+Multiple Transports example
+===========================
+
+This example demonstrates use of multiple transports (zeromq/nanomsg/shmem) within the same topology and/or device. It is a simple topology consisting of two samplers and a sink. The devices are connected via 3 channels:
+
+![Multiple Transports example](../../docs/images/example_multiple_transports.png?raw=true "Multiple Transports example")
+
+Each device has main transport that it uses. By default it is ZeroMQ, and can be overriden via the `--transport` cmd option. The device will initialize additional transports if any of the channels have them configured (e.g. as an option to `--channel-config`).
+
+In this example sampler1 and sink are started with `--transport shmem`, making shared memory their main transport, sampler2 with `--transport nanomsg`. Additionally, the ack channel is configured to use zeromq as its transport.
+
+The main two things that a transport does is transfer of data and allocation of memory for the messages. By default, new messages are created via the main device transport. If a message has been created with one transport and is to be transferred with another, it has to be copied into a new message of the target transport. This happens automatically behind the scenes. To avoid this copy the device can create messages via `NewMessageFor(const string& channelName, int subChannelIndex, ...)` method, that creates the messages via the transport of the given channel (check sampler1 and sink for an example) or as the channel directly to create a message.

examples/multiple-transports/Sampler1.cxx

@@ -0,0 +1,80 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "Sampler1.h"
+
+using namespace std;
+
+namespace example_multiple_transports
+{
+
+Sampler1::Sampler1()
+    : fAckListener()
+    , fMaxIterations(0)
+    , fNumIterations(0)
+{
+}
+
+void Sampler1::InitTask()
+{
+    fMaxIterations = fConfig->GetValue<uint64_t>("max-iterations");
+}
+
+void Sampler1::PreRun()
+{
+    fAckListener = thread(&Sampler1::ListenForAcks, this);
+}
+
+bool Sampler1::ConditionalRun()
+{
+    // Creates a message using the transport of channel data1
+    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).
+    if (Send(msg, "data1") < 0)
+    {
+        return false;
+    }
+
+    if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations)
+    {
+        LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+        return false;
+    }
+
+    return true;
+}
+
+void Sampler1::PostRun()
+{
+    fAckListener.join();
+}
+
+void Sampler1::ListenForAcks()
+{
+    uint64_t numAcks = 0;
+
+    while (CheckCurrentState(RUNNING))
+    {
+        FairMQMessagePtr ack(NewMessageFor("ack", 0));
+        if (Receive(ack, "ack") < 0)
+        {
+            break;
+        }
+        ++numAcks;
+    }
+
+    LOG(info) << "Acknowledged " << numAcks << " messages";
+}
+
+Sampler1::~Sampler1()
+{
+}
+
+} // namespace example_multiple_transports

examples/multiple-transports/Sampler1.h

@@ -0,0 +1,39 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+
+#ifndef FAIRMQEXAMPLEMULTIPLETRANSPORTSSAMPLER1_H
+#define FAIRMQEXAMPLEMULTIPLETRANSPORTSSAMPLER1_H
+
+#include <thread>
+
+#include "FairMQDevice.h"
+
+namespace example_multiple_transports
+{
+
+class Sampler1 : public FairMQDevice
+{
+  public:
+    Sampler1();
+    virtual ~Sampler1();
+
+  protected:
+    virtual void InitTask();
+    virtual void PreRun();
+    virtual bool ConditionalRun();
+    virtual void PostRun();
+    void ListenForAcks();
+
+    std::thread fAckListener;
+    uint64_t fMaxIterations;
+    uint64_t fNumIterations;
+};
+
+} // namespace example_multiple_transports
+
+#endif /* FAIRMQEXAMPLEMULTIPLETRANSPORTSSAMPLER1_H */

examples/multiple-transports/Sampler2.cxx

@@ -0,0 +1,51 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "Sampler2.h"
+
+using namespace std;
+
+namespace example_multiple_transports
+{
+
+Sampler2::Sampler2()
+    : fMaxIterations(0)
+    , fNumIterations(0)
+{
+}
+
+void Sampler2::InitTask()
+{
+    fMaxIterations = fConfig->GetValue<uint64_t>("max-iterations");
+}
+
+bool Sampler2::ConditionalRun()
+{
+    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).
+    if (Send(msg, "data2") < 0)
+    {
+        return false;
+    }
+
+    if (fMaxIterations > 0 && ++fNumIterations >= fMaxIterations)
+    {
+        LOG(info) << "Configured maximum number of iterations reached. Leaving RUNNING state.";
+        return false;
+    }
+
+    return true;
+}
+
+Sampler2::~Sampler2()
+{
+}
+
+} // namespace example_multiple_transports

examples/multiple-transports/Sampler2.h

@@ -0,0 +1,34 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+
+#ifndef FAIRMQEXAMPLEMULTIPLETRANSPORTSSAMPLER2_H
+#define FAIRMQEXAMPLEMULTIPLETRANSPORTSSAMPLER2_H
+
+#include "FairMQDevice.h"
+
+namespace example_multiple_transports
+{
+
+class Sampler2 : public FairMQDevice
+{
+  public:
+    Sampler2();
+    virtual ~Sampler2();
+
+  protected:
+    virtual void InitTask();
+    virtual bool ConditionalRun();
+
+  private:
+    uint64_t fMaxIterations;
+    uint64_t fNumIterations;
+};
+
+} // namespace example_multiple_transports
+
+#endif /* FAIRMQEXAMPLEMULTIPLETRANSPORTSSAMPLER2_H */

examples/multiple-transports/Sink.cxx

@@ -0,0 +1,78 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sink.cxx
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include "Sink.h"
+
+using namespace std;
+
+namespace example_multiple_transports
+{
+
+Sink::Sink()
+    : fMaxIterations(0)
+    , fNumIterations1(0)
+    , fNumIterations2(0)
+{
+    // register a handler for data arriving on "data" channel
+    OnData("data1", &Sink::HandleData1);
+    OnData("data2", &Sink::HandleData2);
+}
+
+void Sink::InitTask()
+{
+    fMaxIterations = fConfig->GetValue<uint64_t>("max-iterations");
+}
+
+// handler is called whenever a message arrives on "data", with a reference to the message and a sub-channel index (here 0)
+bool Sink::HandleData1(FairMQMessagePtr& /*msg*/, int /*index*/)
+{
+    fNumIterations1++;
+    // Creates a message using the transport of channel ack
+    FairMQMessagePtr ack(NewMessageFor("ack", 0));
+    if (Send(ack, "ack") < 0)
+    {
+        return false;
+    }
+
+    // return true if want to be called again (otherwise go to IDLE state)
+    return CheckIterations();
+}
+
+// handler is called whenever a message arrives on "data", with a reference to the message and a sub-channel index (here 0)
+bool Sink::HandleData2(FairMQMessagePtr& /*msg*/, int /*index*/)
+{
+    fNumIterations2++;
+    // return true if want to be called again (otherwise go to IDLE state)
+    return CheckIterations();
+}
+
+bool Sink::CheckIterations()
+{
+    if (fMaxIterations > 0)
+    {
+        if (fNumIterations1 >= fMaxIterations && fNumIterations2 >= fMaxIterations)
+        {
+            LOG(info) << "Configured maximum number of iterations reached & Received messages from both sources. Leaving RUNNING state.";
+            return false;
+        }
+    }
+
+    return true;
+}
+
+Sink::~Sink()
+{
+}
+
+} // namespace example_multiple_transports

examples/multiple-transports/Sink.h

@@ -0,0 +1,43 @@
+/********************************************************************************
+ *    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"                       *
+ ********************************************************************************/
+/**
+ * Sink.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLEMULTIPLETRANSPORTSSINK_H
+#define FAIRMQEXAMPLEMULTIPLETRANSPORTSSINK_H
+
+#include "FairMQDevice.h"
+
+namespace example_multiple_transports
+{
+
+class Sink : public FairMQDevice
+{
+  public:
+    Sink();
+    virtual ~Sink();
+
+  protected:
+    virtual void InitTask();
+    bool HandleData1(FairMQMessagePtr&, int);
+    bool HandleData2(FairMQMessagePtr&, int);
+    bool CheckIterations();
+
+  private:
+    uint64_t fMaxIterations;
+    uint64_t fNumIterations1;
+    uint64_t fNumIterations2;
+};
+
+} // namespace example_multiple_transports
+
+#endif /* FAIRMQEXAMPLEMULTIPLETRANSPORTSSINK_H */

examples/multiple-transports/fairmq-start-ex-multiple-transports.sh.in

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+export FAIRMQ_PATH=@FAIRMQ_BIN_DIR@
+
+SAMPLER1="fairmq-ex-multiple-transports-sampler1"
+SAMPLER1+=" --id sampler1"
+SAMPLER1+=" --severity debug"
+SAMPLER1+=" --transport shmem"
+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"
+xterm -geometry 80x30+0+0 -hold -e @EX_BIN_DIR@/$SAMPLER1 &
+
+SAMPLER2="fairmq-ex-multiple-transports-sampler2"
+SAMPLER2+=" --id sampler2"
+SAMPLER2+=" --severity debug"
+SAMPLER2+=" --transport nanomsg"
+SAMPLER2+=" --channel-config name=data2,type=push,method=bind,address=tcp://127.0.0.1:5556"
+xterm -geometry 80x30+0+450 -hold -e @EX_BIN_DIR@/$SAMPLER2 &
+
+SINK="fairmq-ex-multiple-transports-sink"
+SINK+=" --id sink1"
+SINK+=" --severity debug"
+SINK+=" --transport shmem"
+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=nanomsg"
+SINK+="                  name=ack,type=pub,method=connect,address=tcp://127.0.0.1:5557,transport=zeromq"
+xterm -geometry 80x30+500+225 -hold -e @EX_BIN_DIR@/$SINK &

examples/multiple-transports/runSampler1.cxx

@@ -0,0 +1,23 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+
+#include "runFairMQDevice.h"
+#include "Sampler1.h"
+
+namespace bpo = boost::program_options;
+
+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)");
+}
+
+FairMQDevicePtr getDevice(const FairMQProgOptions& /*config*/)
+{
+    return new example_multiple_transports::Sampler1();
+}