The SystemProperties class. More...

Public Member Functions
bool	autoReadyForEvents () const
	Whether a non durable client starts to receive and process subscription events automatically. More...

const std::chrono::milliseconds &	bucketWaitTimeout () const
	Returns the connect wait timeout(in milliseconds) used for to connect to server This is only applicable for linux. More...

const std::string &	conflateEvents () const
	Returns client Queueconflation option. More...

const std::chrono::milliseconds &	connectTimeout () const
	Returns the connect timeout used for server and locator handshakes. More...

const std::chrono::milliseconds &	connectWaitTimeout () const
	Returns the connect wait timeout(in milliseconds) used for to connect to server This is only applicable for linux. More...

const std::string &	durableClientId () const
	Returns the durable client ID. More...

const std::chrono::seconds &	durableTimeout () const
	Returns the durable timeout. More...

bool	enableChunkHandlerThread () const
	Returns true if chunk handler thread is enabled, false if not. More...

bool	getEnableTimeStatistics () const
	Whether time stats are enabled for the statistics. More...

std::shared_ptr< Properties >	getSecurityProperties () const
	Returns securityPropertiesPtr. More...

int32_t	heapLRUDelta () const
	Returns the HeapLRUDelta value (a percent value). More...

size_t	heapLRULimit () const
	Returns the HeapLRULimit value (in bytes), the maximum memory that values in a cache can use to store data before overflowing to disk or destroying entries to ensure that the server process never runs out of memory due to cache memory usage. More...

bool	heapLRULimitEnabled () const
	Returns a boolean that specifies if heapLRULimit has been enabled for the process. More...

bool	isDhOn () const
	Check whether Diffie-Hellman based credentials encryption is on. More...

bool	isEndpointShufflingDisabled () const
	Checks whether list of endpoint is shuffled or not. More...

uint32_t	logDiskSpaceLimit () const
	Returns the log-disk-space-limit. More...

const std::string &	logFilename () const
	Returns the name of the filename into which logging would be done. More...

uint32_t	logFileSizeLimit () const
	Returns the log-file-size-limit. More...

LogLevel	logLevel () const
	Returns the log level at which logging would be done. More...

void	logSettings ()
	print all settings to the process log. More...

int32_t	maxSocketBufferSize () const
	Returns the maximum socket buffer size to use. More...

const std::chrono::milliseconds &	notifyAckInterval () const
	Returns the periodic notify ack interval. More...

const std::chrono::milliseconds &	notifyDupCheckLife () const
	Returns the expiry time of an idle event id map entry for duplicate notification checking. More...

bool	onClientDisconnectClearPdxTypeIds () const
	Returns true if app wants to clear pdx type ids when client disconnect. More...

const std::chrono::seconds &	pingInterval () const
	Returns the time between two consecutive pings to servers. More...

const std::chrono::seconds &	redundancyMonitorInterval () const
	Returns the time between two consecutive checks for redundancy for HA. More...

const std::string &	securityClientDhAlgo () const
	Return the security Diffie-Hellman secret key algorithm. More...

const std::string &	securityClientKsPath () const
	Return the keystore (.pem file ) path. More...

void	setEnableChunkHandlerThread (bool set)
	Enables or disables the chunk handler thread. More...

void	setOnClientDisconnectClearPdxTypeIds (bool set)
	Set to true if app wants to clear pdx type ids when client disconnect. More...

bool	sslEnabled () const
	Whether SSL is enabled for socket connections. More...

const std::string &	sslKeyStore () const
	Returns the path of the private key file for SSL use. More...

const std::string &	sslKeystorePassword () const
	Returns the client keystore password. More...

const std::string &	sslTrustStore () const
	Returns the path of the public key file for SSL use. More...

const std::string &	statisticsArchiveFile () const
	Returns the name of the filename into which statistics would be archived. More...

bool	statisticsEnabled () const
	Tells whether statistics needs to be archived or not. More...

const std::chrono::milliseconds	statisticsSampleInterval () const
	Returns the sampling interval of the sampling thread. More...

uint32_t	statsDiskSpaceLimit () const
	Returns the stat-disk-size-limit. More...

uint32_t	statsFileSizeLimit () const
	Returns the stat-file-space-limit. More...

const std::chrono::seconds	suspendedTxTimeout () const
	Returns the timeout after which suspended transactions are rolled back. More...

	SystemProperties (const std::shared_ptr< Properties > &propertiesPtr, const std::string &configFile="")
	Constructor. More...

const std::chrono::milliseconds	tombstoneTimeout () const
	Returns the tombstone timeout. More...

	~SystemProperties ()
	Destructor. More...

Detailed Description

The SystemProperties class.

A class for internal use that encapsulates the properties that can be set from DistributedSystem::connect.

Constructor & Destructor Documentation

◆ SystemProperties()

apache::geode::client::SystemProperties::SystemProperties	(	const std::shared_ptr< Properties > &	propertiesPtr,
		const std::string &	configFile = `""`
	)

explicit

Constructor.

