A class for internal use, that encapsulates the properties that can be set through DistributedSystem.Connect or a geode.properties file. More...

Inherits UMWrap< apache::geode::client::SystemProperties >.

Public Member Functions
void	LogSettings ()
	Prints all settings to the process log. More...

	SystemProperties (Properties< String^, String^>^ properties)
	Constructor. More...

	SystemProperties (Properties< String^, String^>^ properties, String^ configFile)
	Constructor. More...

Properties
bool	AppDomainEnabled `[get]`
	Whether client is running in multiple AppDomain or not. More...

String^	CacheXmlFile `[get]`
	Returns the name of the "cache.xml" file. More...

String^	ConflateEvents `[get]`
	Returns the conflate event's option More...

System::UInt32	ConnectTimeout `[get]`
	Returns the connect timeout used for server and locator handshakes. More...

bool	CrashDumpEnabled `[get]`
	True if the crash dump generation for unhandled fatal exceptions is enabled. More...

bool	DebugStackTraceEnabled `[get]`
	True if the stack trace is enabled. More...

String^	DurableClientId `[get]`
	Returns the durable client's ID. More...

System::UInt32	DurableTimeout `[get]`
	Returns the durable client's timeout. More...

Properties< String^, String^>^	GetSecurityProperties `[get]`
	Returns all the security properties More...

LogLevel	GFLogLevel `[get]`
	Returns the message logging level. More...

System::Int32	HeapLRUDelta `[get]`
	Returns the HeapLRUDelta value (a percent value). More...

size_t	HeapLRULimit `[get]`
	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 `[get]`
	Returns a boolean that specifies if heapLRULimit has been enabled for the process. More...

bool	IsSecurityOn `[get]`
	True if client needs to be authenticated More...

System::Int32	LogDiskSpaceLimit `[get]`
	Returns the maximum log Disk size, in bytes, or 0 if unlimited. More...

String^	LogFileName `[get]`
	Returns the name of the message log file. More...

System::Int32	LogFileSizeLimit `[get]`
	Returns the maximum log file size, in bytes, or 0 if unlimited. More...

System::UInt32	MaxQueueSize `[get]`
	Returns the max queue size for notification messages More...

System::Int32	MaxSocketBufferSize `[get]`
	Returns the maximum socket buffer size to use More...

String^	Name `[get]`
	Returns the system name. More...

System::Int32	NotifyAckInterval `[get]`
	Returns the periodic notify ack interval More...

System::Int32	NotifyDupCheckLife `[get]`
	Returns the expiry time of an idle event id map entry for duplicate notification checking More...

bool	OnClientDisconnectClearPdxTypeIds `[get]`
	True if app want to clear pdx types ids on client disconnect More...

System::Int32	PingInterval `[get]`
	Returns the time between two consecutive ping to servers More...

bool	ReadTimeoutUnitInMillis `[get]`
	This can be called to know whether read timeout unit is in milli second. More...

System::Int32	RedundancyMonitorInterval `[get]`
	Returns the time between two consecutive checks for redundancy for HA More...

bool	SSLEnabled `[get]`
	True if ssl connection support is enabled. More...

String^	SSLKeyStore `[get]`
	Returns the SSL private keystore file path. More...

String^	SSLKeystorePassword `[get]`
	Returns the client keystore password. More...

bool	SSLStrictMode `[get]`
	True if cluster SSL certificate verification is required. More...

String^	SSLTrustStore `[get]`
	Returns the SSL public certificate trust store file path. More...

String^	StatisticsArchiveFile `[get]`
	Returns the name of the statistics archive file. More...

bool	StatisticsEnabled `[get]`
	True if statistics are enabled (archived). More...

System::Int32	StatisticsSampleInterval `[get]`
	Returns the sampling interval, that is, how often the statistics thread writes to disk, in seconds. More...

System::Int32	StatsDiskSpaceLimit `[get]`
	Returns the maximum statistics Disk size, in bytes, or 0 if unlimited. More...

System::Int32	StatsFileSizeLimit `[get]`
	Returns the maximum statistics file size, in bytes, or 0 if unlimited. More...

System::UInt32	SuspendedTxTimeout `[get]`
	Returns the timeout after which suspended transactions are rolled back. More...

Detailed Description

