Rename /example to /examples and move MQ examples in it

examples/MQ/1-sampler-sink/CMakeLists.txt

@@ -0,0 +1,87 @@
+ ################################################################################
+ #    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    #
+ #                                                                              #
+ #              This software is distributed under the terms of the             #
+ #         GNU Lesser General Public Licence version 3 (LGPL) version 3,        #
+ #                  copied verbatim in the file "LICENSE"                       #
+ ################################################################################
+
+configure_file(${CMAKE_SOURCE_DIR}/examples/MQ/1-sampler-sink/ex1-sampler-sink.json ${CMAKE_BINARY_DIR}/bin/config/ex1-sampler-sink.json)
+
+Set(INCLUDE_DIRECTORIES
+  ${CMAKE_SOURCE_DIR}/fairmq
+  ${CMAKE_SOURCE_DIR}/fairmq/devices
+  ${CMAKE_SOURCE_DIR}/fairmq/tools
+  ${CMAKE_SOURCE_DIR}/fairmq/options
+  ${CMAKE_SOURCE_DIR}/examples/MQ/1-sampler-sink
+  ${CMAKE_CURRENT_BINARY_DIR}
+)
+
+Set(SYSTEM_INCLUDE_DIRECTORIES
+  ${Boost_INCLUDE_DIR}
+)
+
+If(NANOMSG_FOUND)
+  Set(INCLUDE_DIRECTORIES
+    ${INCLUDE_DIRECTORIES}
+    ${CMAKE_SOURCE_DIR}/fairmq/nanomsg
+  )
+  Set(SYSTEM_INCLUDE_DIRECTORIES
+    ${SYSTEM_INCLUDE_DIRECTORIES}
+    ${NANOMSG_INCLUDE_DIR}
+  )
+Else(NANOMSG_FOUND)
+  Set(INCLUDE_DIRECTORIES
+    ${INCLUDE_DIRECTORIES}
+    ${CMAKE_SOURCE_DIR}/fairmq/zeromq
+  )
+  Set(SYSTEM_INCLUDE_DIRECTORIES
+    ${SYSTEM_INCLUDE_DIRECTORIES}
+    ${ZMQ_INCLUDE_DIR}
+  )
+EndIf(NANOMSG_FOUND)
+
+Include_Directories(${INCLUDE_DIRECTORIES})
+Include_Directories(SYSTEM ${SYSTEM_INCLUDE_DIRECTORIES})
+
+Set(LINK_DIRECTORIES
+  ${Boost_LIBRARY_DIRS}
+)
+
+Link_Directories(${LINK_DIRECTORIES})
+
+Set(SRCS
+  "FairMQExample1Sampler.cxx"
+  "FairMQExample1Sink.cxx"
+)
+
+Set(DEPENDENCIES
+  ${DEPENDENCIES}
+  FairMQ
+)
+
+Set(LIBRARY_NAME FairMQExample1)
+
+GENERATE_LIBRARY()
+
+Set(Exe_Names
+  ex1-sampler
+  ex1-sink
+)
+
+Set(Exe_Source
+  runExample1Sampler.cxx
+  runExample1Sink.cxx
+)
+
+list(LENGTH Exe_Names _length)
+math(EXPR _length ${_length}-1)
+
+ForEach(_file RANGE 0 ${_length})
+  list(GET Exe_Names ${_file} _name)
+  list(GET Exe_Source ${_file} _src)
+  set(EXE_NAME ${_name})
+  set(SRCS ${_src})
+  set(DEPENDENCIES FairMQExample1)
+  GENERATE_EXECUTABLE()
+EndForEach(_file RANGE 0 ${_length})

examples/MQ/1-sampler-sink/FairMQExample1Sampler.cxx

