ExpirationPolicy
| Name | Value |
|---|---|
| Assembly | Catel.Core |
| Namespace | Catel.Caching.Policies |
| Available on | .NET Framework 4.5, .NET Framework 4.6, Portable Class Libraries, Xamarin - Android, Xamarin - iOS |
public abstract class ExpirationPolicy
The expiration policy.
Fields
Constructors
ExpirationPolicy(bool canReset)
Initializes a new instance of the ExpirationPolicy class.
Parameters
| Name | Description |
|---|---|
| canReset | The can reset. |
Properties
CanReset
Gets a value indicating whether the value with this policy can be reset.
IsExpired
Gets a value indicating whether the value with this policy attached is expired.
IsResting
Gets a value indicating whether is resting.
Methods
Absolute(DateTime absoluteExpirationDateTime, bool force)
Creates a AbsoluteExpirationPolicy instance.
Parameters
| Name | Description |
|---|---|
| absoluteExpirationDateTime | The absolute expiration. |
| force | Indicates whether the policy will be created even if the policy will be created expired. |
Returns
The AbsoluteExpirationPolicy ornull if absoluteExpirationDateTime is in the pass.
Remarks
The cache item will expire on the absolute expiration date time.
Custom(Func<bool> isExpiredFunc, Action resetAction, bool force)
Creates a CustomExpirationPolicy instance.
Parameters
| Name | Description |
|---|---|
| isExpiredFunc | The function to check if the policy is expired. |
| resetAction | The action that will be executed if the item is read before expiration. |
| force | Indicates whether the policy will be created even if the policy will be created expired. |
Returns
Exceptions
| Name | Description |
|---|---|
| System.ArgumentNullException | The isExpiredFunc isnull. |
Duration(TimeSpan durationTimeSpan, bool force)
Creates a DurationExpirationPolicy instance.
Parameters
| Name | Description |
|---|---|
| durationTimeSpan | The duration. |
| force | Indicates whether the policy will be created even if the policy will be created expired. |
Returns
The DurationExpirationPolicy ornull if durationTimeSpan is less than 0 ticks.
Remarks
The cache item will expire using the duration to calculate the absolute expiration from now.
OnReset()
Called when the policy is resetting.
Reset()
Resets the expiration policy.
Exceptions
| Name | Description |
|---|---|
| InvalidOperationException | If the policy do not support this operation. |
Sliding(TimeSpan durationTimeSpan, bool force)
Creates a SlidingExpirationPolicy instance.
Parameters
| Name | Description |
|---|---|
| durationTimeSpan | The duration. |
| force | Indicates whether the policy will be created even if the policy will be created expired. |
Returns
The SlidingExpirationPolicy ornull if durationTimeSpan is less than 0 ticks.
Remarks
The cache item will expire using the duration property as the sliding expiration.
Have a question about Catel? Use StackOverflow with the Catel tag!