IGemFireCache Interface

Note: This API is now obsolete.

GemFireCache represents the singleton cache that must be created in order to connect to Gemfire server.

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 interface IGemFireCache : IRegionService

<ObsoleteAttribute("Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")>
Public Interface IGemFireCache
	Inherits IRegionService

[ObsoleteAttribute(L"Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")]
public interface class IGemFireCache : IRegionService

[<ObsoleteAttribute("Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")>]
type IGemFireCache =  
    interface
        interface IRegionService
    end

The IGemFireCache 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. (Inherited from IRegionService.)
	Name	Returns the name of this cache.

Top

Methods

	Name	Description
	Close	Terminates this object cache and releases all the local resources. If RegionService is created from [!:Cache.CreateAuthenticatedView], then it clears user related security data. (Inherited from IRegionService.)
	GetQueryService	Get a query service object to be able to query the cache. (Inherited from IRegionService.)
	GetRegion	Returns an existing region given the full path from root, or null if no such region exists. (Inherited from IRegionService.)
	InitializeDeclarativeCache	Initializes the cache from an XML file.
	RootRegions	Returns an array of root regions in the cache. This set is a snapshot and is not backed by the cache. (Inherited from IRegionService.)

Top

Remarks

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

When a cache is created a DistributedSystem must be specified.

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