Skip to content

iox::config🔗

Classes🔗

Name
struct iox::config::GatewayConfig
Generic configuration for gateways.
class iox::config::TomlGatewayConfigParser
The TomlGatewayConfigParser class provides methods for parsing gateway configs from toml text files.
struct iox::config::CmdLineArgs_t
class iox::config::CmdLineParser
class iox::config::CmdLineParserConfigFileOption
struct iox::config::RouDiConfig
class iox::config::TomlRouDiConfigFileProvider

Types🔗

Name
enum TomlGatewayConfigParseError
enum CmdLineParserResult

Functions🔗

Name
iox::log::LogStream & operator<<(iox::log::LogStream & logstream, const CmdLineArgs_t & cmdLineArgs)

Attributes🔗

Name
constexpr const char * TOML_GATEWAY_CONFIG_FILE_PARSE_ERROR_STRINGS
constexpr const char REGEX_VALID_CHARACTERS
constexpr const char DEFAULT_CONFIG_FILE_PATH
constexpr const char GATEWAY_CONFIG_SERVICE_TABLE_NAME
constexpr const char GATEWAY_CONFIG_SERVICE_NAME
constexpr const char GATEWAY_CONFIG_SERVICE_INSTANCE_NAME
constexpr const char GATEWAY_CONFIG_SERVICE_EVENT_NAME
constexpr char defaultConfigFilePath

Types Documentation🔗

enum TomlGatewayConfigParseError🔗

Enumerator Value Description
FILE_NOT_FOUND
INCOMPLETE_CONFIGURATION
INCOMPLETE_SERVICE_DESCRIPTION
INVALID_SERVICE_DESCRIPTION
EXCEPTION_IN_PARSER
MAXIMUM_NUMBER_OF_ENTRIES_EXCEEDED

enum CmdLineParserResult🔗

Enumerator Value Description
UNKNOWN_OPTION_USED
INFO_OUTPUT_ONLY

Functions Documentation🔗

function operator<<🔗

inline iox::log::LogStream & operator<<(
    iox::log::LogStream & logstream,
    const CmdLineArgs_t & cmdLineArgs
)

Attributes Documentation🔗

variable TOML_GATEWAY_CONFIG_FILE_PARSE_ERROR_STRINGS🔗

constexpr const char * TOML_GATEWAY_CONFIG_FILE_PARSE_ERROR_STRINGS = {"FILE_NOT_FOUND",
                                                                        "INCOMPLETE_CONFIGURATION",
                                                                        "INCOMPLETE_SERVICE_DESCRIPTION",
                                                                        "INVALID_SERVICE_DESCRIPTION",
                                                                        "EXCEPTION_IN_PARSER",
                                                                        "MAXIMUM_NUMBER_OF_ENTRIES_EXCEEDED"};

variable REGEX_VALID_CHARACTERS🔗

static constexpr const char REGEX_VALID_CHARACTERS = "^[a-zA-Z_][a-zA-Z0-9_]*$";

variable DEFAULT_CONFIG_FILE_PATH🔗

static constexpr const char DEFAULT_CONFIG_FILE_PATH = "/etc/iceoryx/gateway_config.toml";

variable GATEWAY_CONFIG_SERVICE_TABLE_NAME🔗

static constexpr const char GATEWAY_CONFIG_SERVICE_TABLE_NAME = "services";

variable GATEWAY_CONFIG_SERVICE_NAME🔗

static constexpr const char GATEWAY_CONFIG_SERVICE_NAME = "service";

variable GATEWAY_CONFIG_SERVICE_INSTANCE_NAME🔗

static constexpr const char GATEWAY_CONFIG_SERVICE_INSTANCE_NAME = "instance";

variable GATEWAY_CONFIG_SERVICE_EVENT_NAME🔗

static constexpr const char GATEWAY_CONFIG_SERVICE_EVENT_NAME = "event";

variable defaultConfigFilePath🔗

static constexpr char defaultConfigFilePath = "/etc/iceoryx/roudi_config.toml";

Updated on 31 May 2022 at 11:34:55 CEST