Refactor the examples after move from FairRoot

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,56 @@
+ ################################################################################
+ #    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    #
+ #                                                                              #
+ #              This software is distributed under the terms of the             #
+ #              GNU Lesser General Public Licence (LGPL) version 3,             #
+ #                  copied verbatim in the file "LICENSE"                       #
+ ################################################################################
+
+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)
+
+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_CURRENT_BINARY_DIR})
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-multiple-channels.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-multiple-channels.sh)
+set(EX_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR})
+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
+)
+
+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 COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-multiple-channels.sh)
+set_tests_properties(Example-Multiple-Channels PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received messages from both sources.")

examples/multiple-channels/README.md

@@ -0,0 +1,8 @@
+Example 6: 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,18 @@
+#!/bin/bash
+
+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,44 @@
+#!/bin/bash
+
+# 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+=" --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+=" --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+=" --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