@@ -0,0 +1,96 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *         GNU Lesser General Public Licence version 3 (LGPL) version 3,        *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+/**
+ * FairMQExample1Sampler.cpp
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include <memory> // unique_ptr
+
+#include <boost/thread.hpp>
+
+#include "FairMQExample1Sampler.h"
+#include "FairMQLogger.h"
+
+using namespace std;
+
+FairMQExample1Sampler::FairMQExample1Sampler()
+    : fText()
+{
+}
+
+void FairMQExample1Sampler::CustomCleanup(void *data, void *object)
+{
+    delete (string*)object;
+}
+
+void FairMQExample1Sampler::Run()
+{
+    while (CheckCurrentState(RUNNING))
+    {
+        boost::this_thread::sleep(boost::posix_time::milliseconds(1000));
+
+        string* text = new string(fText);
+
+        unique_ptr<FairMQMessage> msg(fTransportFactory->CreateMessage(const_cast<char*>(text->c_str()), text->length(), CustomCleanup, text));
+
+        LOG(INFO) << "Sending \"" << fText << "\"";
+
+        fChannels.at("data-out").at(0).Send(msg);
+    }
+}
+
+FairMQExample1Sampler::~FairMQExample1Sampler()
+{
+}
+
+void FairMQExample1Sampler::SetProperty(const int key, const string& value)
+{
+    switch (key)
+    {
+        case Text:
+            fText = value;
+            break;
+        default:
+            FairMQDevice::SetProperty(key, value);
+            break;
+    }
+}
+
+string FairMQExample1Sampler::GetProperty(const int key, const string& default_ /*= ""*/)
+{
+    switch (key)
+    {
+        case Text:
+            return fText;
+            break;
+        default:
+            return FairMQDevice::GetProperty(key, default_);
+    }
+}
+
+void FairMQExample1Sampler::SetProperty(const int key, const int value)
+{
+    switch (key)
+    {
+        default:
+            FairMQDevice::SetProperty(key, value);
+            break;
+    }
+}
+
+int FairMQExample1Sampler::GetProperty(const int key, const int default_ /*= 0*/)
+{
+    switch (key)
+    {
+        default:
+            return FairMQDevice::GetProperty(key, default_);
+    }
+}

examples/MQ/1-sampler-sink/FairMQExample1Sampler.h

@@ -0,0 +1,46 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             *
+ *         GNU Lesser General Public Licence version 3 (LGPL) version 3,        *
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+/**
+ * FairMQExample1Sampler.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLE1SAMPLER_H_
+#define FAIRMQEXAMPLE1SAMPLER_H_
+
+#include <string>
+
+#include "FairMQDevice.h"
+
+class FairMQExample1Sampler : public FairMQDevice
+{
+  public:
+    enum
+    {
+        Text = FairMQDevice::Last,
+        Last
+    };
+    FairMQExample1Sampler();
+    virtual ~FairMQExample1Sampler();
+
+    static void CustomCleanup(void* data, void* hint);
+
+    virtual void SetProperty(const int key, const std::string& value);
+    virtual std::string GetProperty(const int key, const std::string& default_ = "");
+    virtual void SetProperty(const int key, const int value);
+    virtual int GetProperty(const int key, const int default_ = 0);
+
+  protected:
+    std::string fText;
+
+    virtual void Run();
+};
+
+#endif /* FAIRMQEXAMPLE1SAMPLER_H_ */

