CacheAttribute Class |
Custom attribute that, when applied on a method, causes the return value of the method to be cached
for the specific list of arguments passed to this method call.
System.Object
System.Attribute
PostSharp.Extensibility.MulticastAttribute
PostSharp.Aspects.Aspect
PostSharp.Aspects.MethodLevelAspect
PostSharp.Aspects.MethodInterceptionAspect
PostSharp.Patterns.Caching.CacheAttribute
System.Attribute
PostSharp.Extensibility.MulticastAttribute
PostSharp.Aspects.Aspect
PostSharp.Aspects.MethodLevelAspect
PostSharp.Aspects.MethodInterceptionAspect
PostSharp.Patterns.Caching.CacheAttribute
Namespace: PostSharp.Patterns.Caching
Assembly: PostSharp.Patterns.Caching (in PostSharp.Patterns.Caching.dll) Version: 2023.0.3.0 (2023.0.3.0)
C#
public sealed class CacheAttribute : MethodInterceptionAspect
The CacheAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
| CacheAttribute | Initializes a new instance of the CacheAttribute class |
| Name | Description | |
|---|---|---|
| AbsoluteExpiration |
Gets or sets the total duration, in minutes, during which the result of the current method is stored in cache. The absolute
expiration time is counted from the moment the method is evaluated and cached.
| |
| AspectPriority |
Gets or sets the weaving priority of the aspect.
(Inherited from Aspect.) | |
| AttributeExclude |
If true, indicates that this attribute removes all other instances of the
same attribute type from the set of elements defined by the current instance.
(Inherited from MulticastAttribute.) | |
| AttributeInheritance |
Determines whether this attribute is inherited
(Inherited from MulticastAttribute.) | |
| AttributePriority |
Gets or sets the priority of the current attribute in case that multiple
instances are defined on the same element (lower values are processed before).
(Inherited from MulticastAttribute.) | |
| AttributeReplace |
Determines whether this attribute replaces other attributes found on the
target declarations.
(Inherited from MulticastAttribute.) | |
| AttributeTargetAssemblies |
Gets or sets the assemblies to which the current attribute apply.
(Inherited from MulticastAttribute.) | |
| AttributeTargetElements |
Gets or sets the kind of elements to which this custom attributes applies.
(Inherited from MulticastAttribute.) | |
| AttributeTargetExternalMemberAttributes |
Gets or sets the visibilities, scopes, virtualities, and implementation
of members to which this attribute applies, when the member is external to the current module.
(Inherited from MulticastAttribute.) | |
| AttributeTargetExternalTypeAttributes |
Gets or sets the visibilities of types to which this attribute applies,
when this type is external to the current module.
(Inherited from MulticastAttribute.) | |
| AttributeTargetMemberAttributes |
Gets or sets the visibilities, scopes, virtualities, and other characteristics
of members to which this attribute applies.
(Inherited from MulticastAttribute.) | |
| AttributeTargetMembers |
Gets or sets the expression specifying to which members
this instance applies.
(Inherited from MulticastAttribute.) | |
| AttributeTargetParameterAttributes |
Gets or sets the passing style (by value, out or ref)
of parameters to which this attribute applies.
(Inherited from MulticastAttribute.) | |
| AttributeTargetParameters |
Gets or sets the expression specifying to which parameters
this instance applies.
(Inherited from MulticastAttribute.) | |
| AttributeTargetTypeAttributes |
Gets or sets the attributes of types to which this attribute applies. Visibility, scope (Instance or Static)
and generation are the only categories that are taken into account; attributes of other categories are ignored.
(Inherited from MulticastAttribute.) | |
| AttributeTargetTypes |
Gets or sets the expression specifying to which types
this instance applies.
(Inherited from MulticastAttribute.) | |
| AutoReload |
Determines whether the method calls are automatically reloaded (by re-evaluating the target method with the same arguments)
when the cache item is removed from the cache.
| |
| IgnoreThisParameter |
Determines whether the this instance should be a part of the cache key. The default value of this property is false,
which means that by default the this instance is a part of the cache key.
| |
| Priority |
Gets or sets the priority of the current method.
| |
| ProfileName |
Gets or sets the name of the CachingProfile that contains the configuration of the current CacheAttribute.
| |
| SlidingExpiration |
Gets or sets the duration, in minutes, during which the result of the current method is stored in cache after it has been
added to or accessed from the cache. The expiration is extended every time the value is accessed from the cache.
| |
| UnsupportedTargetAction |
Specifies the action to take when the aspect is applied to an async method with unsupported return value type.
(Inherited from MethodInterceptionAspect.) |
| Name | Description | |
|---|---|---|
| CompileTimeValidate(Object) |
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from MethodLevelAspect.) | |
| GetAspectConfiguration |
Method invoked at build tome to get the imperative configuration of the current Aspect.
(Inherited from Aspect.) |
There are several ways to configure the behavior of the CacheAttribute aspect: you can set the properties of the CacheAttribute class, such as AbsoluteExpiration or SlidingExpiration. You can add the CacheConfigurationAttribute custom attribute to the declaring type, a base type, or the declaring assembly. Finally, you can define a profile by setting the ProfileName property and configure the profile at run time by accessing the Profiles collection of the CachingServices class.
Use the NotCacheKeyAttribute custom attribute to exclude a parameter from being a part of the cache key.
To invalidate a cached method, see InvalidateCacheAttribute and CachingServices.Invalidation.