application::helper Namespace Reference

Namespace that contains the helper classes for the application. More...

Classes
class	ArgumentConfiguration
	A helper class to manage the arguments passed to the main application. More...
class	CurlWrapper
	Minimalist C++ wrapper of easy (blocking interface) CURL library for RESTful communication. More...
class	FifoCheckpointCommunicator
	Supervision checkpoint communicator over the FIFO medium. More...
class	LogRecoveryAction
	A class to provide logging as the recovery action for a failed supervised entity. More...
class	MemoryCache
	Memory cache helper class with expiration time. More...
struct	NetworkConfiguration
	Data model for a network configuration. More...
class	ReadDataByIdentifier
	UDS to read data at the diagnostic server by passing the data ID (DID) More...
struct	RpcConfiguration
	Data model for a remote procedure call connection configuration. More...

Functions
bool	TryGetNetworkConfiguration (const arxml::ArxmlReader &reader, std::string networkEndpoint, std::string applicationEndpoint, ara::com::option::Layer4ProtocolType protocol, NetworkConfiguration &configuration)
	Try to get a nework configuration based on a ARXML configuration file. More...
bool	TryGetNetworkConfiguration (const std::string &configFilepath, std::string networkEndpoint, std::string applicationEndpoint, ara::com::option::Layer4ProtocolType protocol, NetworkConfiguration &configuration)
	Try to get a nework configuration based on a ARXML configuration file. More...
template<typename T , size_t M, size_t N>
bool	TryExtractDeepValue (const arxml::ArxmlReader &shallowReader, const std::array< std::string, M > &shallowChildren, const std::array< std::string, N > &deepChildren, std::string shortNameFilter, T &deepValue)
	Try to extract a deep value from an XML content. More...
bool	TryGetRpcConfiguration (const std::string &configFilepath, std::string networkEndpoint, std::string applicationEndpoint, RpcConfiguration &configuration)
	Try to get a RPC configuration based on a ARXML configuration file. More...

Detailed Description

Namespace that contains the helper classes for the application.

Function Documentation

TryExtractDeepValue()

template<typename T , size_t M, size_t N>

bool application::helper::TryExtractDeepValue	(	const arxml::ArxmlReader &	shallowReader,
		const std::array< std::string, M > &	shallowChildren,
		const std::array< std::string, N > &	deepChildren,
		std::string	shortNameFilter,
		T &	deepValue
	)

Try to extract a deep value from an XML content.

Template Parameters

T	Deep value type
M	Shallow children depth level
N	Deep children depth level

Parameters

[in]	shallowReader	XML content reader
[in]	shallowChildren	XML node hierarchy that may contain multiple deep values
[in]	deepChildren	XML node hierarchy of a deep value
[in]	shortNameFilter	Deep value short name for filtering within multiple deep values
[out]	deepValue	Filled deep value

Returns

True if the value is extracted properly; otherwise false

TryGetNetworkConfiguration() [1/2]

bool application::helper::TryGetNetworkConfiguration	(	const arxml::ArxmlReader &	reader,
		std::string	networkEndpoint,
		std::string	applicationEndpoint,
		ara::com::option::Layer4ProtocolType	protocol,
		NetworkConfiguration &	configuration
	)

Try to get a nework configuration based on a ARXML configuration file.

Parameters

[in]	reader	ARXML configuration reader
[in]	networkEndpoint	Desired network endpoint name
[in]	applicationEndpoint	Desired application endpoint name
[in]	protocol	Network transmission protocol
[out]	configuration	Filled network configuration

Returns

True if the configuration is filled properly; otherwise false

TryGetNetworkConfiguration() [2/2]

bool application::helper::TryGetNetworkConfiguration	(	const std::string &	configFilepath,
		std::string	networkEndpoint,
		std::string	applicationEndpoint,
		ara::com::option::Layer4ProtocolType	protocol,
		NetworkConfiguration &	configuration
	)

Try to get a nework configuration based on a ARXML configuration file.

Parameters

[in]	configFilepath	ARXML configuration file path
[in]	networkEndpoint	Desired network endpoint name
[in]	applicationEndpoint	Desired application endpoint name
[in]	protocol	Network transmission protocol
[out]	configuration	Filled network configuration

Returns

True if the configuration is filled properly; otherwise false

TryGetRpcConfiguration()

bool application::helper::TryGetRpcConfiguration	(	const std::string &	configFilepath,
		std::string	networkEndpoint,
		std::string	applicationEndpoint,
		RpcConfiguration &	configuration
	)

Try to get a RPC configuration based on a ARXML configuration file.

Parameters

[in]	configFilepath	ARXML configuration file path
[in]	networkEndpoint	Desired network endpoint name
[in]	applicationEndpoint	Desired application endpoint name
[out]	configuration	Filled RPC configuration

Returns

True if the configuration is filled properly; otherwise false