Cache Class

Cache Class

Note: This API is now obsolete.

Provides a distributed cache.

Inheritance Hierarchy

SystemObject
[T:GemStone.GemFire.Cache.Internal.SBWrap<gemfire::Cache>]
GemStone.GemFire.CacheCache

Namespace: GemStone.GemFire.Cache
Assembly: Gemstone.Gemfire.Cache (in Gemstone.Gemfire.Cache.dll) Version: 9.0.6.18

Syntax

C++

Copy

[ObsoleteAttribute("Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")]
public sealed class Cache : [T:GemStone.GemFire.Cache.Internal.SBWrap<gemfire::Cache>], 
	IGemFireCache

<ObsoleteAttribute("Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")>
Public NotInheritable Class Cache
	Inherits [T:GemStone.GemFire.Cache.Internal.SBWrap<gemfire::Cache>]
	Implements IGemFireCache

[ObsoleteAttribute(L"Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")]
public ref class Cache sealed : public [T:GemStone.GemFire.Cache.Internal.SBWrap<gemfire::Cache>], 
	IGemFireCache

[<SealedAttribute>]
[<ObsoleteAttribute("Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")>]
type Cache =  
    class
        inherit [T:GemStone.GemFire.Cache.Internal.SBWrap<gemfire::Cache>]
        interface IGemFireCache
    end

The Cache type exposes the following members.

Properties

	Name	Description
	DistributedSystem	Returns the distributed system used to [!:CacheFactory.Create] this cache.
	IsClosed	True if this cache has been closed.
	Name	Returns the name of this cache.

Top

Methods

	Name	Description
	Close	Terminates this object cache and releases all the local resources.
	Close(Boolean)	Terminates this object cache and releases all the local resources.
	CreateAuthenticatedView(Properties)	Returns the instance of IRegionService to do the operation on Cache with different Credential.
	CreateAuthenticatedView(Properties, String)	Returns the instance of IRegionService to do the operation on Cache with different Credential.
	CreateRegion
	CreateRegionFactory	Returns the instance of RegionFactory to create the region
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetQueryService	Get a query service object to be able to query the cache. Supported only when cache is created from Pool(pool is in multiuserSecure mode)
	GetQueryService(String)	Get a query service object to be able to query the cache. Use only when Cache has more than one Pool.
	GetRegion	Returns an existing region given the full path from root, or null if no such region exists.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeDeclarativeCache	Initializes the cache from an XML file.
	ReadyForEvents	Send the client-ready message to the server for a durable client.
	RootRegions	Returns an array of root regions in the cache. This set is a snapshot and is not backed by the cache.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Caches are obtained from Create methods on the [!:CacheFactory.Create] class.

When a cache will no longer be used, call [!:Cache.Close]. Once it [!:Cache.IsClosed] any attempt to use it will cause a CacheClosedException to be thrown.

A cache can have multiple root regions, each with a different name.

Reference

GemStone.GemFire.Cache Namespace