CacheCleanerSettings Class

Provides time settings to clean a cache for storing documents and reports.

Namespace: DevExpress.XtraReports.Web.WebDocumentViewer

Assembly: DevExpress.XtraReports.v24.2.Web.dll

NuGet Package: DevExpress.Web.Reporting.Common

Declaration

C#

public class CacheCleanerSettings :
    StoragesCleanerSettingsBase

VB.NET

Public Class CacheCleanerSettings
    Inherits StoragesCleanerSettingsBase

Related API Members

The following members return CacheCleanerSettings objects:

• CacheCleanerSettings.CreateDefault()

Remarks

The cleaner service periodically searches the cache and file storage for expired documents/exported documents/reports and deletes them. You can use the CacheCleanerSettings and StorageCleanerSettings to specify check interval and expiration time settings. To prevent expired documents from being deleted, call the UseEmptyStoragesCleaner() method to register an empty storage cleaner.

Settings in a .NET Framework Application

Use the DefaultWebDocumentViewerContainer.Register<T, TImpl> method to register a new instance of the CacheCleanerSettings class with the different time settings.

The code below demonstrates how to register custom settings in a .NET Framework application. The settings force a document to live 1 minute in a client session while the report lives 120 minutes. The cleaner performs first check 30 seconds after start and checks the storage each minute.

C#

using DevExpress.XtraReports.Web.WebDocumentViewer;
//... 
  void Application_Start(object sender, EventArgs e) {
    var dueTime = TimeSpan.FromSeconds(30);
    var period = TimeSpan.FromMinutes(1);
    var reportTimeToLive = TimeSpan.FromHours(2);
    var documentTimeToLive = TimeSpan.FromMinutes(1);
    DefaultWebDocumentViewerContainer.RegisterSingleton<CacheCleanerSettings>(new CacheCleanerSettings(dueTime, period, reportTimeToLive, documentTimeToLive));
  }
//...

VB.NET

Imports DevExpress.XtraReports.Web.WebDocumentViewer
'... 
  Sub Application_Start(sender As Object, e As EventArgs)
    Dim dueTime = TimeSpan.FromSeconds(30)
    Dim period = TimeSpan.FromMinutes(1)
    Dim reportTimeToLive = TimeSpan.FromHours(2)
    Dim documentTimeToLive = TimeSpan.FromMinutes(1)
    DefaultWebDocumentViewerContainer.RegisterSingleton(Of CacheCleanerSettings)(New CacheCleanerSettings(dueTime, period, reportTimeToLive, documentTimeToLive))
  End Sub
'... 

Settings in a .NET Application

Use the AddSingleton method to register a new instance of the CacheCleanerSettings class with the different time settings.

The code below demonstrates how to register custom settings in a .NET Framework application. The settings force a document to live 1 minute in a client session while the report lives 120 minutes. The cleaner performs first check 30 seconds after start and checks the storage each minute.

C#

using DevExpress.AspNetCore;
using DevExpress.AspNetCore.Reporting;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddDevExpressControls();
builder.Services.AddMvc(); 

var dueTime = TimeSpan.FromSeconds(30);
var period = TimeSpan.FromMinutes(1);
var reportTimeToLive = TimeSpan.FromHours(2);
var documentTimeToLive = TimeSpan.FromMinutes(1);
builder.Services.AddSingleton<CacheCleanerSettings>(new CacheCleanerSettings(dueTime, period, reportTimeToLive, documentTimeToLive));

var app = builder.Build();

Storage Cleaner Settings

The default WebDocumentViewer storage for documents/exported documents/reports is the memory cache. If you enable the file-based storage, a copies of this resource will then be stored on the hard drive. These copies have their own individual expiration settings. The CacheCleanerSettings controls the in-memory copy, and the StorageCleanerSettings are applied to the storage copy. Call the following methods to enable file storage and use the StorageCleanerSettings:

ASP.NET Web Forms / ASP.NET MVC	ASP.NET Core
UseEmptyStoragesCleaner()	UseEmptyStoragesCleaner()
UseFileDocumentStorage	UseFileDocumentStorage
UseFileExportedDocumentStorage	UseFileExportedDocumentStorage
UseFileReportStorage	UseFileReportStorage

Inheritance

Object

DevExpress.XtraReports.Web.WebDocumentViewer.Native.Services.StoragesCleanerSettingsBase

CacheCleanerSettings