gemfire::SystemProperties Class Reference


Detailed Description

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

Public Member Functions

const char * authInitFactory () const
 Return the security auth factory.
const char * authInitLibrary () const
 Return the security auth library.
bool autoReadyForEvents () const
 Whether a non durable client starts to receive and process subscription events automatically.
char * conflateEvents ()
 Returns client Queueconflation option.
const uint32_t connectTimeout () const
 Returns the connect timeout used for server and locator handshakes.
const bool crashDumpEnabled () const
 Returns true if crash dump generation for unhandled fatal errors is enabled, false otherwise.
const bool debugStackTraceEnabled () const
 Returns true if the stack trace is enabled ,false otherwise.
const char * durableClientId () const
 Returns the durable client ID.
const uint32_t durableTimeout () const
 Returns the durable timeout.
bool getEnableTimeStatistics () const
 Whether time stats are enabled for the statistics.
PropertiesPtr getSecurityProperties () const
 Returns securityPropertiesPtr.
const int32_t heapLRUDelta () const
 Returns the HeapLRUDelta value (a percent value).
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.
const bool heapLRULimitEnabled () const
 Returns a boolean that specifies if heapLRULimit has been enabled for the process.
bool isAppDomainEnabled () const
 This property checks whether C# client is running in multiple appdoamin or not.
bool isDhOn ()
 Check whether Diffie-Hellman based credentials encryption is on.
bool isEndpointShufflingDisabled () const
 Checks whether list of endpoint is shuffeled or not.
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.
bool isSecurityOn () const
 Checks whether Security is on or off.
const uint32_t logDiskSpaceLimit () const
 Returns the log-disk-space-limit.
const char * logFilename () const
 Returns the name of the filename into which logging would be done.
const uint32_t logFileSizeLimit () const
 Returns the log-file-size-limit.
Log::LogLevel logLevel () const
 Returns the log level at which logging would be done.
void logSettings ()
 print all settings to the process log.
const int32_t maxSocketBufferSize () const
 Returns the maximum socket buffer size to use.
const int32_t notifyAckInterval () const
 Returns the periodic notify ack interval.
const int32_t notifyDupCheckLife () const
 Returns the expiry time of an idle event id map entry for duplicate notification checking.
const int32_t pingInterval () const
 Returns the time between two consecutive ping to servers.
const int32_t redundancyMonitorInterval () const
 Returns the time between two consecutive checks for redundancy for HA.
const char * securityClientDhAlgo ()
 Return the security diffie hellman secret key algo.
const char * securityClientKsPath ()
 Return the keystore (.pem file ) path.
bool sslEnabled () const
 Whether SSL is enabled for socket connections.
const char * sslKeyStore () const
 Returns the path of the private key file for SSL use.
const char * sslTrustStore () const
 Returns the path of the public key file for SSL use.
const char * statisticsArchiveFile () const
 Returns the name of the filename into which statistics would be archived.
bool statisticsEnabled () const
 Tells whether statistics needs to be archived or not.
const uint32_t statisticsSampleInterval () const
 Returns the sampling interval of the sampling thread.
const uint32_t statsDiskSpaceLimit () const
 Returns the stat-disk-size-limit.
const uint32_t statsFileSizeLimit () const
 Returns the stat-file-space-limit.
 SystemProperties (const PropertiesPtr &propertiesPtr, const char *configFile=NULL)
 Constructor.
 ~SystemProperties ()
 Destructor.

Constructor & Destructor Documentation

gemfire::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.

gemfire::SystemProperties::~SystemProperties (  ) 

Destructor.


Member Function Documentation

const char* gemfire::SystemProperties::authInitFactory (  )  const [inline]

Return the security auth factory.

const char* gemfire::SystemProperties::authInitLibrary (  )  const [inline]

Return the security auth library.

bool gemfire::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.

char* gemfire::SystemProperties::conflateEvents (  )  [inline]

Returns client Queueconflation option.

const uint32_t gemfire::SystemProperties::connectTimeout (  )  const [inline]

Returns the connect timeout used for server and locator handshakes.

const bool gemfire::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 "gemfire_cpp". The actual dump file will have timestamp and process ID in the full name.

const bool gemfire::SystemProperties::debugStackTraceEnabled (  )  const [inline]

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

const char* gemfire::SystemProperties::durableClientId (  )  const [inline]

Returns the durable client ID.

const uint32_t gemfire::SystemProperties::durableTimeout (  )  const [inline]

Returns the durable timeout.

bool gemfire::SystemProperties::getEnableTimeStatistics (  )  const [inline]

Whether time stats are enabled for the statistics.

PropertiesPtr gemfire::SystemProperties::getSecurityProperties (  )  const [inline]

Returns securityPropertiesPtr.

Returns:
PropertiesPtr value.

const int32_t gemfire::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 gemfire::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 gemfire::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 gemfire::SystemProperties::isAppDomainEnabled (  )  const [inline]

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

Default value is "false".

bool gemfire::SystemProperties::isDhOn (  )  [inline]

Check whether Diffie-Hellman based credentials encryption is on.

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

bool gemfire::SystemProperties::isEndpointShufflingDisabled (  )  const [inline]

Checks whether list of endpoint is shuffeled or not.

Returns:
bool value.

bool gemfire::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 gemfire::SystemProperties::isSecurityOn (  )  const [inline]

Checks whether Security is on or off.

Returns:
bool value.

const uint32_t gemfire::SystemProperties::logDiskSpaceLimit (  )  const [inline]

Returns the log-disk-space-limit.

const char* gemfire::SystemProperties::logFilename (  )  const [inline]

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

const uint32_t gemfire::SystemProperties::logFileSizeLimit (  )  const [inline]

Returns the log-file-size-limit.

Log::LogLevel gemfire::SystemProperties::logLevel (  )  const [inline]

Returns the log level at which logging would be done.

void gemfire::SystemProperties::logSettings (  ) 

print all settings to the process log.

const int32_t gemfire::SystemProperties::maxSocketBufferSize (  )  const [inline]

Returns the maximum socket buffer size to use.

const int32_t gemfire::SystemProperties::notifyAckInterval (  )  const [inline]

Returns the periodic notify ack interval.

const int32_t gemfire::SystemProperties::notifyDupCheckLife (  )  const [inline]

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

const int32_t gemfire::SystemProperties::pingInterval (  )  const [inline]

Returns the time between two consecutive ping to servers.

const int32_t gemfire::SystemProperties::redundancyMonitorInterval (  )  const [inline]

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

const char* gemfire::SystemProperties::securityClientDhAlgo (  )  [inline]

Return the security diffie hellman secret key algo.

const char* gemfire::SystemProperties::securityClientKsPath (  )  [inline]

Return the keystore (.pem file ) path.

bool gemfire::SystemProperties::sslEnabled (  )  const [inline]

Whether SSL is enabled for socket connections.

const char* gemfire::SystemProperties::sslKeyStore (  )  const [inline]

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

const char* gemfire::SystemProperties::sslTrustStore (  )  const [inline]

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

const char* gemfire::SystemProperties::statisticsArchiveFile (  )  const [inline]

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

bool gemfire::SystemProperties::statisticsEnabled (  )  const [inline]

Tells whether statistics needs to be archived or not.

const uint32_t gemfire::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 gemfire::SystemProperties::statsDiskSpaceLimit (  )  const [inline]

Returns the stat-disk-size-limit.

const uint32_t gemfire::SystemProperties::statsFileSizeLimit (  )  const [inline]

Returns the stat-file-space-limit.


GemFire C++ Cache API Documentation