CachingBackendEnhancer Class

A base class for all cache enhancers. A CachingBackendEnhancer is a node in a chain of responsibility where the last node is the physical implementation of the CachingBackend. A CachingBackendEnhancer can add behaviors to a CachingBackend.

Inheritance Hierarchy

System.Object
  PostSharp.Patterns.Caching.Implementation.CachingBackend
    PostSharp.Patterns.Caching.Implementation.CachingBackendEnhancer
      PostSharp.Patterns.Caching.Backends.TwoLayerCachingBackendEnhancer
      PostSharp.Patterns.Caching.Implementation.CacheInvalidator

Namespace: PostSharp.Patterns.Caching.Implementation
Assembly: PostSharp.Patterns.Caching (in PostSharp.Patterns.Caching.dll) Version: 5.0.55.0 (5.0.55.0)

Syntax

Copy

public abstract class CachingBackendEnhancer : CachingBackend

The CachingBackendEnhancer type exposes the following members.

Constructors

	Name	Description
	CachingBackendEnhancer	Initializes a new CachingBackendEnhancer.

Properties

	Name	Description
	Id	Gets the Guid of the current CachingBackend. (Inherited from CachingBackend.)
	Logger	Gets the Logger that implementations can use to emit log records. (Inherited from CachingBackend.)
	Status	Gets the status of the current CachingBackend (Default, Disposing or Disposed). (Inherited from CachingBackend.)
	SupportedFeatures	Gets the set of features supported by the current CachingBackend. (Inherited from CachingBackend.)
	UnderlyingBackend	Gets the next CachingBackend in the chain of responsibility.
	ValueAdapters	Gets the factory of value adapters (IValueAdapter), which allow for instance to cache things like Stream or IEnumerable, which could not be otherwise cached. (Inherited from CachingBackend.)

