Provides a client cache. More...

Inheritance diagram for ICache:

Public Member Functions
void	ReadyForEvents ()
	Send the client-ready message to the server for a durable client. More...

IQueryService	GetQueryService ()
	Get a query service object to be able to query the cache. More...

IRegionFactory	CreateRegionFactory (RegionShortcut regionShortcut)
	Returns the instance of IRegionFactory to create the region More...

IJsonDocumentFactory	GetJsonDocumentFactory (StorageFormat format)
	Returns the instance of IJsonDocumentFactory used to Json document objects. More...

ICacheFunctionService	GetCacheFunctionService ()
	Returns the instance of ICacheFunctionService used for Function execution on Server(s). More...

void	Close ()
	Terminates this object cache and releases all the local resources. More...

void	Close (bool keepAlive)
	Terminates this object cache and releases all the local resources. More...

IRegion< TKey, TValue >	GetRegion< TKey, TValue > (string name)
	Returns an existing region given the full path from root, or null if no such region exists. More...

IPdxInstanceFactory	CreatePdxInstanceFactory (string className)
	Returns a factory that can create a PdxInstance. More...

ICqAttributesFactory< TKey, TResult >	CreateCqAttributesFactory< TKey, TResult > ()
	Returns the instance of ICqAttributesFactory<TKey, TResult> to create the CqAttributesFactory More...

IReflectionBasedAutoSerializer	CreateReflectionBasedAutoSerializer (string classPattern)
	Returns the instance of IReflectionBasedAutoSerializer. More...

Public Member Functions inherited from ITransactionManager
void	Begin ()
	Creates a new transaction and associates it with the current thread. More...

void	Commit ()
	Commit the transaction associated with the current thread. If the commit operation fails due to a conflict it will destroy the transaction state and throw a `GemFireInvalidOperationException`. If the commit operation succeeds,it returns after the transaction state has been merged with committed state. When this method completes, the thread is no longer associated with a transaction. More...

void	Rollback ()
	Roll back the transaction associated with the current thread. When this method completes, the thread is no longer associated with a transaction and the transaction context is destroyed. More...

Properties
ITypeRegistry	TypeRegistry `[get]`
	Returns the instance of ITypeRegistry used to register custom serializables. More...

bool	IsClosed `[get]`
	True if this cache has been closed. More...

string	Name `[get]`
	Returns the name of this cache. More...

ISystemProperties	SystemProperties `[get]`
	Returns the system properties of this cache. More...

bool	PdxIgnoreUnreadFields `[get]`

Properties inherited from ITransactionManager
ITransactionId	TransactionId `[get]`
	Returns the transaction identifier for the current thread More...

Detailed Description

Provides a client cache.

Caches are obtained from Create methods on the ICacheFactory.Create class.

When a cache will no longer be used, call ICache.Close(). Once it ICache.IsClosed any attempt to use it will cause a CacheClosedException to be thrown.

Member Function Documentation

◆ Close() [1/2]

void ICache.Close ( )

Terminates this object cache and releases all the local resources.

After this cache is closed, any further method call on this cache or any region object will throw CacheClosedException, unless otherwise noted.

◆ Close() [2/2]

void ICache.Close ( bool keepAlive )

Terminates this object cache and releases all the local resources.

After this cache is closed, any further method call on this cache or any region object will throw CacheClosedException, unless otherwise noted.

Parameters

keepAlive When true, and the client is subscribed to events with a DurableClientId, this sends a message to the server to queue subscription events until a client with the same DurableClientId reconnects.

◆ CreateCqAttributesFactory< TKey, TResult >()

ICqAttributesFactory<TKey, TResult> ICache.CreateCqAttributesFactory< TKey, TResult > ( )

Returns the instance of ICqAttributesFactory<TKey, TResult> to create the CqAttributesFactory

◆ CreatePdxInstanceFactory()

IPdxInstanceFactory ICache.CreatePdxInstanceFactory ( string className )

Returns a factory that can create a PdxInstance.

Parameters

className the fully qualified class name that the PdxInstance

will become when it is fully deserialized.

Returns: the factory

◆ CreateReflectionBasedAutoSerializer()

IReflectionBasedAutoSerializer ICache.CreateReflectionBasedAutoSerializer ( string classPattern )

Returns the instance of IReflectionBasedAutoSerializer.

Full namespace/class pattern of domain object to be auto-serialized

◆ CreateRegionFactory()

IRegionFactory ICache.CreateRegionFactory ( RegionShortcut regionShortcut )

Returns the instance of IRegionFactory to create the region

Pass the RegionShortcut - only supporting PROXY currently.

Parameters

regionShortcut the regionShortcut to set the default region type

Returns: Instance of IRegionFactory

◆ GetCacheFunctionService()

ICacheFunctionService ICache.GetCacheFunctionService ( )

Returns the instance of ICacheFunctionService used for Function execution on Server(s).

◆ GetJsonDocumentFactory()

IJsonDocumentFactory ICache.GetJsonDocumentFactory ( StorageFormat format )

Returns the instance of IJsonDocumentFactory used to Json document objects.

◆ GetQueryService()

IQueryService ICache.GetQueryService ( )

Get a query service object to be able to query the cache.

◆ GetRegion< TKey, TValue >()

IRegion<TKey, TValue> ICache.GetRegion< TKey, TValue > ( string name )

Returns an existing region given the full path from root, or null if no such region exists.

Parameters

name	the name of the region

Returns: the region

◆ ReadyForEvents()

void ICache.ReadyForEvents ( )

Send the client-ready message to the server for a durable client.

This method should only be called for durable clients.

Exceptions

GemFireIllegalStateException if called for non-durable client.

Property Documentation

◆ IsClosed

bool ICache.IsClosed

get

True if this cache has been closed.

After a new cache object is created, this method returns false. After ICache.Close() is called on this cache object, this method returns true.

Returns: true if this cache is closed, otherwise false

◆ Name

string ICache.Name

get

Returns the name of this cache.

This method does not throw CacheClosedException if the cache is closed.

Returns: the string name of this cache

◆ PdxIgnoreUnreadFields

bool ICache.PdxIgnoreUnreadFields

get

summary> Returns whether PdxInstance is preferred for PDX types instead of .NET object. /summary>

◆ SystemProperties

ISystemProperties ICache.SystemProperties

get

Returns the system properties of this cache.

This method does not throw CacheClosedException if the cache is closed.

Returns: the system properties of this cache

summary> Returns whether Cache saves unread fields for Pdx types. /summary>

◆ TypeRegistry

ITypeRegistry ICache.TypeRegistry

get

Returns the instance of ITypeRegistry used to register custom serializables.

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

gemfire.client/Interfaces/ICache.cs

VMware Tanzu GemFire .NET Client API Reference

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Close() [1/2]

◆ Close() [2/2]

◆ CreateCqAttributesFactory< TKey, TResult >()

◆ CreatePdxInstanceFactory()

◆ CreateReflectionBasedAutoSerializer()

◆ CreateRegionFactory()

◆ GetCacheFunctionService()

◆ GetJsonDocumentFactory()

◆ GetQueryService()

◆ GetRegion< TKey, TValue >()

◆ ReadyForEvents()

Property Documentation

◆ IsClosed

◆ Name

◆ PdxIgnoreUnreadFields

◆ SystemProperties

◆ TypeRegistry