Skip to content

Source · fairmq/

SuboptParser.hpublic header

Described in copypush: one message to several receivers, Configure channels, Channel properties.

fairmq/SuboptParser.h46 lines · C++GitHub ↗
1/********************************************************************************2 *    Copyright (C) 2017 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *3 *                                                                              *4 *              This software is distributed under the terms of the             *5 *              GNU Lesser General Public License (LGPL) version 3,             *6 *                  copied verbatim in the file "LICENSE"                       *7 ********************************************************************************/8 9/// @file   FairMQSuboptParser.h10/// @author Matthias.Richter@scieq.net11/// @since  2017-03-3012/// @brief  Parser implementation for key-value subopt format13 14#ifndef FAIR_MQ_SUBOPTPARSER_H15#define FAIR_MQ_SUBOPTPARSER_H16 17#include <fairmq/Properties.h>18 19#include <vector>20#include <string>21 22namespace fair::mq23{24 25/**26 * A parser implementation for FairMQ channel properties.27 * The parser handles a comma separated key=value list format by using the28 * getsubopt function of the standard library.29 *30 * The option key '--channel-config' can be used with the list of key/value31 * pairs like e.g.32 * <pre>33 * --channel-config name=output,type=push,method=bind34 * </pre>35 *36 * The FairMQ option parser defines a 'UserParser' function for different37 * formats. Currently it is strictly parsing channel options, but in general38 * the concept is extensible by renaming UserParser to ChannelPropertyParser39 * and introducing additional parser functions.40 */41 42Properties SuboptParser(const std::vector<std::string>& channelConfig, const std::string& deviceId);43 44}45 46#endif /* FAIR_MQ_SUBOPTPARSER_H */