ICacheLoader.Load Method

Loads a value. Application writers should implement this method to customize the loading of a value.

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

Syntax

C++

Copy

IGFSerializable Load(
	Region region,
	ICacheableKey key,
	IGFSerializable helper
)

Function Load ( 
	region As Region,
	key As ICacheableKey,
	helper As IGFSerializable
) As IGFSerializable

IGFSerializable^ Load(
	Region^ region, 
	ICacheableKey^ key, 
	IGFSerializable^ helper
)

abstract Load : 
        region : Region * 
        key : ICacheableKey * 
        helper : IGFSerializable -> IGFSerializable

Parameters

region: Type: GemStone.GemFire.Cache.Region
a Region for which this is called.
key: Type: GemStone.GemFire.Cache.ICacheableKey
the key for the cacheable
helper: Type: GemStone.GemFire.Cache.IGFSerializable

Return Value

Type: IGFSerializable
the value supplied for this key, or null if no value can be supplied. If every available loader returns a null value, [!:Region.Get] will return null.

Remarks

This method is called by the caching service when the requested value is not in the cache. Any exception thrown by this method is propagated back to and thrown by the invocation of [!:Region.Get] that triggered this load.

Reference

ICacheLoader Interface

GemStone.GemFire.Cache Namespace

[!:Region.Get]