Will set the default values first, and then overwrite with the values found in the given Properties object (if any), and then from the values in the given file (if it exists).

If useMemType is true, use the given member type; if false, always set member type to SERVER.

◆ ~SystemProperties()

apache::geode::client::SystemProperties::~SystemProperties ( )

Destructor.

Member Function Documentation

◆ autoReadyForEvents()

bool apache::geode::client::SystemProperties::autoReadyForEvents ( ) const

inline

Whether a non durable client starts to receive and process subscription events automatically.

If set to false then a non-durable client should call the Cache::readyForEvents() method after all regions are created and listeners attached for the client to start receiving events whether the client is initialized programmatically or declaratively.

Returns: the value of the property.

◆ bucketWaitTimeout()

const std::chrono::milliseconds& apache::geode::client::SystemProperties::bucketWaitTimeout ( ) const

inline

Returns the connect wait timeout(in milliseconds) used for to connect to server This is only applicable for linux.

◆ conflateEvents()

const std::string& apache::geode::client::SystemProperties::conflateEvents ( ) const

inline

Returns client Queueconflation option.

◆ connectTimeout()

const std::chrono::milliseconds& apache::geode::client::SystemProperties::connectTimeout ( ) const

inline

Returns the connect timeout used for server and locator handshakes.

◆ connectWaitTimeout()

const std::chrono::milliseconds& apache::geode::client::SystemProperties::connectWaitTimeout ( ) const

inline

Returns the connect wait timeout(in milliseconds) used for to connect to server This is only applicable for linux.

◆ durableClientId()

const std::string& apache::geode::client::SystemProperties::durableClientId ( ) const

inline

Returns the durable client ID.

◆ durableTimeout()

const std::chrono::seconds& apache::geode::client::SystemProperties::durableTimeout ( ) const

inline

Returns the durable timeout.

◆ enableChunkHandlerThread()

bool apache::geode::client::SystemProperties::enableChunkHandlerThread ( ) const

inline

Returns true if chunk handler thread is enabled, false if not.

◆ getEnableTimeStatistics()

bool apache::geode::client::SystemProperties::getEnableTimeStatistics ( ) const

inline

Whether time stats are enabled for the statistics.

◆ getSecurityProperties()

std::shared_ptr<Properties> apache::geode::client::SystemProperties::getSecurityProperties ( ) const

inline

Returns securityPropertiesPtr.

Returns: std::shared_ptr<Properties> value.

◆ heapLRUDelta()

int32_t apache::geode::client::SystemProperties::heapLRUDelta ( ) const

inline

Returns the HeapLRUDelta value (a percent value).

This specifies the percentage of entries the system will evict each time it detects that it has exceeded the HeapLRULimit. Defaults to 10%

◆ heapLRULimit()

size_t apache::geode::client::SystemProperties::heapLRULimit ( ) const

inline

Returns the HeapLRULimit value (in bytes), the maximum memory that values in a cache can use to store data before overflowing to disk or destroying entries to ensure that the server process never runs out of memory due to cache memory usage.

◆ heapLRULimitEnabled()

bool apache::geode::client::SystemProperties::heapLRULimitEnabled ( ) const

inline

Returns a boolean that specifies if heapLRULimit has been enabled for the process.

If enabled, the HeapLRULimit specifies the maximum amount of memory that values in a cache can use to store data before overflowing to disk or destroying entries to ensure that the server process never runs out of memory

◆ isDhOn()

bool apache::geode::client::SystemProperties::isDhOn ( ) const

inline

Check whether Diffie-Hellman based credentials encryption is on.

Returns: bool flag to indicate whether DH for credentials is on.

◆ isEndpointShufflingDisabled()

bool apache::geode::client::SystemProperties::isEndpointShufflingDisabled ( ) const

inline

Checks whether list of endpoint is shuffled or not.

Returns: bool value.

◆ logDiskSpaceLimit()

uint32_t apache::geode::client::SystemProperties::logDiskSpaceLimit ( ) const

inline

Returns the log-disk-space-limit.

◆ logFilename()

const std::string& apache::geode::client::SystemProperties::logFilename ( ) const

inline

Returns the name of the filename into which logging would be done.

◆ logFileSizeLimit()

uint32_t apache::geode::client::SystemProperties::logFileSizeLimit ( ) const

inline

Returns the log-file-size-limit.

◆ logLevel()

LogLevel apache::geode::client::SystemProperties::logLevel ( ) const

inline

Returns the log level at which logging would be done.

◆ logSettings()

void apache::geode::client::SystemProperties::logSettings ( )

print all settings to the process log.

◆ maxSocketBufferSize()

int32_t apache::geode::client::SystemProperties::maxSocketBufferSize ( ) const

inline

Returns the maximum socket buffer size to use.

◆ notifyAckInterval()

const std::chrono::milliseconds& apache::geode::client::SystemProperties::notifyAckInterval ( ) const

inline

Returns the periodic notify ack interval.

◆ notifyDupCheckLife()

const std::chrono::milliseconds& apache::geode::client::SystemProperties::notifyDupCheckLife ( ) const

