BackgroundAttribute Class |
Custom attribute that, when applied on a method, causes the method to execute in the background. This aspect can be applied to a method with
void or Task return type.
Inheritance HierarchySystem.Object
System.Attribute
PostSharp.Extensibility.MulticastAttribute
PostSharp.Aspects.Aspect
PostSharp.Aspects.MethodLevelAspect
PostSharp.Aspects.MethodInterceptionAspect
PostSharp.Patterns.Threading.BackgroundAttribute
System.Attribute
PostSharp.Extensibility.MulticastAttribute
PostSharp.Aspects.Aspect
PostSharp.Aspects.MethodLevelAspect
PostSharp.Aspects.MethodInterceptionAspect
PostSharp.Patterns.Threading.BackgroundAttribute
Namespace: PostSharp.Patterns.Threading
Assembly: PostSharp.Patterns.Threading (in PostSharp.Patterns.Threading.dll) Version: 6.4.11.0 (6.4.11.0)
SyntaxC#
public sealed class BackgroundAttribute : MethodInterceptionAspect
The BackgroundAttribute type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BackgroundAttribute |
Initializes a new BackgroundAttribute.
|
Properties| Name | Description | |
|---|---|---|
 | 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.) |
| IsLongRunning |
Specifies that the method is long-running and should be executed on its own thread, if that is supported on the target platform.
If false, the method will be executed in the thread pool.
|
| UnsupportedTargetAction |
Specifies the action to take when the aspect is applied to an async method with unsupported return value type.
(Inherited from MethodInterceptionAspect.) |
Methods| Name | Description | |
|---|---|---|
| CompileTimeInitialize |
Method invoked at build time to initialize the instance fields of the current aspect. This method is invoked
before any other build-time method.
(Inherited from MethodLevelAspect.) |
| CompileTimeValidate(Object) |
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from MethodLevelAspect.) |
| CompileTimeValidate(MethodBase) |
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Overrides MethodLevelAspect.CompileTimeValidate(MethodBase).) |
| GetAspectConfiguration |
Method invoked at build tome to get the imperative configuration of the current Aspect.
(Inherited from Aspect.) |
| OnInvoke |
Method invoked instead of the method to which the aspect has been applied.
(Overrides MethodInterceptionAspect.OnInvoke(MethodInterceptionArgs).) |
| OnInvokeAsync |
Method invoked instead of the method to which the aspect has been applied.
(Overrides MethodInterceptionAspect.OnInvokeAsync(MethodInterceptionArgs).) |
| RuntimeInitialize |
Initializes the current aspect.
(Inherited from MethodLevelAspect.) |
RemarksWhen this aspect is applied to a method returning a Task, the aspects wraps the method call by a call to Task.Factory.StartNew, therefore executing the whole method in a background thread. Without this aspect, the target method would execute asynchronously, but in the current context, instead of in the background context.
If the IsLongRunning property is set to true, the method will be executed in a new thread. Otherwise, it will be queued into the ThreadPool.
If the target method results in an exception, the exception can be handled by subscribing to the UnhandledException event. Unhandled exceptions are rethrown, typically causing the application to crash.
See Also