Class CacheHandleConfiguration

Defines all settings the cache handle should respect.

Inheritance

Object

CacheHandleConfiguration

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace:CacheManager.Core

Assembly:CacheManager.Core.dll

Syntax

public sealed class CacheHandleConfiguration

Constructors

| Improve this Doc View Source

CacheHandleConfiguration()

Initializes a new instance of the CacheHandleConfiguration class.

Declaration

public CacheHandleConfiguration()

| Improve this Doc View Source

CacheHandleConfiguration(String)

Initializes a new instance of the CacheHandleConfiguration class.

Declaration

public CacheHandleConfiguration(string handleName)

Parameters

Type	Name	Description
String	handleName	Name of the handle. This value will also be used for the Key.

Exceptions

Type	Condition
ArgumentNullException	If handleName is null.

| Improve this Doc View Source

CacheHandleConfiguration(String, String)

Initializes a new instance of the CacheHandleConfiguration class.

Declaration

public CacheHandleConfiguration(string handleName, string configurationKey)

Parameters

Type	Name	Description
String	handleName	Name of the handle.
String	configurationKey	The key which can be used to identify another part of the configuration which the handle might need.

Exceptions

Type	Condition
ArgumentNullException	If handleName or configurationKey is null.

Properties

| Improve this Doc View Source

EnablePerformanceCounters

Gets or sets a value indicating whether performance counters should be enabled or not.

If enabled, and the initialization of performance counters doesn't work, for example because of security reasons. The counters will get disabled silently.

Declaration

public bool EnablePerformanceCounters { get; set; }

Property Value

Type	Description
Boolean	`true` if performance counters should be enable; otherwise, `false`.

| Improve this Doc View Source

EnableStatistics

Gets or sets a value indicating whether statistics should be enabled.

Declaration

public bool EnableStatistics { get; set; }

Property Value

Type	Description
Boolean	`true` if statistics should be enabled; otherwise, `false`.

| Improve this Doc View Source

ExpirationMode

Gets or sets the expiration mode.

Declaration

public ExpirationMode ExpirationMode { get; set; }

Property Value

Type	Description
ExpirationMode	The expiration mode.

| Improve this Doc View Source

ExpirationTimeout

Gets or sets the expiration timeout.

Declaration

public TimeSpan ExpirationTimeout { get; set; }

Property Value

Type	Description
TimeSpan	The expiration timeout.

| Improve this Doc View Source

HandleType

Gets or sets the type of the handle.

Declaration

public Type HandleType { get; set; }

Property Value

Type	Description
Type	The type of the handle.

| Improve this Doc View Source

IsBackplaneSource

Gets or sets a value indicating whether this instance is backplane source.

Only one cache handle inside one cache manager can be backplane source. Usually this is a distributed cache. It might not make any sense to define an in process cache as backplane source.

If no backplane is configured for the cache, this setting will have no effect.

Declaration

public bool IsBackplaneSource { get; set; }

Property Value

Type	Description
Boolean	`true` if this instance should be backplane source; otherwise, `false`.

| Improve this Doc View Source

Key

Gets or sets the configuration key. Some cache handles require to reference another part of the configuration by name. If not specified, the Name will be used instead.

Declaration

public string Key { get; set; }

Property Value

Type	Description
String

| Improve this Doc View Source

Name

Gets or sets the name for the cache handle which is also the identifier of the configuration.

Declaration

public string Name { get; set; }

Property Value

Type	Description
String	The name of the handle.

Methods

| Improve this Doc View Source

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

Object.ToString()