inline

Returns the expiry time of an idle event id map entry for duplicate notification checking.

◆ onClientDisconnectClearPdxTypeIds()

bool apache::geode::client::SystemProperties::onClientDisconnectClearPdxTypeIds ( ) const

inline

Returns true if app wants to clear pdx type ids when client disconnect.

deafult is false.

◆ pingInterval()

const std::chrono::seconds& apache::geode::client::SystemProperties::pingInterval ( ) const

inline

Returns the time between two consecutive pings to servers.

◆ redundancyMonitorInterval()

const std::chrono::seconds& apache::geode::client::SystemProperties::redundancyMonitorInterval ( ) const

inline

Returns the time between two consecutive checks for redundancy for HA.

◆ securityClientDhAlgo()

const std::string& apache::geode::client::SystemProperties::securityClientDhAlgo ( ) const

inline

Return the security Diffie-Hellman secret key algorithm.

◆ securityClientKsPath()

const std::string& apache::geode::client::SystemProperties::securityClientKsPath ( ) const

inline

Return the keystore (.pem file ) path.

◆ setEnableChunkHandlerThread()

void apache::geode::client::SystemProperties::setEnableChunkHandlerThread ( bool set )

inline

Enables or disables the chunk handler thread.

◆ setOnClientDisconnectClearPdxTypeIds()

void apache::geode::client::SystemProperties::setOnClientDisconnectClearPdxTypeIds ( bool set )

inline

Set to true if app wants to clear pdx type ids when client disconnect.

Default is false.

◆ sslEnabled()

bool apache::geode::client::SystemProperties::sslEnabled ( ) const

inline

Whether SSL is enabled for socket connections.

◆ sslKeyStore()

const std::string& apache::geode::client::SystemProperties::sslKeyStore ( ) const

inline

Returns the path of the private key file for SSL use.

◆ sslKeystorePassword()

const std::string& apache::geode::client::SystemProperties::sslKeystorePassword ( ) const

inline

Returns the client keystore password.

◆ sslTrustStore()

const std::string& apache::geode::client::SystemProperties::sslTrustStore ( ) const

inline

Returns the path of the public key file for SSL use.

◆ statisticsArchiveFile()

const std::string& apache::geode::client::SystemProperties::statisticsArchiveFile ( ) const

inline

Returns the name of the filename into which statistics would be archived.

◆ statisticsEnabled()

bool apache::geode::client::SystemProperties::statisticsEnabled ( ) const

inline

Tells whether statistics needs to be archived or not.

◆ statisticsSampleInterval()

const std::chrono::milliseconds apache::geode::client::SystemProperties::statisticsSampleInterval ( ) const

inline

Returns the sampling interval of the sampling thread.

This would be how often the statistics thread writes to disk.

◆ statsDiskSpaceLimit()

uint32_t apache::geode::client::SystemProperties::statsDiskSpaceLimit ( ) const

inline

Returns the stat-disk-size-limit.

◆ statsFileSizeLimit()

uint32_t apache::geode::client::SystemProperties::statsFileSizeLimit ( ) const

inline

Returns the stat-file-space-limit.

◆ suspendedTxTimeout()

const std::chrono::seconds apache::geode::client::SystemProperties::suspendedTxTimeout ( ) const

inline

Returns the timeout after which suspended transactions are rolled back.

◆ tombstoneTimeout()

const std::chrono::milliseconds apache::geode::client::SystemProperties::tombstoneTimeout ( ) const

inline

Returns the tombstone timeout.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SystemProperties()

◆ ~SystemProperties()

Member Function Documentation

◆ autoReadyForEvents()

◆ bucketWaitTimeout()

◆ conflateEvents()

◆ connectTimeout()

◆ connectWaitTimeout()

◆ durableClientId()

◆ durableTimeout()

◆ enableChunkHandlerThread()

◆ getEnableTimeStatistics()

◆ getSecurityProperties()

◆ heapLRUDelta()

◆ heapLRULimit()

◆ heapLRULimitEnabled()

◆ isDhOn()

◆ isEndpointShufflingDisabled()

◆ logDiskSpaceLimit()

◆ logFilename()

◆ logFileSizeLimit()

◆ logLevel()

◆ logSettings()

◆ maxSocketBufferSize()

◆ notifyAckInterval()

◆ notifyDupCheckLife()

◆ onClientDisconnectClearPdxTypeIds()

◆ pingInterval()

◆ redundancyMonitorInterval()

◆ securityClientDhAlgo()

◆ securityClientKsPath()

◆ setEnableChunkHandlerThread()

◆ setOnClientDisconnectClearPdxTypeIds()

◆ sslEnabled()

◆ sslKeyStore()

◆ sslKeystorePassword()

◆ sslTrustStore()

◆ statisticsArchiveFile()

◆ statisticsEnabled()

◆ statisticsSampleInterval()

◆ statsDiskSpaceLimit()

◆ statsFileSizeLimit()

◆ suspendedTxTimeout()

◆ tombstoneTimeout()