examples/MQ/1-sampler-sink/FairMQExample1Sink.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 version 3 (LGPL) version 3,        *  
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+/**
+ * FairMQExample1Sink.cxx
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#include "FairMQExample1Sink.h"
+#include "FairMQLogger.h"
+
+using namespace std;
+
+FairMQExample1Sink::FairMQExample1Sink()
+{
+}
+
+void FairMQExample1Sink::Run()
+{
+    while (CheckCurrentState(RUNNING))
+    {
+        unique_ptr<FairMQMessage> msg(fTransportFactory->CreateMessage());
+
+        if (fChannels.at("data-in").at(0).Receive(msg) >= 0)
+        {
+            LOG(INFO) << "Received message: \""
+                      << string(static_cast<char*>(msg->GetData()), msg->GetSize())
+                      << "\"";
+        }
+    }
+}
+
+FairMQExample1Sink::~FairMQExample1Sink()
+{
+}

examples/MQ/1-sampler-sink/FairMQExample1Sink.h

@@ -0,0 +1,30 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             * 
+ *         GNU Lesser General Public Licence version 3 (LGPL) version 3,        *  
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+/**
+ * FairMQExample1Sink.h
+ *
+ * @since 2014-10-10
+ * @author A. Rybalchenko
+ */
+
+#ifndef FAIRMQEXAMPLE1SINK_H_
+#define FAIRMQEXAMPLE1SINK_H_
+
+#include "FairMQDevice.h"
+
+class FairMQExample1Sink : public FairMQDevice
+{
+  public:
+    FairMQExample1Sink();
+    virtual ~FairMQExample1Sink();
+
+  protected:
+    virtual void Run();
+};
+
+#endif /* FAIRMQEXAMPLE1SINK_H_ */

examples/MQ/1-sampler-sink/README.md

@@ -0,0 +1,8 @@
+Example 1: Sampler -> Sink
+===============
+
+A simple topology of two devices - **Sampler** and **Sink**. **Sampler** sends data to **Sink** via the **PUSH-PULL** pattern.
+
+`runExample1Sampler.cxx` and `runExample1Sink.cxx` configure and run the devices in their main function.
+
+The executables take two required command line parameters: `--id` and `--config-json-file`. The value of `--id` should be a unique identifier and the value for `--config-json-file` a path to a config file. The config file for this example is `ex1-sampler-sink.json` and it contains configuration for the communication channels of the devices. The mapping between a specific device and the configuration (which can contain multiple devices) is done based on the **id**.

examples/MQ/1-sampler-sink/ex1-sampler-sink.json

@@ -0,0 +1,41 @@
+{
+    "fairMQOptions":
+    {
+        "device":
+        {
+            "id": "sampler1",
+            "channel":
+            {
+                "name": "data-out",
+                "socket":
+                {
+                    "type": "push",
+                    "method": "bind",
+                    "address": "tcp://*:5555",
+                    "sndBufSize": "1000",
+                    "rcvBufSize": "1000",
+                    "rateLogging": "0"
+                }
+            }
+        },
+
+        "device":
+        {
+            "id": "sink1",
+            "channel":
+            {
+                "name": "data-in",
+                "socket":
+                {
+                    "type": "pull",
+                    "method": "connect",
+                    "address": "tcp://localhost:5555",
+                    "sndBufSize": "1000",
+                    "rcvBufSize": "1000",
+                    "rateLogging": "0"
+                }
+            }
+        }
+    }
+}
+

examples/MQ/1-sampler-sink/runExample1Sampler.cxx

