Class CacheBuilder<TKey, TValue>
Provides custom construction of a ScaleOut Cache<TKey, TValue> instance.
Inheritance
Inherited Members
Namespace: Scaleout.Client
Assembly: Scaleout.Client.dll
Syntax
public class CacheBuilder<TKey, TValue>Type Parameters
| Name | Description |
|---|---|
| TKey | |
| TValue |
Constructors
| Name | Description |
|---|---|
| CacheBuilder(String, GridConnection) | Initializes a new instance of the CacheBuilder class with default policies. |
| CacheBuilder(String, GridConnection, IConfiguration) | Initializes a new instance of the CacheBuilder class, with initial settings provided by the supplied IConfiguration section. Pass a LegacyXmlConfiguration instance to signal the builder to use a legacy web.config/app.config file. |
Properties
| Name | Description |
|---|---|
| BackingStoreEventInterval | Gets the default interval between backing store events (refresh-ahead, write-behind). |
| BackingStoreMode | Gets the default policy for the objects' backing store event behavior. Default is None. |
| CoherencyInterval | Gets the coherency interval for the cache. |
| Deserializer | Gets the method used to deserialize objects in the cache. |
| InvocationGridName | Gets the name of the invocation grid that can be used to handle Invoke and PostEventAsync(TKey, String, Byte[], Nullable<TimeSpan>) operations. |
| KeyEncoder | Gets the custom KeyEncoder used to encode keys in the cache. |
| LockRetryInterval | Gets the amount of time between polling attempts to acquire an exclusive lock on a cached object. |
| LoggerFactory | Gets the ILoggerFactory to be used by the cache for logging |
| Name | Gets the name of the cache being built. |
| NetworkCacheSize | Gets the size (in bytes) of the in-process network cache that is used to return deep copies of objects. A value of zero indicates that the network cache is disabled. |
| PreemptionPriority | Gets the PreemptionPriority for objects in the cache. Default is Normal. |
| Serializer | Gets the method used to serialize objects in the cache. |
| Timeout | Gets the lifetime for the cache's objects in the ScaleOut service. A value of System.TimeSpan.Zero indicates an infinite timeout. |
| TimeoutType | Gets the timeout policy for the cache's objects in the ScaleOut service. |
| UseServiceEventForReadThrough | Gets whether the cache will raise a read-through event in n remote event-handling application when there's a cache miss. |
| WriteThroughCallback | Gets a callback used to persist cache updates to a backing store. |
Methods
| Name | Description |
|---|---|
| Build() | Builds a Cache<TKey, TValue> as specified by this CacheBuilder<TKey, TValue> instance. |
| RaiseServiceEventForReadThrough() | Configures the cache to raise a read-through event in a remote event-handling application to populate the cache with an object in the event of a cache miss. |
| SetBackingStoreEvent(TimeSpan, BackingStoreMode) | Sets the cache's default type of backing store event (refresh-ahead, write-behind) and the interval between events, with a minimum granularity of one second. Overrides the config file's setting for this cache. |
| SetClientCache(String, Int32) | Sets in-process client cache policies for this cache. Overrides the config file's clientCacheEviction and clientCacheCapacity settings for this cache. |
| SetCoherencyInterval(TimeSpan) | Sets the coherency interval for the client cache. |
| SetInvocationGridName(String) | Sets the name of the invocation grid to be used for handling Invoke and PostEventAsync(TKey, String, Byte[], Nullable<TimeSpan>) operations. |
| SetKeyEncoder(KeyEncoder<TKey>) | Sets the class used by the cache for encoding keys. |
| SetLockRetryInterval(TimeSpan) | Sets the amount of time between polling attempts to acquire an exclusive lock on a cached object. Overrides the config file's exclusiveLockRetryIntervalMS setting for this cache. |
| SetLoggerFactory(ILoggerFactory) | Sets an ILoggerFactory to be used by the cache instance for logging. Overrides the ILoggerFactory set via SetLoggerFactory(ILoggerFactory). |
| SetNetworkCacheSize(Int64) | Sets the size (in bytes) of the in-process network cache that is used to return deep copies of objects, or zero to disable the network cache. Overrides the config file's networkCacheSizeBytes setting for this cache. |
| SetObjectTimeout(TimeSpan, TimeoutType) | Sets the lifetime for the cache's objects in the ScaleOut service, with a minimum granularity of one second. Use System.TimeSpan.Zero for an infinite timeout. Overrides the config file's timeout setting for this cache. |
| SetPreemptionPriority(PreemptionPriority) | Sets the preemption priority for objects in the cache, which specifies whether the least recently accessed objects may be evicted when the ScaleOut service runs low on memory. |
| SetSerialization(Action<TValue, Stream>, Func<Stream, TValue>) | Sets the callbacks used to perform serialization/deserialization of objects in the cache. |
| SetWriteThroughCallback(Action<TKey, TValue>) | Sets a callback used to persist cache updates to a backing store. |