Configurator Class Reference

Configure a memory server. More...

#include <RobotAPI/libraries/armem/client/Configurator.h>

Public Member Functions
	Configurator (const Configurator &)=default
	Construct a memory reader. More...
	Configurator (server::ConfiguringMemoryInterfacePrx configuringMemory=nullptr)
	operator bool () const
void	setConfiguringMemory (server::ConfiguringMemoryInterfacePrx configuringMemory)
void	useDiskPersistenceStrategy (const std::string &identifier, const std::string &exportName, const std::string &exportPath, bool overwritePrevStrategy)
	Use the disk as LTM persistence sink. More...
void	useRestPersistenceStrategy (const std::string &identifier, const std::string &exportName, const std::string &host, int port, bool overwritePrevStrategy)
	Use a rest server as LTM persistence sink. More...

Public Attributes
server::ConfiguringMemoryInterfacePrx	configurationPrx

Detailed Description

Configure a memory server.

Set the persistence strategy for the ltm of a memory server: Currently available: REST and DISK TODO: MongoDB

Definition at line 17 of file Configurator.h.

Constructor & Destructor Documentation

Configurator() [1/2]

Configurator ( const Configurator &  )

default

Construct a memory reader.

Parameters

memory

The memory proxy.

Configurator() [2/2]

Configurator ( server::ConfiguringMemoryInterfacePrx  configuringMemory = nullptr )

inline

Definition at line 26 of file Configurator.h.

Member Function Documentation

operator bool()

operator bool ( ) const

inline

Definition at line 57 of file Configurator.h.

setConfiguringMemory()

void setConfiguringMemory

(

server::ConfiguringMemoryInterfacePrx

configuringMemory

)

useDiskPersistenceStrategy()

void useDiskPersistenceStrategy	(	const std::string &	identifier,
		const std::string &	exportName,
		const std::string &	exportPath,
		bool	overwritePrevStrategy
	)

Use the disk as LTM persistence sink.

Parameters

identifier	LTM identifier that should be unique and is used as origin when any new instances are commited to the wm.
exportName	Export name of the LTM on the disk (e.g. /exportPath/exportName/...)
exportPath	Base path of the ltm export
overwritePrevStrategy	if true, the newly defined strategy overwrites the current strategy resulting in a single strategy. If false, the newly defined strategy is appened to the current stategies (

See also

RedundantPersistenceStrategy).

Definition at line 14 of file Configurator.cpp.

useRestPersistenceStrategy()

void useRestPersistenceStrategy	(	const std::string &	identifier,
		const std::string &	exportName,
		const std::string &	host,
		int	port,
		bool	overwritePrevStrategy
	)

Use a rest server as LTM persistence sink.

Parameters

identifier	LTM identifier that should be unique and is used as origin when any new instances are commited to the wm.
exportName	Export name of the LTM at the rest server (e.g. http:://host:port/exportName/...)
host	ip to the rest server (e.g. localhost or a specific ip)
port	network port on which the server is accessible (e.g. 8080)
overwritePrevStrategy	if true, the newly defined strategy overwrites the current strategy resulting in a single strategy. If false, the newly defined strategy is appened to the current stategies (

See also

RedundantPersistenceStrategy).

Definition at line 7 of file Configurator.cpp.

Member Data Documentation

configurationPrx

server::ConfiguringMemoryInterfacePrx configurationPrx

Definition at line 65 of file Configurator.h.

---

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

• RobotAPI/libraries/armem/client/Configurator.h
• RobotAPI/libraries/armem/client/Configurator.cpp