A class for internal use, that encapsulates the properties that can be set through DistributedSystem.Connect or a geode.properties file.

Constructor & Destructor Documentation

◆ SystemProperties() [1/2]

Apache::Geode::Client::SystemProperties::SystemProperties ( Properties< String^, String^>^ properties )

Constructor.

Sets the default (hard-coded) values first, and then overwrites those with any values found in the given properties.

Parameters

properties initialize with the given properties

◆ SystemProperties() [2/2]

Apache::Geode::Client::SystemProperties::SystemProperties	(	Properties< String^, String^>^	properties,
		String^	configFile
	)

Constructor.

Sets the default (hard-coded) values.
Overwrites those with any values from systemDefault/geode.properties
Overwrites those with any values from the given file (if it exists) or the local ./geode.properties (if the given file does not exist).
Overwrites those with any values found in the given properties.

Parameters

properties	these overwrite any other values already set
configFile	see summary

Member Function Documentation

◆ LogSettings()

void Apache::Geode::Client::SystemProperties::LogSettings ( )

Prints all settings to the process log.

Property Documentation

◆ AppDomainEnabled

bool Apache::Geode::Client::SystemProperties::AppDomainEnabled

get

Whether client is running in multiple AppDomain or not.

Default value is "false".

Returns: true if enabled

◆ CacheXmlFile

String^ Apache::Geode::Client::SystemProperties::CacheXmlFile

get

Returns the name of the "cache.xml" file.

Returns: the filename

◆ ConflateEvents

String^ Apache::Geode::Client::SystemProperties::ConflateEvents

get

Returns the conflate event's option

Returns: the conflate event option

◆ ConnectTimeout

System:: UInt32 Apache::Geode::Client::SystemProperties::ConnectTimeout

get

Returns the connect timeout used for server and locator handshakes.

Returns: the connect timeout used for server and locator handshakes

◆ CrashDumpEnabled

bool Apache::Geode::Client::SystemProperties::CrashDumpEnabled

get

True if the crash dump generation for unhandled fatal exceptions is enabled.

If "log-file" property has been specified then they are created in the same directory as the log file, and having the same prefix as log file. By default crash dumps are created in the current working directory and have the "geode_cpp" prefix.

The actual dump file will have timestamp and process ID in the full name.

Returns: true if enabled

◆ DebugStackTraceEnabled

bool Apache::Geode::Client::SystemProperties::DebugStackTraceEnabled

get

True if the stack trace is enabled.

Returns: true if enabled

◆ DurableClientId

String^ Apache::Geode::Client::SystemProperties::DurableClientId

get

Returns the durable client's ID.

Returns: the durable client ID

◆ DurableTimeout

System:: UInt32 Apache::Geode::Client::SystemProperties::DurableTimeout

get

Returns the durable client's timeout.

Returns: the durable client timeout

◆ GetSecurityProperties

Properties< String^, String^>^ Apache::Geode::Client::SystemProperties::GetSecurityProperties

get

Returns all the security properties

Returns: the security properties

◆ GFLogLevel

LogLevel Apache::Geode::Client::SystemProperties::GFLogLevel

get

Returns the message logging level.

Returns: the log level

◆ HeapLRUDelta

System:: Int32 Apache::Geode::Client::SystemProperties::HeapLRUDelta

get

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%

Returns: the HeapLRUDelta value

◆ HeapLRULimit

size_t Apache::Geode::Client::SystemProperties::HeapLRULimit

get

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

Returns: the HeapLRULimit value

◆ HeapLRULimitEnabled

bool Apache::Geode::Client::SystemProperties::HeapLRULimitEnabled

get

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

Returns: true if enabled

◆ IsSecurityOn

bool Apache::Geode::Client::SystemProperties::IsSecurityOn

get

True if client needs to be authenticated

Returns: true if enabled

◆ LogDiskSpaceLimit

System:: Int32 Apache::Geode::Client::SystemProperties::LogDiskSpaceLimit

get

Returns the maximum log Disk size, in bytes, or 0 if unlimited.

Returns: the maximum limit

◆ LogFileName

String^ Apache::Geode::Client::SystemProperties::LogFileName

get

Returns the name of the message log file.

Returns: the filename

◆ LogFileSizeLimit