Methods

	Name	Description
	Clear	Clears the cache. (Inherited from CachingBackend.)
	ClearAsync	Asynchronously clears the cache. (Inherited from CachingBackend.)
	ClearAsyncCore	Asynchronously clears the cache. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. (Overrides CachingBackend.ClearAsyncCore(CancellationToken).)
	ClearCore	Clears the cache. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. (Overrides CachingBackend.ClearCore().)
	ContainsDependency	Determines whether the cache contains a given dependency. (Inherited from CachingBackend.)
	ContainsDependencyAsync	Asynchronously determines whether the cache contains a given dependency. (Inherited from CachingBackend.)
	ContainsDependencyAsyncCore	Asynchronously determines whether the cache contains a given dependency. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. Arguments are already validated by the consumer API. (Overrides CachingBackend.ContainsDependencyAsyncCore(String, CancellationToken).)
	ContainsDependencyCore	Determines whether the cache contains a given dependency. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. Arguments are already validated by the consumer API. (Overrides CachingBackend.ContainsDependencyCore(String).)
	ContainsItem	Determines whether the cache contains an item of a given key. (Inherited from CachingBackend.)
	ContainsItemAsync	Asynchronously determines whether the cache contains an item of a given key. (Inherited from CachingBackend.)
	ContainsItemAsyncCore	Asynchronously determines whether the cache contains an item of a given key. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. Arguments are already validated by the consumer API. (Overrides CachingBackend.ContainsItemAsyncCore(String, CancellationToken).)
	ContainsItemCore	Determines whether the cache contains an item of a given key. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. Arguments are already validated by the consumer API. (Overrides CachingBackend.ContainsItemCore(String).)
	CreateFeatures	Creates a CachingBackendFeatures object, which describes set of features implemented by the back-end. This method is invoked the first time the SupportedFeatures property is evaluated. The result is then cached. (Overrides CachingBackend.CreateFeatures().)
	Dispose()	Synchronously dispose the current CachingBackend. (Inherited from CachingBackend.)
	Dispose(Boolean)	(Inherited from CachingBackend.)
	DisposeAsync	Asynchronously dispose the current CachingBackend. (Inherited from CachingBackend.)
	DisposeAsyncCore	Asynchronously disposes the current CachingBackend. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. (Overrides CachingBackend.DisposeAsyncCore(CancellationToken).)
	DisposeCore	Synchronously disposes the current CachingBackend. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. (Overrides CachingBackend.DisposeCore(Boolean).)
	EnqueueBackgroundTask	Obsolete. (Inherited from CachingBackend.)
	GetItem	Gets a cache item given its key. (Inherited from CachingBackend.)
	GetItemAsync	Asynchronously gets a cache item given its key. (Inherited from CachingBackend.)
	GetItemAsyncCore	Asynchronously gets a cache item given its key. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. Arguments are already validated by the consumer API. (Overrides CachingBackend.GetItemAsyncCore(String, Boolean, CancellationToken).)
	GetItemCore	Gets a cache item given its key. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. Arguments are already validated by the consumer API. (Overrides CachingBackend.GetItemCore(String, Boolean).)
	InvalidateDependency	Removes from the cache all items that have a specific dependency. (Inherited from CachingBackend.)
	InvalidateDependencyAsync	Asynchronously removes from the cache all items that have a specific dependency. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. Arguments are already validated by the consumer API. (Inherited from CachingBackend.)
	InvalidateDependencyAsyncCore	Asynchronously removes from the cache all items that have a specific dependency. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. Arguments are already validated by the consumer API. (Overrides CachingBackend.InvalidateDependencyAsyncCore(String, CancellationToken).)
	InvalidateDependencyCore	Removes from the cache all items that have a specific dependency. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. Arguments are already validated by the consumer API. (Overrides CachingBackend.InvalidateDependencyCore(String).)
	OnBackendDependencyInvalidated	Method invoked when the DependencyInvalidated event of the next UnderlyingBackend in the chain of responsibility is invoked.
	OnBackendItemRemoved	Method invoked when the ItemRemoved event of the next UnderlyingBackend in the chain of responsibility is invoked.
	OnDependencyInvalidated(CacheDependencyInvalidatedEventArgs)	Raises the DependencyInvalidated event given a CacheDependencyInvalidatedEventArgs. (Inherited from CachingBackend.)
	OnDependencyInvalidated(String, Guid)	Raises the DependencyInvalidated event , but lazily instantiates the CacheDependencyInvalidatedEventArgs if there is an event client. (Inherited from CachingBackend.)
	OnItemRemoved(CacheItemRemovedEventArgs)	Raises the ItemRemoved event given a CacheItemRemovedEventArgs. (Inherited from CachingBackend.)
	OnItemRemoved(String, CacheItemRemovedReason, Guid)	Raises the ItemRemoved event, but lazily instantiates the CacheItemRemovedEventArgs if there is an event client. (Inherited from CachingBackend.)
	OnSynchronizationSignalReceived	Obsolete. Signals that a specific synchronization signal has been received. This completes the Task returned by the WhenSynchronizationSignalReceived(Guid, CancellationToken) method. (Inherited from CachingBackend.)
	RemoveItem	Removes a cache item from the cache given its key. (Inherited from CachingBackend.)
	RemoveItemAsync	Asynchronously removes a cache item from the cache given its key. (Inherited from CachingBackend.)
	RemoveItemAsyncCore	Asynchronously removes a cache item from the cache given its key. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. Arguments are already validated by the consumer API. (Overrides CachingBackend.RemoveItemAsyncCore(String, CancellationToken).)
	RemoveItemCore	Removes a cache item from the cache given its key. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. Arguments are already validated by the consumer API. (Overrides CachingBackend.RemoveItemCore(String).)
	SendSynchronizationSignalAsync	Obsolete. Sends a synchronization signal of a given Guid to the physical implementation of the cache. (Inherited from CachingBackend.)
	SendSynchronizationSignalAsyncCore	Obsolete. Sends a synchronization signal of a given Guid to the physical implementation of the cache. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. (Overrides CachingBackend.SendSynchronizationSignalAsyncCore(Guid, CancellationToken).)
	SetItem	Sets a cache item. (Inherited from CachingBackend.)
	SetItemAsync	Asynchronously sets a cache item. (Inherited from CachingBackend.)
	SetItemAsyncCore	Asynchronously sets a cache item. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. Arguments are already validated by the consumer API. The default implementation is to call the synchronous SetItemCore(String, CacheItem) method. (Overrides CachingBackend.SetItemAsyncCore(String, CacheItem, CancellationToken).)
	SetItemCore	Sets a cache item. This protected method is part of the implementation API and is meant to be overridden in user code, not invoked. Arguments are already validated by the consumer API. (Overrides CachingBackend.SetItemCore(String, CacheItem).)
	StopAcceptingBackgroundTasks	Obsolete. Forbids the use of the EnqueueBackgroundTask(Func<Task>) method. This method is used for debugging purposes only. (Inherited from CachingBackend.)
	ToString	Returns a string that represents the current object. (Inherited from CachingBackend.)
	WhenBackgroundTasksCompleted	Obsolete. (Inherited from CachingBackend.)
	WhenSynchronizationSignalReceived	Obsolete. Returns a Task that completes when a given synchronization signal is received from the physical implementation of the cache. (Overrides CachingBackend.WhenSynchronizationSignalReceived(Guid, CancellationToken).)

Events

	Name	Description
	DependencyInvalidated	Events raised when a dependency is invalidated. Check the Events property to see if the current CachingBackend supports events. (Inherited from CachingBackend.)
	ItemRemoved	Event raised when a cache item is removed from the cache. Check the Events property to see if the current CachingBackend supports events. (Inherited from CachingBackend.)

Extension Methods

	Name	Description
	QueryInterface<T>	Gets the implementation of a specified interface for the specified object. (Defined by QueryInterfaceExtensions.)

Remarks

The default behavior of all methods of a CachingBackendEnhancer is to delegate the implementation to the next CachingBackend in the chain of responsibility.

Reference

PostSharp.Patterns.Caching.Implementation Namespace