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 ()
 Return the security auth factory.
const char * authInitLibrary ()
 Return the security auth library.
const long cacheServerThreadCount ()
 Returns the number of cacheServer Threads.
const bool debugStackTraceEnabled ()
 Returns true if the stack trace is enabled ,false otherwise.
const char * durableClientId ()
 Returns the durable client ID.
const uint32_t durableTimeout ()
 Returns the durable timeout.
PropertiesPtr getSecurityProperties ()
 Returns securityPropertiesPtr.
uint32_t gfTransportAckTimeout ()
 Returns the Time value in seconds for the ACK case of the transport.
const char * gfTransportConfig ()
 Returns the name of the gemfire transport config filename.
const char * gfTransportProtocol ()
 Returns the string name of the transport protocol.
const int32_t heapLRUDelta ()
 Returns the HeapLRUDelta value (a percent value).
const int32_t heapLRULimit ()
 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 ()
 Returns a boolean that specifies if heapLRULimit has been enabled for the process.
bool isSecurityOn ()
 Checks whether Security is on or off.
const char * logFilename ()
 Returns the name of the filename into which logging would be done.
Log::LogLevel logLevel ()
 Returns the log level at which logging would be done.
void logSettings ()
 print all settings to the process log.
const int32_t maxSocketBufferSize ()
 Returns the maximum socket buffer size to use.
const char * memberType ()
 Returns the name of the cache type.
const int32_t notifyAckInterval ()
 Returns the periodic notify ack interval.
const int32_t notifyDupCheckLife ()
 Returns the expiry time of an idle event id map entry for duplicate notification checking.
const int32_t pingInterval ()
 Returns the time between two consecutive ping to servers.
const int32_t redundancyMonitorInterval ()
 Returns the time between two consecutive checks for redundancy for HA.
void setMemberType (const char *memberType)
 A method to set the member type for cache server.
const char * statisticsArchiveFile ()
 Returns the name of the filename into which statistics would be archived.
bool statisticsEnabled ()
 Tells whether statistics needs to be archived or not.
const long statisticsSampleInterval ()
 Returns the sampling interval of the sampling thread.
 SystemProperties (const PropertiesPtr &propertiesPtr, const char *configFile=NULL, bool useMemType=true)
 Constructor.
int transportSessions ()
 Returns the configured limit of transport sessions used.
 ~SystemProperties ()
 Destructor.

Constructor & Destructor Documentation

gemfire::SystemProperties::SystemProperties ( const PropertiesPtr propertiesPtr,
const char *  configFile = NULL,
bool  useMemType = true 
)

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 (  )  [inline]

Return the security auth factory.

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

Return the security auth library.

const long gemfire::SystemProperties::cacheServerThreadCount (  )  [inline]

Returns the number of cacheServer Threads.

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

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

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

Returns the durable client ID.

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

Returns the durable timeout.

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

Returns securityPropertiesPtr.

Returns:
PropertiesPtr value.

uint32_t gemfire::SystemProperties::gfTransportAckTimeout (  )  [inline]

Returns the Time value in seconds for the ACK case of the transport.

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

Returns the name of the gemfire transport config filename.

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

Returns the string name of the transport protocol.

This method always returns the string "TCP". TCP sources are always created by the product. Usage of mcast in the product is governed by the property "mcast-enabled".

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

Checks whether Security is on or off.

Returns:
bool value.

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

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

Log::LogLevel gemfire::SystemProperties::logLevel (  )  [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 (  )  [inline]

Returns the maximum socket buffer size to use.

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

Returns the name of the cache type.

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

Returns the periodic notify ack interval.

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

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

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

Returns the time between two consecutive ping to servers.

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

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

void gemfire::SystemProperties::setMemberType ( const char *  memberType  ) 

A method to set the member type for cache server.

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

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

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

Tells whether statistics needs to be archived or not.

const long gemfire::SystemProperties::statisticsSampleInterval (  )  [inline]

Returns the sampling interval of the sampling thread.

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

int gemfire::SystemProperties::transportSessions (  )  [inline]

Returns the configured limit of transport sessions used.

This governs the number of logical communication groups and contributes to the limit on the number of connected sockets between peers. The formula for the socket connection limit is ( sessions * peers * k ) where k is 4 for members that are type PEER, k is 4 + server-threads (default 4) for members of type SERVER, and k is 2 for members of type CLIENT. Note members of type CLIENT need only 2 sessions, and effectively have only 1 PEER. Sessions default to 10.


GemFire C++ Cache API Documentation