System:: Int32 Apache::Geode::Client::SystemProperties::LogFileSizeLimit

get

Returns the maximum log file size, in bytes, or 0 if unlimited.

Returns: the maximum limit

◆ MaxQueueSize

System:: UInt32 Apache::Geode::Client::SystemProperties::MaxQueueSize

get

Returns the max queue size for notification messages

Returns: the max queue size

◆ MaxSocketBufferSize

System:: Int32 Apache::Geode::Client::SystemProperties::MaxSocketBufferSize

get

Returns the maximum socket buffer size to use

Returns: the MaxSocketBufferSize value

◆ Name

String^ Apache::Geode::Client::SystemProperties::Name

get

Returns the system name.

Returns: the name

◆ NotifyAckInterval

System:: Int32 Apache::Geode::Client::SystemProperties::NotifyAckInterval

get

Returns the periodic notify ack interval

Returns: the NotifyAckInterval value

◆ NotifyDupCheckLife

System:: Int32 Apache::Geode::Client::SystemProperties::NotifyDupCheckLife

get

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

Returns: the NotifyDupCheckLife value

◆ OnClientDisconnectClearPdxTypeIds

bool Apache::Geode::Client::SystemProperties::OnClientDisconnectClearPdxTypeIds

get

True if app want to clear pdx types ids on client disconnect

Returns: true if enabled

◆ PingInterval

System:: Int32 Apache::Geode::Client::SystemProperties::PingInterval

get

Returns the time between two consecutive ping to servers

Returns: the PingInterval value

◆ ReadTimeoutUnitInMillis

bool Apache::Geode::Client::SystemProperties::ReadTimeoutUnitInMillis

get

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

Returns: true if enabled or false by default.

◆ RedundancyMonitorInterval

System:: Int32 Apache::Geode::Client::SystemProperties::RedundancyMonitorInterval

get

Returns the time between two consecutive checks for redundancy for HA

Returns: the RedundancyMonitorInterval value

◆ SSLEnabled

bool Apache::Geode::Client::SystemProperties::SSLEnabled

get

True if ssl connection support is enabled.

Returns: true if enabled

◆ SSLKeyStore

String^ Apache::Geode::Client::SystemProperties::SSLKeyStore

get

Returns the SSL private keystore file path.

Returns: the SSL private keystore file path

◆ SSLKeystorePassword

String^ Apache::Geode::Client::SystemProperties::SSLKeystorePassword

get

Returns the client keystore password.

Returns: Returns the client keystore password.

◆ SSLStrictMode

bool Apache::Geode::Client::SystemProperties::SSLStrictMode

get

True if cluster SSL certificate verification is required.

Returns: true if SSL strict mode is enabled

◆ SSLTrustStore

String^ Apache::Geode::Client::SystemProperties::SSLTrustStore

get

Returns the SSL public certificate trust store file path.

Returns: the SSL public certificate trust store file path

◆ StatisticsArchiveFile

String^ Apache::Geode::Client::SystemProperties::StatisticsArchiveFile

get

Returns the name of the statistics archive file.

Returns: the filename

◆ StatisticsEnabled

bool Apache::Geode::Client::SystemProperties::StatisticsEnabled

get

True if statistics are enabled (archived).

Returns: true if enabled

◆ StatisticsSampleInterval

System:: Int32 Apache::Geode::Client::SystemProperties::StatisticsSampleInterval

get

Returns the sampling interval, that is, how often the statistics thread writes to disk, in seconds.

Returns: the statistics sampling interval

◆ StatsDiskSpaceLimit

System:: Int32 Apache::Geode::Client::SystemProperties::StatsDiskSpaceLimit

get

Returns the maximum statistics Disk size, in bytes, or 0 if unlimited.

Returns: the maximum limit

◆ StatsFileSizeLimit

System:: Int32 Apache::Geode::Client::SystemProperties::StatsFileSizeLimit

get

Returns the maximum statistics file size, in bytes, or 0 if unlimited.

Returns: the maximum limit

◆ SuspendedTxTimeout

System:: UInt32 Apache::Geode::Client::SystemProperties::SuspendedTxTimeout

get

Returns the timeout after which suspended transactions are rolled back.

Returns: the timeout for suspended transactions

Public Member Functions

Properties