Fallback Config Handlers

Common interface shared by the fallback config handlers of all plugin element classes. More...

Public Member Functions
auto	operator() (xentara::utils::json::decoder::Object::Member &member) const -> void
	Handles a single config parameter unknown to the sub class. More...
auto	operator() (const xentara::utils::json::decoder::Name &name, xentara::utils::json::decoder::Value &value) const -> void
	Handles a single config parameter unknown to the sub class. More...
auto	operator() (xentara::utils::json::decoder::Object &jsonObject) const -> void
	Handles the entire contents of the configuration. More...

Detailed Description

Common interface shared by the fallback config handlers of all plugin element classes.

This documentation describes the common interface shared by the fallback config handlers of all plugin element classes. See the individual classes for more detailed information.

Versions

xentara::io::Component::FallbackConfigHandler
xentara::io::Io::FallbackConfigHandler
xentara::io::IoBatch::FallbackConfigHandler
xentara::process::Microservice::FallbackConfigHandler

Member Function Documentation

operator()() [1/3]

auto Element::FallbackConfigHandler::operator()	(	const xentara::utils::json::decoder::Name &	name,
		xentara::utils::json::decoder::Value &	value
		)	-> void

Handles a single config parameter unknown to the sub class.

You should call this operator from your implementation of loadConfig() for every object member you do not recognize.

Parameters

name	The name of the member
value	The value of the member

Exceptions

std::runtime_error

The name of the member is not recognized, or the corresponding value is unsuitable

Versions

xentara::io::Component::FallbackConfigHandler::operator()()
xentara::io::Io::FallbackConfigHandler::operator()()
xentara::io::IoBatch::FallbackConfigHandler::operator()()
xentara::process::Microservice::FallbackConfigHandler::operator()()

operator()() [2/3]

auto Element::FallbackConfigHandler::operator()

(

xentara::utils::json::decoder::Object &

jsonObject

)

const -> void

Handles the entire contents of the configuration.

You should call this operator from your implementation of loadConfig() if you do not have any configuration parameters of your own.

Parameters

jsonObject

The JSON object that contains the microservice's configuration

Exceptions

std::runtime_error

The configuration object copnatins an error

Versions

xentara::io::Component::FallbackConfigHandler::operator()()
xentara::io::Io::FallbackConfigHandler::operator()()
xentara::io::IoBatch::FallbackConfigHandler::operator()()
xentara::process::Microservice::FallbackConfigHandler::operator()()

operator()() [3/3]

auto Element::FallbackConfigHandler::operator()

(

xentara::utils::json::decoder::Object::Member &

member

)

const -> void

Handles a single config parameter unknown to the sub class.

You should call this operator from your implementation of loadConfig() for every object member you do not recognize.

Parameters

member

The value of the member

Exceptions

std::runtime_error

The name is not recognized, or the value is unsuitable

Versions

xentara::io::Component::FallbackConfigHandler::operator()()
xentara::io::Io::FallbackConfigHandler::operator()()
xentara::io::IoBatch::FallbackConfigHandler::operator()()
xentara::process::Microservice::FallbackConfigHandler::operator()()