@@ -0,0 +1,92 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             * 
+ *         GNU Lesser General Public Licence version 3 (LGPL) version 3,        *  
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+/**
+ * runExample1Sampler.cxx
+ *
+ * @since 2013-04-23
+ * @author D. Klein, A. Rybalchenko
+ */
+
+#include <iostream>
+
+#include "boost/program_options.hpp"
+
+#include "FairMQLogger.h"
+#include "FairMQParser.h"
+#include "FairMQProgOptions.h"
+#include "FairMQExample1Sampler.h"
+
+#ifdef NANOMSG
+#include "FairMQTransportFactoryNN.h"
+#else
+#include "FairMQTransportFactoryZMQ.h"
+#endif
+
+using namespace boost::program_options;
+
+int main(int argc, char** argv)
+{
+    FairMQExample1Sampler sampler;
+    sampler.CatchSignals();
+
+    FairMQProgOptions config;
+
+    try
+    {
+        std::string text;
+
+        options_description samplerOptions("Sampler options");
+        samplerOptions.add_options()
+            ("text", value<std::string>(&text)->default_value("Hello"), "Text to send out");
+
+        config.AddToCmdLineOptions(samplerOptions);
+
+        if (config.ParseAll(argc, argv))
+        {
+            return 0;
+        }
+
+        std::string filename = config.GetValue<std::string>("config-json-file");
+        std::string id = config.GetValue<std::string>("id");
+
+        config.UserParser<FairMQParser::JSON>(filename, id);
+
+        sampler.fChannels = config.GetFairMQMap();
+
+        LOG(INFO) << "PID: " << getpid();
+
+#ifdef NANOMSG
+        FairMQTransportFactory* transportFactory = new FairMQTransportFactoryNN();
+#else
+        FairMQTransportFactory* transportFactory = new FairMQTransportFactoryZMQ();
+#endif
+
+        sampler.SetTransport(transportFactory);
+
+        sampler.SetProperty(FairMQExample1Sampler::Id, id);
+        sampler.SetProperty(FairMQExample1Sampler::Text, text);
+
+        sampler.ChangeState("INIT_DEVICE");
+        sampler.WaitForEndOfState("INIT_DEVICE");
+
+        sampler.ChangeState("INIT_TASK");
+        sampler.WaitForEndOfState("INIT_TASK");
+
+        sampler.ChangeState("RUN");
+        sampler.InteractiveStateLoop();
+    }
+    catch (std::exception& e)
+    {
+        LOG(ERROR) << e.what();
+        LOG(INFO) << "Command line options are the following: ";
+        config.PrintHelp();
+        return 1;
+    }
+
+    return 0;
+}

examples/MQ/1-sampler-sink/runExample1Sink.cxx

@@ -0,0 +1,79 @@
+/********************************************************************************
+ *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ *                                                                              *
+ *              This software is distributed under the terms of the             * 
+ *         GNU Lesser General Public Licence version 3 (LGPL) version 3,        *  
+ *                  copied verbatim in the file "LICENSE"                       *
+ ********************************************************************************/
+/**
+ * runExample1Sink.cxx
+ *
+ * @since 2013-04-23
+ * @author D. Klein, A. Rybalchenko
+ */
+
+#include <iostream>
+
+#include "FairMQLogger.h"
+#include "FairMQParser.h"
+#include "FairMQProgOptions.h"
+#include "FairMQExample1Sink.h"
+
+#ifdef NANOMSG
+#include "FairMQTransportFactoryNN.h"
+#else
+#include "FairMQTransportFactoryZMQ.h"
+#endif
+
+int main(int argc, char** argv)
+{
+    FairMQExample1Sink sink;
+    sink.CatchSignals();
+
+    FairMQProgOptions config;
+
+    try
+    {
+        if (config.ParseAll(argc, argv))
+        {
+            return 0;
+        }
+
+        std::string filename = config.GetValue<std::string>("config-json-file");
+        std::string id = config.GetValue<std::string>("id");
+
+        config.UserParser<FairMQParser::JSON>(filename, id);
+
+        sink.fChannels = config.GetFairMQMap();
+
+        LOG(INFO) << "PID: " << getpid();
+
+#ifdef NANOMSG
+        FairMQTransportFactory* transportFactory = new FairMQTransportFactoryNN();
+#else
+        FairMQTransportFactory* transportFactory = new FairMQTransportFactoryZMQ();
+#endif
+
+        sink.SetTransport(transportFactory);
+
+        sink.SetProperty(FairMQExample1Sink::Id, id);
+
+        sink.ChangeState("INIT_DEVICE");
+        sink.WaitForEndOfState("INIT_DEVICE");
+
+        sink.ChangeState("INIT_TASK");
+        sink.WaitForEndOfState("INIT_TASK");
+
+        sink.ChangeState("RUN");
+        sink.InteractiveStateLoop();
+    }
+    catch (std::exception& e)
+    {
+        LOG(ERROR) << e.what();
+        LOG(INFO) << "Command line options are the following: ";
+        config.PrintHelp();
+        return 1;
+    }
+
+    return 0;
+}