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 ()
void	SetMemberType (String^ memberType)
	SystemProperties (Properties^ properties, String^ configFile, Boolean useMemberType)
	SystemProperties (Properties^ properties, String^ configFile)
	SystemProperties (Properties^ properties)
Properties
String^	CacheServerGroupName [get]
Int32	CacheServerThreadCount [get]
String^	CacheXmlFile [get]
Boolean	DebugStackTraceEnabled [get]
UInt32	GFBackpressureTime [get]
Boolean	GFBigValueEnabled [get]
UInt32	GFBigValueThreshold [get]
UInt32	GFCpuUsageHighWatermark [get]
UInt32	GFCpuUsageLowWatermark [get]
UInt32	GFHighWatermark [get]
LogLevel	GFLogLevel [get]
UInt32	GFLowWatermark [get]
UInt32	GFTransportAckTimeout [get]
String^	GFTransportConfig [get]
String^	GFTransportProtocol [get]
Int32	HeapLRUDelta [get]
Int32	HeapLRULimit [get]
Boolean	HeapLRULimitEnabled [get]
String^	LicenseFileName [get]
String^	LicenseType [get]
String^	Locators [get]
String^	LogFileName [get]
Int32	LogFileSizeLimit [get]
Int32	MaxSocketBufferSize [get]
String^	McastAddress [get]
Int32	McastPort [get]
Int32	McastResolverTtl [get]
Int32	McastRetransmissionRate [get]
Int32	McastTransmissionRate [get]
Int32	McastTransmissionWindowSize [get]
String^	MemberType [get]
Boolean	MessageQueuingEnabled [get]
Boolean	MulticastEnabled [get]
String^	Name [get]
Int32	NotifyAckInterval [get]
Int32	NotifyDupCheckLife [get]
Int32	PingInterval [get]
Int32	RedundancyMonitorInterval [get]
String^	StatisticsArchiveFile [get]
Boolean	StatisticsEnabled [get]
Int32	StatisticsSampleInterval [get]
Int32	StatsFileSizeLimit [get]
Int32	TransportContextCount [get]
Int32	TransportSessions [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

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

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
	useMemberType	if true, use the member type as specified; if false, always set the member type to Server

---

Member Function Documentation

void GemStone::GemFire::Cache::SystemProperties::LogSettings

(

)

Prints all settings to the process log.

void GemStone::GemFire::Cache::SystemProperties::SetMemberType

(

String^

memberType

)

Sets the member type.

Parameters:

memberType

one of "PEER", "CLIENT", or "SERVER"

---

Property Documentation

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

Returns the cache server-group name.

Returns:

the server-group name

Int32 GemStone::GemFire::Cache::SystemProperties::CacheServerThreadCount [get]

Returns the number of cacheserver threads.

Returns:

the number of threads

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

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

Returns:

the filename

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

True if the stack trace is enabled.

Returns:

true if enabled

UInt32 GemStone::GemFire::Cache::SystemProperties::GFBackpressureTime [get]

Returns the "back pressure" time, in microseconds. For multicast, if a node receives a back pressure message, it will pause this long between message sends.

Returns:

the time

Boolean GemStone::GemFire::Cache::SystemProperties::GFBigValueEnabled [get]

???

UInt32 GemStone::GemFire::Cache::SystemProperties::GFBigValueThreshold [get]

???

UInt32 GemStone::GemFire::Cache::SystemProperties::GFCpuUsageHighWatermark [get]

Returns the CPU usage "high water mark" (maximum CPU percentage used). For multicast, if this value is exceeded, the back pressure message is sent to the sender periodically.

Returns:

the high water mark percentage

See also:

GFBackpressureTime

UInt32 GemStone::GemFire::Cache::SystemProperties::GFCpuUsageLowWatermark [get]

Returns the CPU usage "low water mark" (minimum CPU percentage used). For multicast, if the CPU percentage is below this value, the back pressure message is no longer sent to the sender.

Returns:

the low water mark percentage

See also:

GFBackpressureTime

UInt32 GemStone::GemFire::Cache::SystemProperties::GFHighWatermark [get]

Returns the message queue size "high water mark". For multicast, if this value is exceeded, the back pressure message is sent to the sender periodically.

Returns:

the high water mark

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

Returns the message logging level.

Returns:

the log level

UInt32 GemStone::GemFire::Cache::SystemProperties::GFLowWatermark [get]

Returns the message queue size "low water mark". For multicast, if the message queue size is below this value, the back pressure message is no longer sent to the sender.

Returns:

the low water mark

UInt32 GemStone::GemFire::Cache::SystemProperties::GFTransportAckTimeout [get]

Returns the ack-timeout value, in seconds.

Returns:

the timeout

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

Returns the name of the GemFire transport configuration filename.

Returns:

the transport config filename

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

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 multicast in the product is governed by the property "transport-multicast-enabled".

Returns:

the name of the transport protocol, currently always "TCP"

Int32 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

Int32 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

Boolean 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

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

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

Returns the locator name.

Returns:

name

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

Returns the name of the message log file.

Returns:

the filename

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

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

Returns:

the maximum limit

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

Returns the maximum socket buffer size to use

Returns:

the MaxSocketBufferSize value

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

Returns the multicast address or the default ("224.0.33.11") if not set.

Returns:

Int32 GemStone::GemFire::Cache::SystemProperties::McastPort [get]

Returns the multicast port number or the default (2365) if not set.

Returns:

the port number

Int32 GemStone::GemFire::Cache::SystemProperties::McastResolverTtl [get]

Returns the multicast resolver time-to-live, in seconds.

Returns:

the time-to-live

Int32 GemStone::GemFire::Cache::SystemProperties::McastRetransmissionRate [get]

Returns the multicast re-transmission rate, in bits/second.

Returns:

the rate

Int32 GemStone::GemFire::Cache::SystemProperties::McastTransmissionRate [get]

Returns the multicast transmission rate, in bits/second.

Returns:

the rate

Int32 GemStone::GemFire::Cache::SystemProperties::McastTransmissionWindowSize [get]

Returns the multicast transmission window size, in bytes.

Returns:

the size

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

Returns the name of the cache type, PEER, CLIENT, or SERVER.

Returns:

the cache type name

Boolean GemStone::GemFire::Cache::SystemProperties::MessageQueuingEnabled [get]

True if message queueing is enabled.

Returns:

true if enabled

Boolean GemStone::GemFire::Cache::SystemProperties::MulticastEnabled [get]

True if mulitcast is enabled.

Returns:

true if enabled

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

Returns the system name.

Returns:

the name

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

Returns the periodic notify ack interval

Returns:

the NotifyAckInterval value

Int32 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 GemStone::GemFire::Cache::SystemProperties::PingInterval [get]

Returns the time between two consecutive ping to servers

Returns:

the PingInterval value

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

Returns the time between two consecutive checks for redundancy for HA

Returns:

the RedundancyMonitorInterval value

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

Returns the name of the statistics archive file.

Returns:

the filename

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

True if statistics are enabled (archived).

Returns:

true if enabled

Int32 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 GemStone::GemFire::Cache::SystemProperties::StatsFileSizeLimit [get]

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

Returns:

the maximum limit

Int32 GemStone::GemFire::Cache::SystemProperties::TransportContextCount [get]

Returns the number of LBM transport contexts.

Returns:

the count

Int32 GemStone::GemFire::Cache::SystemProperties::TransportSessions [get]

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 defaults to 10.

Returns:

the limit of transport sessions used

---