NDEVRServerManager

Manages a list of NDEVR OWL servers and persists them through INI configuration. More...

Inheritance diagram for NDEVRServerManager:

Collaboration diagram for NDEVRServerManager:

Classes
struct	OWLServer
	Represents an OWL server entry with a name and unique ID. More...

Public Member Functions
virtual void	finishReadingINI (INIFactory &factory) override
	Called after reading an INI file.
void	getINI (INIFactory &factory) override
	Populates the given INI factory with the options managed by this interface.
virtual void	prepareForINI (INIFactory &factory) override
	Called before reading or writing an INI file.
Public Member Functions inherited from INIInterface
	INIInterface ()
	Constructs an INIInterface with no default INI file.
	INIInterface (const File &default_ini)
	Constructs an INIInterface with the specified default INI file.
virtual	~INIInterface ()
	Virtual destructor for safe polymorphic cleanup.
virtual bool	readINIOptions ()
	Reads INI options from the default INI file.
virtual bool	readINIOptions (File &ini_file)
	Reads INI options from the specified INI file.
virtual bool	saveINIOptions (bool multithead=false)
	Saves INI options to the default INI file.
virtual bool	saveINIOptions (File &ini_file, bool multithead=false)
	Saves INI options to the specified INI file.
void	setDefaultINIFile (const File &file)
	Sets the default INI file path used for reading and writing options.
virtual void	writeToLog (const StringView &title, LogPtr log, uint01 log_level=2U)
	Writes the current INI options to the specified log with a title.
virtual void	writeToLog (LogPtr log, uint01 log_level=2U)
	Writes the current INI options to the specified log.

Static Public Member Functions
static NDEVRServerManager &	Default ()
	Returns the singleton instance.

Public Attributes
Resource< UUID >	preferred_server
	UUID of the preferred server.
Resource< Buffer< OWLServer > >	servers
	List of configured OWL servers.

Static Public Attributes
static Resource< uint02 >	default_owl_web_port
	Default web port for OWL connections.

Additional Inherited Members
Protected Attributes inherited from INIInterface
File	m_default_ini
	The default file path used for reading and writing INI options.

Detailed Description

Manages a list of NDEVR OWL servers and persists them through INI configuration.

---

Definition at line 43 of file NDEVRServerManager.h.

Member Function Documentation

Default()

NDEVRServerManager & NDEVRServerManager::Default ( )

static

Returns the singleton instance.

Returns

Reference to the default NDEVRServerManager.

finishReadingINI()

virtual void NDEVRServerManager::finishReadingINI ( INIFactory & )

overridevirtual

Called after reading an INI file.

Override to perform post-read processing.

Parameters

[in]

factory

The INI factory that was used during reading.

Reimplemented from INIInterface.

getINI()

void NDEVRServerManager::getINI ( INIFactory & factory )

overridevirtual

Populates the given INI factory with the options managed by this interface.

Parameters

[in]

factory

The INI factory to populate with option definitions.

Implements INIInterface.

prepareForINI()

virtual void NDEVRServerManager::prepareForINI ( INIFactory & )

overridevirtual

Called before reading or writing an INI file.

Override to perform pre-processing.

Parameters

[in]

factory

The INI factory that will be used during reading or writing.

Reimplemented from INIInterface.

---

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

• NDEVRServerClient/Headers/NDEVRServerManager.h