fbcpp::DatabasePropertiesOptions Class Reference

Represents options used to configure database properties through the service manager. More...

#include <DatabaseManager.h>

Public Member Functions
const std::string &	getDatabase () const
	Returns the database path to be configured.
DatabasePropertiesOptions &	setDatabase (const std::string &value)
	Sets the database path to be configured.
const std::optional< ReplicaMode > &	getReplicaMode () const
	Returns the replica mode.
DatabasePropertiesOptions &	setReplicaMode (ReplicaMode value)
	Sets the replica mode.
const std::optional< ShutdownMode > &	getShutdownMode () const
	Returns the shutdown mode.
DatabasePropertiesOptions &	setShutdownMode (ShutdownMode value)
	Sets the shutdown mode.
const std::optional< ShutdownType > &	getShutdownType () const
	Returns the shutdown type.
DatabasePropertiesOptions &	setShutdownType (ShutdownType value)
	Sets the shutdown type.
const std::optional< int > &	getShutdownTimeout () const
	Returns the shutdown timeout in seconds.
DatabasePropertiesOptions &	setShutdownTimeout (int value)
	Sets the shutdown timeout in seconds.
const std::optional< bool > &	getOnline () const
	Returns whether the database should be brought online.
DatabasePropertiesOptions &	setOnline (bool value)
	Sets whether the database should be brought online.

Detailed Description

Represents options used to configure database properties through the service manager.

Definition at line 90 of file DatabaseManager.h.

Member Function Documentation

getDatabase()

const std::string & fbcpp::DatabasePropertiesOptions::getDatabase ( ) const

inline

Returns the database path to be configured.

Definition at line 96 of file DatabaseManager.h.

getOnline()

const std::optional< bool > & fbcpp::DatabasePropertiesOptions::getOnline ( ) const

inline

Returns whether the database should be brought online.

Definition at line 181 of file DatabaseManager.h.

getReplicaMode()

const std::optional< ReplicaMode > & fbcpp::DatabasePropertiesOptions::getReplicaMode ( ) const

inline

Returns the replica mode.

Definition at line 113 of file DatabaseManager.h.

getShutdownMode()

const std::optional< ShutdownMode > & fbcpp::DatabasePropertiesOptions::getShutdownMode ( ) const

inline

Returns the shutdown mode.

Definition at line 130 of file DatabaseManager.h.

getShutdownTimeout()

const std::optional< int > & fbcpp::DatabasePropertiesOptions::getShutdownTimeout ( ) const

inline

Returns the shutdown timeout in seconds.

Definition at line 164 of file DatabaseManager.h.

getShutdownType()

const std::optional< ShutdownType > & fbcpp::DatabasePropertiesOptions::getShutdownType ( ) const

inline

Returns the shutdown type.

Definition at line 147 of file DatabaseManager.h.

setDatabase()

DatabasePropertiesOptions & fbcpp::DatabasePropertiesOptions::setDatabase ( const std::string &  value )

inline

Sets the database path to be configured.

Definition at line 104 of file DatabaseManager.h.

setOnline()

DatabasePropertiesOptions & fbcpp::DatabasePropertiesOptions::setOnline ( bool  value )

inline

Sets whether the database should be brought online.

Definition at line 189 of file DatabaseManager.h.

setReplicaMode()

DatabasePropertiesOptions & fbcpp::DatabasePropertiesOptions::setReplicaMode ( ReplicaMode  value )

inline

Sets the replica mode.

Definition at line 121 of file DatabaseManager.h.

setShutdownMode()

DatabasePropertiesOptions & fbcpp::DatabasePropertiesOptions::setShutdownMode ( ShutdownMode  value )

inline

Sets the shutdown mode.

Definition at line 138 of file DatabaseManager.h.

setShutdownTimeout()

DatabasePropertiesOptions & fbcpp::DatabasePropertiesOptions::setShutdownTimeout ( int  value )

inline

Sets the shutdown timeout in seconds.

Definition at line 172 of file DatabaseManager.h.

setShutdownType()

DatabasePropertiesOptions & fbcpp::DatabasePropertiesOptions::setShutdownType ( ShutdownType  value )

inline

Sets the shutdown type.

Definition at line 155 of file DatabaseManager.h.

---

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

• src/fb-cpp/DatabaseManager.h