Parser for client side connection configuration files. More...

#include <connection_configuration_parser.hpp>

Inheritance diagram for kanzi::connect::ConnectionConfigurationParser:

Public Member Functions
	ConnectionConfigurationParser ()
	Constructor. More...

virtual size_t	countConfigurations () const override

virtual bool	getConfiguration (Configuration &configurationOut) const override

virtual bool	getConfiguration (const string &serverName, Configuration &configurationOut) const override

virtual Configuration	getConfigurationAt (size_t position) const override

virtual Configuration	getConfigurationEx (const string &serverName) const override

bool	parse (const string &resourceDirectory, const string &configurationFileName)
	Parse configuration file. More...

bool	parseEx (const string &configurationFileName)
	Parse configuration file Use this version for native android applications. More...

bool	parseString (const string &configurationFileContents)
	Parse configuration string Use this version for native android applications. More...

virtual	~ConnectionConfigurationParser () override
	dtor More...

Public Member Functions inherited from kanzi::connect::ConnectionConfigurationReadIf
virtual	~ConnectionConfigurationReadIf ()=default
	dtor More...

Static Public Attributes
static const Configuration	DEFAULT_CONFIGURATION
	Contains the default configuration used if configuration file is not found. More...

Static Public Attributes inherited from kanzi::connect::ConnectionConfigurationReadIf
static constexpr const char *const	ALT_ADDRESSES_ATTRIBUTE_NAME = "alt-addresses"
	Attribute which defines alternate addresses of a server. More...

static constexpr const char *const	BASEPATH_ATTRIBUTE_PREFIX = "basepath-"
	Prefix for all platform specific base path attributes. More...

static constexpr const char *const	CA_CERTIFICATE_ATTRIBUTE_NAME = "ca-certificate"
	Attribute which defines the file name of ca-certificate. More...

static constexpr const char *const	CERTIFICATE_ATTRIBUTE_NAME = "certificate"
	Attribute which defines the file name of certificate. More...

static constexpr const char *const	CONNECT_IDENTIFIER_ATTRIBUTE_NAME = "connect-identifier"
	Attribute which defines the connect identifier for non-ip peers like shared memory. More...

static constexpr const char *const	DEFAULT_BASEPATH_ATTRIBUTE_NAME = "basepath"
	Default attribute to define common base path. More...

static constexpr const char *const	HOST_IP_ATTRIBUTE_NAME = "host_ip"
	Attribute which defines the host ip address. More...

static constexpr const char *const	HOST_PORT_ATTRIBUTE_NAME = "host_port"
	Attribute which defines the host port. More...

static constexpr const char *const	IDENTITY_ATTRIBUTE_NAME = "identity"
	is this needed? More...

static constexpr const char *const	PRIVATEKEY_ATTRIBUTE_NAME = "privatekey"
	Attribute which defines the file name of client private key. More...

static constexpr const char *const	RESOURCE_PATH_ATTRIBUTE_NAME = "resource_path"
	Attribute which defines base directory path for resource files. More...

static constexpr const char *const	SERVERNAME_ATTRIBUTE_NAME = "servername"
	Attribute which defines the logical server name that client uses as identification. More...

Additional Inherited Members
Public Types inherited from kanzi::connect::ConnectionConfigurationReadIf
using	AttributeMap = map< string, string >

Detailed Description

Parser for client side connection configuration files.

Constructor & Destructor Documentation

◆ ConnectionConfigurationParser()

kanzi::connect::ConnectionConfigurationParser::ConnectionConfigurationParser ( )

Constructor.

◆ ~ConnectionConfigurationParser()

virtual kanzi::connect::ConnectionConfigurationParser::~ConnectionConfigurationParser ( )

overridevirtual

dtor

Member Function Documentation

◆ countConfigurations()

virtual size_t kanzi::connect::ConnectionConfigurationParser::countConfigurations ( ) const

overridevirtual

See also: ConnectionConfigurationReadIf::countConfigurations

Reimplemented from kanzi::connect::ConnectionConfigurationReadIf.

◆ getConfiguration() [1/2]

virtual bool kanzi::connect::ConnectionConfigurationParser::getConfiguration ( Configuration & configurationOut ) const

overridevirtual

See also: ConnectionConfigurationReadIf::getConfiguration

Implements kanzi::connect::ConnectionConfigurationReadIf.

◆ getConfiguration() [2/2]

virtual bool kanzi::connect::ConnectionConfigurationParser::getConfiguration	(	const string &	serverName,
		Configuration &	configurationOut
	)		const

overridevirtual

See also: ConnectionConfigurationReadIf::getConfiguration

Implements kanzi::connect::ConnectionConfigurationReadIf.

◆ getConfigurationAt()

virtual Configuration kanzi::connect::ConnectionConfigurationParser::getConfigurationAt ( size_t position ) const

overridevirtual

See also: ConnectionConfigurationReadIf::getConfigurationAt

Reimplemented from kanzi::connect::ConnectionConfigurationReadIf.

◆ getConfigurationEx()

virtual Configuration kanzi::connect::ConnectionConfigurationParser::getConfigurationEx ( const string & serverName ) const

overridevirtual

See also: ConnectionConfigurationReadIf::getConfigurationEx

Implements kanzi::connect::ConnectionConfigurationReadIf.

◆ parse()

bool kanzi::connect::ConnectionConfigurationParser::parse	(	const string &	resourceDirectory,
		const string &	configurationFileName
	)

Parse configuration file.

Parameters

resourceDirectory	Directory path to first search for the configuration file
configurationFileName	The filepath to the configuration file in the file system

Returns: True if the file was successfully parsed

◆ parseEx()

bool kanzi::connect::ConnectionConfigurationParser::parseEx ( const string & configurationFileName )

Parse configuration file Use this version for native android applications.

Parameters

configurationFileName The filepath to the configuration file in the file system

Returns: True if the file was successfully parsed

◆ parseString()

bool kanzi::connect::ConnectionConfigurationParser::parseString ( const string & configurationFileContents )

Parse configuration string Use this version for native android applications.

Parameters

configurationFileContents The contents of the configuration file in the file system

Returns: True if the string was successfully parsed

Member Data Documentation

◆ DEFAULT_CONFIGURATION

const Configuration kanzi::connect::ConnectionConfigurationParser::DEFAULT_CONFIGURATION

static

Contains the default configuration used if configuration file is not found.

The documentation for this class was generated from the following file:

connect/configuration/connection_configuration_parser.hpp

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ConnectionConfigurationParser()

◆ ~ConnectionConfigurationParser()

Member Function Documentation

◆ countConfigurations()

◆ getConfiguration() [1/2]

◆ getConfiguration() [2/2]

◆ getConfigurationAt()

◆ getConfigurationEx()

◆ parse()

◆ parseEx()

◆ parseString()

Member Data Documentation

◆ DEFAULT_CONFIGURATION