FairMQSuboptParser.h

Go to the documentation of this file.

/********************************************************************************
 *    Copyright (C) 2017 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
 *                                                                              *
 *              This software is distributed under the terms of the             *
 *              GNU Lesser General Public License (LGPL) version 3,             *
 *                  copied verbatim in the file "LICENSE"                       *
 ********************************************************************************/


#ifndef FAIRMQPARSER_SUBOPT_H
#define FAIRMQPARSER_SUBOPT_H

#include "FairMQParser.h" // for FairMQChannelMap
#include <boost/program_options.hpp>
#include <cstring>
#include <vector>
#include <string>

namespace fair
{
namespace mq
{
namespace parser
{

struct SUBOPT
{
    enum channelOptionKeyIds
    {
        NAME = 0,       // name of the channel
        TYPE,           // push, pull, publish, subscribe, etc
        METHOD,         // bind or connect
        ADDRESS,        // host, protocol and port address
        TRANSPORT,      //
        SNDBUFSIZE,     // size of the send queue
        RCVBUFSIZE,     // size of the receive queue
        SNDKERNELSIZE,
        RCVKERNELSIZE,
        LINGER,
        RATELOGGING,    // logging rate
        PORTRANGEMIN,
        PORTRANGEMAX,
        AUTOBIND,
        NUMSOCKETS,
        lastsocketkey
    };

    constexpr static const char *channelOptionKeys[] = {
        /*[NAME]          = */ "name",
        /*[TYPE]          = */ "type",
        /*[METHOD]        = */ "method",
        /*[ADDRESS]       = */ "address",
        /*[TRANSPORT]     = */ "transport",
        /*[SNDBUFSIZE]    = */ "sndBufSize",
        /*[RCVBUFSIZE]    = */ "rcvBufSize",
        /*[SNDKERNELSIZE] = */ "sndKernelSize",
        /*[RCVKERNELSIZE] = */ "rcvKernelSize",
        /*[LINGER]        = */ "linger",
        /*[RATELOGGING]   = */ "rateLogging",
        /*[PORTRANGEMIN]  = */ "portRangeMin",
        /*[PORTRANGEMAX]  = */ "portRangeMax",
        /*[AUTOBIND]      = */ "autoBind",
        /*[NUMSOCKETS]    = */ "numSockets",
        nullptr
    };

    FairMQChannelMap UserParser(const std::vector<std::string>& channelConfig, const std::string& deviceId, const std::string& rootNode = "fairMQOptions");
};

}
}
}

#endif /* FAIRMQPARSER_SUBOPT_H */