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

Public Member Functions
const char *	authInitFactory () const
	Return the security auth factory. More...

const char *	authInitLibrary () const
	Return the security auth library. More...

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

const uint32_t	bucketWaitTimeout () const
	Returns the connect wait timeout(in millis) used for to connect to server This is only applicable for linux. More...

char *	conflateEvents ()
	Returns client Queueconflation option. More...

const uint32_t	connectTimeout () const
	Returns the connect timeout used for server and locator handshakes. More...

const uint32_t	connectWaitTimeout () const
	Returns the connect wait timeout(in millis) used for to connect to server This is only applicable for linux. More...

const bool	crashDumpEnabled () const
	Returns true if crash dump generation for unhandled fatal errors is enabled, false otherwise. More...

const bool	debugStackTraceEnabled () const
	Returns true if the stack trace is enabled ,false otherwise. More...

bool	disableChunkHandlerThread () const
	This can be call to know whether chunkhandler thread is disable for that opertaion. More...

const char *	durableClientId () const
	Returns the durable client ID. More...

const uint32_t	durableTimeout () const
	Returns the durable timeout. More...

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

PropertiesPtr	getSecurityProperties () const
	Returns securityPropertiesPtr. More...

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

const 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...

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

bool	isAppDomainEnabled () const
	This property checks whether C# client is running in multiple appdoamin or not. More...

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

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

bool	isGridClient () const
	Checks to see if this native client is being invoked as part of small grid jobs; use this setting to disable some creation of threads and reducing start/stop time. More...

bool	isSecurityOn () const
	Checks whether Security is on or off. More...

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

const char *	logFilename () const
	Returns the name of the filename into which logging would be done. More...

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

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

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

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

const int32_t	notifyAckInterval () const
	Returns the periodic notify ack interval. More...

const int32_t	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 want to clear pdx type ids when client disconnect. More...

const int32_t	pingInterval () const
	Returns the time between two consecutive ping to servers. More...

bool	readTimeoutUnitInMillis () const
	This can be call to know whether read timeout unit is in milli second. More...

const int32_t	redundancyMonitorInterval () const
	Returns the time between two consecutive checks for redundancy for HA. More...

const char *	securityClientDhAlgo ()
	Return the security diffie hellman secret key algo. More...

const char *	securityClientKsPath ()
	Return the keystore (.pem file ) path. More...

void	setDisableChunkHandlerThread (bool set)
	This can be call multiple time to disable chunkhandler thread for those operations. More...

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

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

const char *	sslKeyStore () const
	Returns the path of the private key file for SSL use. More...

const char *	sslKeystorePassword () const
	Returns the client keystore password. More...

const char *	sslTrustStore () const
	Returns the path of the public key file for SSL use. More...

const char *	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 uint32_t	statisticsSampleInterval () const
	Returns the sampling interval of the sampling thread. More...

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

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

const uint32_t	suspendedTxTimeout () const
	Returns the timeout after which suspended transactions are rolled back. More...

	SystemProperties (const PropertiesPtr &propertiesPtr, const char *configFile=NULL)
	Constructor. More...

const uint32_t	tombstoneTimeoutInMSec () const
	Returns the tombstone timeout . More...

	~SystemProperties ()
	Destructor. More...

Detailed Description

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

Constructor & Destructor Documentation

apache::geode::client::SystemProperties::SystemProperties	(	const PropertiesPtr &	propertiesPtr,
		const char *	configFile = `NULL`
	)

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.

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

Destructor.

Member Function Documentation

const char* apache::geode::client::SystemProperties::authInitFactory ( ) const

inline

Return the security auth factory.

const char* apache::geode::client::SystemProperties::authInitLibrary ( ) const

inline

Return the security auth library.

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.

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

inline

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

char* apache::geode::client::SystemProperties::conflateEvents ( )

inline

Returns client Queueconflation option.

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

inline

Returns the connect timeout used for server and locator handshakes.

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

inline

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

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

inline

Returns true if crash dump generation for unhandled fatal errors is enabled, false otherwise.

By default crash dumps are created in the current working directory. If log-file has been specified then they are created in the same directory as the log file, and having the same prefix as log file. The default prefix is "geode_cpp". The actual dump file will have timestamp and process ID in the full name.

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

inline

Returns true if the stack trace is enabled ,false otherwise.

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

inline

This can be call to know whether chunkhandler thread is disable for that opertaion.

const char* apache::geode::client::SystemProperties::durableClientId ( ) const

inline

Returns the durable client ID.

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

inline

Returns the durable timeout.

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

inline

Whether time stats are enabled for the statistics.

PropertiesPtr apache::geode::client::SystemProperties::getSecurityProperties ( ) const

inline

Returns securityPropertiesPtr.

Returns: PropertiesPtr value.

const 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%

const 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.

const 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

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

inline

This property checks whether C# client is running in multiple appdoamin or not.

Default value is "false".

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

inline

Check whether Diffie-Hellman based credentials encryption is on.

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

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

inline

Checks whether list of endpoint is shuffeled or not.

Returns: bool value.

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

inline

Checks to see if this native client is being invoked as part of small grid jobs; use this setting to disable some creation of threads and reducing start/stop time.

Note that this setting can cause improper behaviour in some cases like: 1) client that is setup in listening mode and a server failure may not lead to failover by client 2) while shutting down the client will not send a proper CLOSE_CONNECTION message so server will report EOF exceptions and may detect client disconnect after quite some time Also note that there may be some performance loss in queries and Region::getAll due to unavailability of parallel processing threads.

Returns: true if the "grid-client" property is set

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

inline

Checks whether Security is on or off.

Returns: bool value.

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

inline

Returns the log-disk-space-limit.

const char* apache::geode::client::SystemProperties::logFilename ( ) const

inline

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

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

inline

Returns the log-file-size-limit.

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

inline

Returns the log level at which logging would be done.

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

print all settings to the process log.

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

inline

Returns the maximum socket buffer size to use.

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

inline

Returns the periodic notify ack interval.

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

inline

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

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

inline

returns true if app want to clear pdx type ids when client disconnect.

deafult is false.

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

inline

Returns the time between two consecutive ping to servers.

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

inline

This can be call to know whether read timeout unit is in milli second.

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

inline

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

const char* apache::geode::client::SystemProperties::securityClientDhAlgo ( )

inline

Return the security diffie hellman secret key algo.

const char* apache::geode::client::SystemProperties::securityClientKsPath ( )

inline

Return the keystore (.pem file ) path.

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

inline

This can be call multiple time to disable chunkhandler thread for those operations.

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

inline

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

deafult is false.

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

inline

Whether SSL is enabled for socket connections.

const char* apache::geode::client::SystemProperties::sslKeyStore ( ) const

inline

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

const char* apache::geode::client::SystemProperties::sslKeystorePassword ( ) const

inline

Returns the client keystore password.

const char* apache::geode::client::SystemProperties::sslTrustStore ( ) const

inline

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

const char* apache::geode::client::SystemProperties::statisticsArchiveFile ( ) const

inline

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

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

inline

Tells whether statistics needs to be archived or not.

const uint32_t 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 in seconds.

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

inline

Returns the stat-disk-size-limit.

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

inline

Returns the stat-file-space-limit.

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

inline

Returns the timeout after which suspended transactions are rolled back.

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

inline

Returns the tombstone timeout .

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation