This factory class is the entry point and used to create the root class for this library. More...

Inheritance diagram for CacheFactory:

Public Member Functions
	CacheFactory (IDictionary< string, string > config)
	Constructor using configuration with IDictionary<TKey, TValue> More...

	CacheFactory ()
	Default constructor uses default config More...

ICache	Create (string cacheName)
	Creation method intended to be called as final step of builder pattern. More...

ICacheFactory	Set (string key, string value)
	Property key/value setter method for singular property configuration. More...

ICacheFactory	SetPdxIgnoreUnreadFields (bool ignore)
	Setter for PdxIgnoreUnreadFields More...

ICacheFactory	SetPdxReadSerialized (bool pdxReadSerialized)
	Setter for PdxReadSerialized More...

ICacheFactory	SetAuthInitialize (IAuthInitialize authInitialize)
	Setter for AuthInitializer More...

ICacheFactory	AddLocator (System.Net.DnsEndPoint ep)
	Builder pattern setter method for adding locators for client usage More...

ICacheFactory	AddServer (System.Net.DnsEndPoint ep)
	Builder pattern setter method for adding servers for client usage More...

ICacheFactory	SetFreeConnectionTimeout (TimeSpan connectionTimeout)
	Builder pattern setter method for configuring connection timeout for client connecting to server. More...

ICacheFactory	SetLoadConditioningInterval (TimeSpan loadConditioningInterval)
	Builder pattern setter method for configuring load conditioning interval More...

ICacheFactory	SetSocketBufferSize (int bufferSize)
	Builder pattern setter method for configuring size of client to server connection buffers More...

ICacheFactory	SetReadTimeout (TimeSpan timeout)
	Builder pattern setter method for configuring timeout for responses from server More...

ICacheFactory	SetMinConnections (int minConnections)
	Builder pattern setter method for configuring minimum client to server connections More...

ICacheFactory	SetMaxConnections (int maxConnections)
	Builder pattern setter method for configuring maximum client to server connections More...

ICacheFactory	SetIdleTimeout (TimeSpan idleTimeout)
	Builder pattern setter method for configuring timeout for idle client to server connections More...

ICacheFactory	SetRetryAttempts (int retryAttempts)
	Builder pattern setter method for configuring number of retries for client to server messages More...

ICacheFactory	SetPingInterval (TimeSpan pingInterval)
	Builder pattern setter method for configuring interval for client to ping server More...

ICacheFactory	SetUpdateLocatorListInterval (TimeSpan updateLocatorListInterval)
	Builder pattern setter method for configuring interval for client requesting locator list updates More...

ICacheFactory	SetStatisticInterval (TimeSpan statisticInterval)
	Builder pattern setter method for configuring interval used for statistic collection More...

ICacheFactory	SetServerGroup (string group)
	Builder pattern setter method for configuring name of server group More...

ICacheFactory	AddLocator (string host, int port)
	Builder pattern setter method for adding locators for client usage More...

ICacheFactory	AddServer (string host, int port)
	Builder pattern setter method for adding servers for client usage More...

ICacheFactory	SetSniProxy (string hostname, int port)
	Builder pattern setter method for configuring SNI proxy More...

ICacheFactory	SetSubscriptionEnabled (bool enabled)
	Builder pattern setter method for enabling subscription More...

ICacheFactory	SetPRSingleHopEnabled (bool enabled)
	Builder pattern setter method for enabling single hop More...

ICacheFactory	SetSubscriptionRedundancy (int redundancy)
	Builder pattern setter method for configuring subscription redundancy level More...

ICacheFactory	SetSubscriptionMessageTrackingTimeout (TimeSpan messageTrackingTimeout)
	Builder pattern setter method for configuring tracking timeout of subscrition messages More...

ICacheFactory	SetSubscriptionAckInterval (TimeSpan ackInterval)
	Builder pattern setter method for configuring interval between subscription acknowledgements More...

ICacheFactory	Reset ()
	Reset method for factory More...

ICacheFactory	SetConflationStatus (ConflationStatus conflation)
	Builder pattern setter method for configuring conflation status More...

Static Public Attributes
static string	ProductDescription => ".NET Client for GemFire"
	Getter for string of product description More...

static string	Version => ""
	Getter for string of product version More...

Properties
bool	PdxIgnoreUnreadFields `[get, set]`
	Getter for PdxIgnoreUnreadFields More...

bool	PdxReadSerialized `[get, set]`
	Getter for PdxReadSerialized More...

IAuthInitialize	AuthInitialize `[get, set]`
	Getter for AuthInitializer More...

Detailed Description

This factory class is the entry point and used to create the root class for this library.

Constructor & Destructor Documentation

◆ CacheFactory() [1/2]

CacheFactory.CacheFactory ( IDictionary< string, string > config )

inline

Constructor using configuration with IDictionary<TKey, TValue>

Parameters

config

Exceptions

ArgumentOutOfRangeException

◆ CacheFactory() [2/2]

CacheFactory.CacheFactory ( )

inline

Default constructor uses default config

Member Function Documentation

◆ AddLocator() [1/2]

ICacheFactory CacheFactory.AddLocator	(	string	host,
		int	port
	)

inline

Builder pattern setter method for adding locators for client usage

Parameters

host	locator hostname
port	locator port

Returns: ICacheFactory

Exceptions

GemFireIllegalArgumentException

Implements ICacheFactory.

◆ AddLocator() [2/2]

ICacheFactory CacheFactory.AddLocator ( System.Net.DnsEndPoint ep )

inline

Builder pattern setter method for adding locators for client usage

Parameters

ep	locator endpoint

Returns: ICacheFactory

Exceptions

GemFireIllegalArgumentException

◆ AddServer() [1/2]

ICacheFactory CacheFactory.AddServer	(	string	host,
		int	port
	)

inline

Builder pattern setter method for adding servers for client usage

Parameters

host	server hostname
port	server port

Returns: ICacheFactory

Exceptions

GemFireIllegalArgumentException

Implements ICacheFactory.

◆ AddServer() [2/2]

ICacheFactory CacheFactory.AddServer ( System.Net.DnsEndPoint ep )

inline

Builder pattern setter method for adding servers for client usage

Parameters

ep	server endpoint

Returns: ICacheFactory

Exceptions

GemFireIllegalArgumentException

◆ Create()

ICache CacheFactory.Create ( string cacheName )

inline

Creation method intended to be called as final step of builder pattern.

Parameters

cacheName Desired name of the Cache being created.

Returns

Exceptions

GemFireIllegalStateException

Implements ICacheFactory.

◆ Reset()

ICacheFactory CacheFactory.Reset ( )

inline

Reset method for factory

Returns: ICacheFactory

Implements ICacheFactory.

◆ Set()

ICacheFactory CacheFactory.Set	(	string	key,
		string	value
	)

inline

Property key/value setter method for singular property configuration.

Parameters

key	Property key
value	Property value

Returns: ICacheFactory

Exceptions

ArgumentOutOfRangeException Property is unsupported

Implements ICacheFactory.

◆ SetAuthInitialize()

ICacheFactory CacheFactory.SetAuthInitialize ( IAuthInitialize authInitialize )

inline

Setter for AuthInitializer

Parameters

authInitialize

Returns: ICacheFactory

Implements ICacheFactory.

◆ SetConflationStatus()

ICacheFactory CacheFactory.SetConflationStatus ( ConflationStatus conflation )

inline

Builder pattern setter method for configuring conflation status

Parameters

conflation

Returns: ICacheFactory

◆ SetFreeConnectionTimeout()

ICacheFactory CacheFactory.SetFreeConnectionTimeout ( TimeSpan connectionTimeout )

inline

Builder pattern setter method for configuring connection timeout for client connecting to server.

Parameters

connectionTimeout

Returns: ICacheFactory

Implements ICacheFactory.

◆ SetIdleTimeout()

ICacheFactory CacheFactory.SetIdleTimeout ( TimeSpan idleTimeout )

inline

Builder pattern setter method for configuring timeout for idle client to server connections

Parameters

idleTimeout

Returns: ICacheFactory

Implements ICacheFactory.

◆ SetLoadConditioningInterval()

ICacheFactory CacheFactory.SetLoadConditioningInterval ( TimeSpan loadConditioningInterval )

inline

Builder pattern setter method for configuring load conditioning interval

Parameters

loadConditioningInterval

Returns: ICacheFactory

Implements ICacheFactory.

◆ SetMaxConnections()

ICacheFactory CacheFactory.SetMaxConnections ( int maxConnections )

inline

Builder pattern setter method for configuring maximum client to server connections

Parameters

maxConnections

Returns: ICacheFactory

Exceptions

GemFireIllegalArgumentException

Implements ICacheFactory.

◆ SetMinConnections()

ICacheFactory CacheFactory.SetMinConnections ( int minConnections )

inline

Builder pattern setter method for configuring minimum client to server connections

Parameters

minConnections

Returns: ICacheFactory

Exceptions

GemFireIllegalArgumentException

Implements ICacheFactory.

◆ SetPdxIgnoreUnreadFields()

ICacheFactory CacheFactory.SetPdxIgnoreUnreadFields ( bool ignore )

inline

Setter for PdxIgnoreUnreadFields

Parameters

ignore

Returns: ICacheFactory

Implements ICacheFactory.

◆ SetPdxReadSerialized()

ICacheFactory CacheFactory.SetPdxReadSerialized ( bool pdxReadSerialized )

inline

Setter for PdxReadSerialized

Parameters

pdxReadSerialized

Returns: ICacheFactory

Implements ICacheFactory.

◆ SetPingInterval()

ICacheFactory CacheFactory.SetPingInterval ( TimeSpan pingInterval )

inline

Builder pattern setter method for configuring interval for client to ping server

Parameters

pingInterval

Returns: ICacheFactory

Implements ICacheFactory.

◆ SetPRSingleHopEnabled()

ICacheFactory CacheFactory.SetPRSingleHopEnabled ( bool enabled )

inline

Builder pattern setter method for enabling single hop

Parameters

enabled

Returns: ICacheFactory

Implements ICacheFactory.

◆ SetReadTimeout()

ICacheFactory CacheFactory.SetReadTimeout ( TimeSpan timeout )

inline

Builder pattern setter method for configuring timeout for responses from server

Parameters

timeout

Returns: ICacheFactory

Implements ICacheFactory.

◆ SetRetryAttempts()

ICacheFactory CacheFactory.SetRetryAttempts ( int retryAttempts )

inline

Builder pattern setter method for configuring number of retries for client to server messages

Parameters

retryAttempts

Returns: ICacheFactory

Exceptions

GemFireIllegalArgumentException

Implements ICacheFactory.

◆ SetServerGroup()

ICacheFactory CacheFactory.SetServerGroup ( string group )

inline

Builder pattern setter method for configuring name of server group

Parameters

group

Returns: ICacheFactory

Implements ICacheFactory.

◆ SetSniProxy()

ICacheFactory CacheFactory.SetSniProxy	(	string	hostname,
		int	port
	)

inline

Builder pattern setter method for configuring SNI proxy

Parameters

hostname	SNI proxy hostname
port	SNI proxy port

Returns: ICacheFactory

Implements ICacheFactory.

◆ SetSocketBufferSize()

ICacheFactory CacheFactory.SetSocketBufferSize ( int bufferSize )

inline

Builder pattern setter method for configuring size of client to server connection buffers

Parameters

bufferSize

Returns: ICacheFactory

Exceptions

GemFireIllegalArgumentException

Implements ICacheFactory.

◆ SetStatisticInterval()

ICacheFactory CacheFactory.SetStatisticInterval ( TimeSpan statisticInterval )

inline

Builder pattern setter method for configuring interval used for statistic collection

Parameters

statisticInterval

Returns: ICacheFactory

Implements ICacheFactory.

◆ SetSubscriptionAckInterval()

ICacheFactory CacheFactory.SetSubscriptionAckInterval ( TimeSpan ackInterval )

inline

Builder pattern setter method for configuring interval between subscription acknowledgements

Parameters

ackInterval

Returns: ICacheFactory

Implements ICacheFactory.

◆ SetSubscriptionEnabled()

ICacheFactory CacheFactory.SetSubscriptionEnabled ( bool enabled )

inline

Builder pattern setter method for enabling subscription

Parameters

enabled

Returns: ICacheFactory

Implements ICacheFactory.

◆ SetSubscriptionMessageTrackingTimeout()

ICacheFactory CacheFactory.SetSubscriptionMessageTrackingTimeout ( TimeSpan messageTrackingTimeout )

inline

Builder pattern setter method for configuring tracking timeout of subscrition messages

Parameters

messageTrackingTimeout

Returns: ICacheFactory

Implements ICacheFactory.

◆ SetSubscriptionRedundancy()

ICacheFactory CacheFactory.SetSubscriptionRedundancy ( int redundancy )

inline

Builder pattern setter method for configuring subscription redundancy level

Parameters

redundancy

Returns: ICacheFactory

Exceptions

GemFireIllegalArgumentException

Implements ICacheFactory.

◆ SetUpdateLocatorListInterval()

ICacheFactory CacheFactory.SetUpdateLocatorListInterval ( TimeSpan updateLocatorListInterval )

inline

Builder pattern setter method for configuring interval for client requesting locator list updates

Parameters

updateLocatorListInterval

Returns: ICacheFactory

Implements ICacheFactory.

Member Data Documentation

◆ ProductDescription

string CacheFactory.ProductDescription => ".NET Client for GemFire"

static

Getter for string of product description

◆ Version

string CacheFactory.Version => ""

static

Getter for string of product version

Property Documentation

◆ AuthInitialize

IAuthInitialize CacheFactory.AuthInitialize

getset

Getter for AuthInitializer

◆ PdxIgnoreUnreadFields

bool CacheFactory.PdxIgnoreUnreadFields

getset

Getter for PdxIgnoreUnreadFields

◆ PdxReadSerialized

bool CacheFactory.PdxReadSerialized

getset

Getter for PdxReadSerialized

The documentation for this class was generated from the following file:

gemfire.client/Implementation/CacheFactory.cs

VMware Tanzu GemFire .NET Client API Reference

Public Member Functions

Static Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ CacheFactory() [1/2]

◆ CacheFactory() [2/2]

Member Function Documentation

◆ AddLocator() [1/2]

◆ AddLocator() [2/2]

◆ AddServer() [1/2]

◆ AddServer() [2/2]

◆ Create()

◆ Reset()

◆ Set()

◆ SetAuthInitialize()

◆ SetConflationStatus()

◆ SetFreeConnectionTimeout()

◆ SetIdleTimeout()

◆ SetLoadConditioningInterval()

◆ SetMaxConnections()

◆ SetMinConnections()

◆ SetPdxIgnoreUnreadFields()

◆ SetPdxReadSerialized()

◆ SetPingInterval()

◆ SetPRSingleHopEnabled()

◆ SetReadTimeout()

◆ SetRetryAttempts()

◆ SetServerGroup()

◆ SetSniProxy()

◆ SetSocketBufferSize()

◆ SetStatisticInterval()

◆ SetSubscriptionAckInterval()

◆ SetSubscriptionEnabled()

◆ SetSubscriptionMessageTrackingTimeout()

◆ SetSubscriptionRedundancy()

◆ SetUpdateLocatorListInterval()

Member Data Documentation

◆ ProductDescription

◆ Version

Property Documentation

◆ AuthInitialize

◆ PdxIgnoreUnreadFields

◆ PdxReadSerialized