Class MicrosoftMemoryCachingBuilderExtensions

Extensions for the configuration builder specific to based caching.

Inheritance

Object

MicrosoftMemoryCachingBuilderExtensions

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace:CacheManager.Core

Assembly:CacheManager.Microsoft.Extensions.Caching.Memory.dll

Syntax

public static class MicrosoftMemoryCachingBuilderExtensions

Methods

| Improve this Doc View Source

WithMicrosoftMemoryCacheHandle(ConfigurationBuilderCachePart, MemoryCacheOptions)

Adds a cache handle using . The name of the cache instance will be 'default'.

Declaration

[CLSCompliant(false)]
public static ConfigurationBuilderCacheHandlePart WithMicrosoftMemoryCacheHandle(this ConfigurationBuilderCachePart part, MemoryCacheOptions options)

Parameters

Type	Name	Description
ConfigurationBuilderCachePart	part	The builder part.
MemoryCacheOptions	options	The which should be used to initiate or reset this cache.

Returns

Type	Description
ConfigurationBuilderCacheHandlePart	The builder part.

| Improve this Doc View Source

WithMicrosoftMemoryCacheHandle(ConfigurationBuilderCachePart, Boolean)

Adds a cache handle using .

Declaration

public static ConfigurationBuilderCacheHandlePart WithMicrosoftMemoryCacheHandle(this ConfigurationBuilderCachePart part, bool isBackplaneSource = false)

Parameters

Type	Name	Description
ConfigurationBuilderCachePart	part	The builder part.
Boolean	isBackplaneSource	Set this to true if this cache handle should be the source of the backplane. This setting will be ignored if no backplane is configured.

Returns

Type	Description
ConfigurationBuilderCacheHandlePart	The builder part.

| Improve this Doc View Source

WithMicrosoftMemoryCacheHandle(ConfigurationBuilderCachePart, String, MemoryCacheOptions)

Adds a cache handle using .

Declaration

[CLSCompliant(false)]
public static ConfigurationBuilderCacheHandlePart WithMicrosoftMemoryCacheHandle(this ConfigurationBuilderCachePart part, string instanceName, MemoryCacheOptions options)

Parameters

Type	Name	Description
ConfigurationBuilderCachePart	part	The builder part.
String	instanceName	The name to be used for the cache handle instance.
MemoryCacheOptions	options	The which should be used to initiate or reset this cache.

Returns

Type	Description
ConfigurationBuilderCacheHandlePart	The builder part.

Exceptions

Type	Condition
ArgumentNullException	Thrown if instanceName is null.

| Improve this Doc View Source

WithMicrosoftMemoryCacheHandle(ConfigurationBuilderCachePart, String, Boolean)

Adds a cache handle using .

Declaration

public static ConfigurationBuilderCacheHandlePart WithMicrosoftMemoryCacheHandle(this ConfigurationBuilderCachePart part, string instanceName, bool isBackplaneSource = false)

Parameters

Type	Name	Description
ConfigurationBuilderCachePart	part	The builder part.
String	instanceName	The name to be used for the cache handle instance.
Boolean	isBackplaneSource	Set this to true if this cache handle should be the source of the backplane. This setting will be ignored if no backplane is configured.

Returns

Type	Description
ConfigurationBuilderCacheHandlePart	The builder part.

Exceptions

Type	Condition
ArgumentNullException	If part is null.
ArgumentNullException	Thrown if instanceName is null.

| Improve this Doc View Source

WithMicrosoftMemoryCacheHandle(ConfigurationBuilderCachePart, String, Boolean, MemoryCacheOptions)

Adds a cache handle using .

Declaration

[CLSCompliant(false)]
public static ConfigurationBuilderCacheHandlePart WithMicrosoftMemoryCacheHandle(this ConfigurationBuilderCachePart part, string instanceName, bool isBackplaneSource, MemoryCacheOptions options)

Parameters

Type	Name	Description
ConfigurationBuilderCachePart	part	The builder part.
String	instanceName	The name to be used for the cache handle instance.
Boolean	isBackplaneSource	Set this to true if this cache handle should be the source of the backplane. This setting will be ignored if no backplane is configured.
MemoryCacheOptions	options	The which should be used to initiate or reset this cache. If `Null`, default options will be used.

Returns

Type	Description
ConfigurationBuilderCacheHandlePart	The builder part.

Exceptions

Type	Condition
ArgumentNullException	If part is null.
ArgumentNullException	Thrown if instanceName is null.