GemStone::GemFire::Cache::SystemProperties

GemStone::GemFire::Cache::SystemProperties Class Reference

Detailed Description

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

Public Member Functions

void LogSettings ()
 SystemProperties (Properties^ properties, String^ configFile)
 SystemProperties (Properties^ properties)

Properties

bool AppDomainEnabled [get]
String^  CacheXmlFile [get]
String^  ConflateEvents [get]
uint32_t ConnectTimeout [get]
bool CrashDumpEnabled [get]
bool DebugStackTraceEnabled [get]
String^  DurableClientId [get]
uint32_t DurableTimeout [get]
Properties^  GetSecurityProperties [get]
LogLevel GFLogLevel [get]
int32_t HeapLRUDelta [get]
size_t HeapLRULimit [get]
bool HeapLRULimitEnabled [get]
bool IsSecurityOn [get]
String^  LicenseFileName [get]
String^  LicenseType [get]
int32_t LogDiskSpaceLimit [get]
String^  LogFileName [get]
int32_t LogFileSizeLimit [get]
uint32_t MaxQueueSize [get]
int32_t MaxSocketBufferSize [get]
String^  Name [get]
int32_t NotifyAckInterval [get]
int32_t NotifyDupCheckLife [get]
int32_t PingInterval [get]
int32_t RedundancyMonitorInterval [get]
bool SSLEnabled [get]
String^  SSLKeyStore [get]
String^  SSLTrustStore [get]
String^  StatisticsArchiveFile [get]
bool StatisticsEnabled [get]
int32_t StatisticsSampleInterval [get]
int32_t StatsDiskSpaceLimit [get]
int32_t StatsFileSizeLimit [get]

Constructor & Destructor Documentation

GemStone::GemFire::Cache::SystemProperties::SystemProperties ( Properties^   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

GemStone::GemFire::Cache::SystemProperties::SystemProperties ( Properties^   properties,
String^   configFile 
)

Constructor.

  1. Sets the default (hard-coded) values.
  2. Overwrites those with any values from systemDefault/gfcpp.properties
  3. Overwrites those with any values from the given file (if it exists) or the local ./gfcpp.properties (if the given file does not exist).
  4. 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

void GemStone::GemFire::Cache::SystemProperties::LogSettings (  ) 

Prints all settings to the process log.

Property Documentation

bool GemStone::GemFire::Cache::SystemProperties::AppDomainEnabled [get]

Whether client is running in multiple AppDomain or not. Default value is "false".

Returns:
true if enabled

String^ GemStone::GemFire::Cache::SystemProperties::CacheXmlFile [get]

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

Returns:
the filename

String^ GemStone::GemFire::Cache::SystemProperties::ConflateEvents [get]

Returns the conflate event's option

Returns:
the conflate event option

uint32_t GemStone::GemFire::Cache::SystemProperties::ConnectTimeout [get]

Returns the connect timeout used for server and locator handshakes.

Returns:
the connect timeout used for server and locator handshakes

bool GemStone::GemFire::Cache::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 "gemfire_cpp" prefix.

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

Returns:
true if enabled

bool GemStone::GemFire::Cache::SystemProperties::DebugStackTraceEnabled [get]

True if the stack trace is enabled.

Returns:
true if enabled

String^ GemStone::GemFire::Cache::SystemProperties::DurableClientId [get]

Returns the durable client's ID.

Returns:
the durable client ID

uint32_t GemStone::GemFire::Cache::SystemProperties::DurableTimeout [get]

Returns the durable client's timeout.

Returns:
the durable client timeout

Properties^ GemStone::GemFire::Cache::SystemProperties::GetSecurityProperties [get]

Returns all the security properties

Returns:
the security properties

LogLevel GemStone::GemFire::Cache::SystemProperties::GFLogLevel [get]

Returns the message logging level.

Returns:
the log level

int32_t GemStone::GemFire::Cache::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

size_t GemStone::GemFire::Cache::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

bool GemStone::GemFire::Cache::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

bool GemStone::GemFire::Cache::SystemProperties::IsSecurityOn [get]

True if client needs to be authenticated

Returns:
true if enabled

String^ GemStone::GemFire::Cache::SystemProperties::LicenseFileName [get]

Returns the name of the license file.

Returns:
the filename

String^ GemStone::GemFire::Cache::SystemProperties::LicenseType [get]

Returns the license type.

Returns:
the type

int32_t GemStone::GemFire::Cache::SystemProperties::LogDiskSpaceLimit [get]

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

Returns:
the maximum limit

String^ GemStone::GemFire::Cache::SystemProperties::LogFileName [get]

Returns the name of the message log file.

Returns:
the filename

int32_t GemStone::GemFire::Cache::SystemProperties::LogFileSizeLimit [get]

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

Returns:
the maximum limit

uint32_t GemStone::GemFire::Cache::SystemProperties::MaxQueueSize [get]

Returns the max queue size for notification messages

Returns:
the max queue size

int32_t GemStone::GemFire::Cache::SystemProperties::MaxSocketBufferSize [get]

Returns the maximum socket buffer size to use

Returns:
the MaxSocketBufferSize value

String^ GemStone::GemFire::Cache::SystemProperties::Name [get]

Returns the system name.

Returns:
the name

int32_t GemStone::GemFire::Cache::SystemProperties::NotifyAckInterval [get]

Returns the periodic notify ack interval

Returns:
the NotifyAckInterval value

int32_t GemStone::GemFire::Cache::SystemProperties::NotifyDupCheckLife [get]

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

Returns:
the NotifyDupCheckLife value

int32_t GemStone::GemFire::Cache::SystemProperties::PingInterval [get]

Returns the time between two consecutive ping to servers

Returns:
the PingInterval value

int32_t GemStone::GemFire::Cache::SystemProperties::RedundancyMonitorInterval [get]

Returns the time between two consecutive checks for redundancy for HA

Returns:
the RedundancyMonitorInterval value

bool GemStone::GemFire::Cache::SystemProperties::SSLEnabled [get]

True if ssl connection support is enabled.

Returns:
true if enabled

String^ GemStone::GemFire::Cache::SystemProperties::SSLKeyStore [get]

Returns the SSL private keystore file path.

Returns:
the SSL private keystore file path

String^ GemStone::GemFire::Cache::SystemProperties::SSLTrustStore [get]

Returns the SSL public certificate trust store file path.

Returns:
the SSL public certificate trust store file path

String^ GemStone::GemFire::Cache::SystemProperties::StatisticsArchiveFile [get]

Returns the name of the statistics archive file.

Returns:
the filename

bool GemStone::GemFire::Cache::SystemProperties::StatisticsEnabled [get]

True if statistics are enabled (archived).

Returns:
true if enabled

int32_t GemStone::GemFire::Cache::SystemProperties::StatisticsSampleInterval [get]

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

Returns:
the statistics sampling interval

int32_t GemStone::GemFire::Cache::SystemProperties::StatsDiskSpaceLimit [get]

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

Returns:
the maximum limit

int32_t GemStone::GemFire::Cache::SystemProperties::StatsFileSizeLimit [get]

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

Returns:
the maximum limit

GemFire C++ Cache .NET API Documentation