Control.h

/********************************************************************************
 *    Copyright (C) 2017 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
 *                                                                              *
 *              This software is distributed under the terms of the             *
 *              GNU Lesser General Public Licence (LGPL) version 3,             *
 *                  copied verbatim in the file "LICENSE"                       *
 ********************************************************************************/
 
#ifndef FAIR_MQ_PLUGINS_CONTROL
#define FAIR_MQ_PLUGINS_CONTROL
 
#include <fairmq/Plugin.h>
#include <fairmq/Version.h>
#include <fairmq/StateQueue.h>
 
#include <condition_variable>
#include <mutex>
#include <string>
#include <queue>
#include <thread>
#include <atomic>
#include <stdexcept>
 
namespace fair::mq::plugins
{
 
class Control : public Plugin
{
  public:
    Control(const std::string& name, const Plugin::Version version, const std::string& maintainer, const std::string& homepage, PluginServices* pluginServices);
 
    ~Control();
 
  private:
    auto InteractiveMode() -> void;
    static auto PrintInteractiveHelpColor() -> void;
    static auto PrintInteractiveHelp() -> void;
    static auto PrintStateMachineColor() -> void;
    static auto PrintStateMachine() -> void;
    auto StaticMode() -> void;
    auto SignalHandler() -> void;
    auto RunShutdownSequence() -> void;
    auto RunStartupSequence() -> void;
 
    std::thread fControllerThread;
    std::thread fSignalHandlerThread;
    std::mutex fControllerMutex;
    std::atomic<bool> fDeviceShutdownRequested;
    std::atomic<bool> fDeviceHasShutdown;
    std::atomic<bool> fPluginShutdownRequested;
    fair::mq::StateQueue fStateQueue;
}; /* class Control */
 
auto ControlPluginProgramOptions() -> Plugin::ProgOptions;
 
REGISTER_FAIRMQ_PLUGIN(
    Control,   // Class name
    control,   // Plugin name (string, lower case chars only)
    (Plugin::Version{FAIRMQ_VERSION_MAJOR, FAIRMQ_VERSION_MINOR, FAIRMQ_VERSION_PATCH}), // Version
    "FairRootGroup <fairroot@gsi.de>",             // Maintainer
    "https://github.com/FairRootGroup/FairMQ",     // Homepage
    ControlPluginProgramOptions   // Free function which declares custom program options for the
                                  // plugin signature: () ->
                                  // boost::optional<boost::program_options::options_description>
)
 
} // namespace fair::mq::plugins
 
#endif /* FAIR_MQ_PLUGINS_CONTROL */