Refactor the examples after move from FairRoot

examples/multipart/CMakeLists.txt

@@ -0,0 +1,50 @@
+ ################################################################################
+ #    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)
+
+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_CURRENT_BINARY_DIR})
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/fairmq-start-ex-multipart.sh.in ${CMAKE_CURRENT_BINARY_DIR}/fairmq-start-ex-multipart.sh)
+set(EX_BIN_DIR ${CMAKE_INSTALL_PREFIX}/${PROJECT_INSTALL_BINDIR})
+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
+)
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/test-ex-multipart.sh.in ${CMAKE_CURRENT_BINARY_DIR}/test-ex-multipart.sh)
+
+add_test(NAME Example-Multipart COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-ex-multipart.sh)
+set_tests_properties(Example-Multipart PROPERTIES TIMEOUT "30" RUN_SERIAL true PASS_REGULAR_EXPRESSION "Received message with 2 parts")

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,13 @@
+Example 8: 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, simply send all but the last part with `SendPart()` and the last part with `Send()` as shown in the example.
+
+The ZeroMQ transport guarantees delivery of both parts together. Meaning that when the Receive call of the Sink receives the first part, following parts have arrived too.
+
+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 Sink will exit its `Run()` method.
+

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

@@ -0,0 +1,60 @@
+{
+    "fairMQOptions": {
+        "devices": [
+            {
+                "id": "sampler1",
+                "channels": [
+                    {
+                        "name": "data",
+                        "sockets": [
+                            {
+                                "type": "push",
+                                "method": "connect",
+                                "address": "tcp://localhost:5555,tcp://localhost:5556",
+                                "sndBufSize": 1000,
+                                "rcvBufSize": 1000,
+                                "rateLogging": 0
+                            }
+                        ]
+                    }
+                ]
+            },
+            {
+                "id": "sink1",
+                "channels": [
+                    {
+                        "name": "data",
+                        "sockets": [
+                            {
+                                "type": "pull",
+                                "method": "bind",
+                                "address": "tcp://*:5555",
+                                "sndBufSize": 1000,
+                                "rcvBufSize": 1000,
+                                "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,11 @@
+#!/bin/bash
+
+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,24 @@
+#!/bin/bash
+
+# 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+=" --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+=" --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