TekH
bc881bf70f
Added detailed XML documentation across multiple files to enhance code maintainability and readability. Key updates include: - Documented `AllowAllDashboardAuthorizationFilter` to clarify its development-only usage. - Added comments to `DtoExtensions` for Hangfire job ID generation and DTO-to-command conversion methods. - Enhanced `HealthCheckHtmlGenerator` with detailed descriptions of HTML generation methods and utility functions. - Documented `DependencyInjection` and `ProfileWorkerOptionsValidator` to explain service registration and configuration validation. - Updated `ProfileCache` with comments on thread-safe operations. - Added documentation to `ProfileWork` for profile synchronization logic and execution flow. - Enhanced `ProfileWorker` with health check logic and background service execution details. - Documented `ProfileWorkerOptions` configuration properties. These changes aim to improve developer understanding and ensure best practices are followed in production environments.
24 lines
729 B
C#
24 lines
729 B
C#
namespace ECMJobRunner.WebCron.ProfileWorker;
|
|
|
|
/// <summary>
|
|
/// Configuration options for ProfileWorker background service.
|
|
/// Binds to "ProfileWorker" section in appsettings.json.
|
|
/// </summary>
|
|
public class ProfileWorkerOptions
|
|
{
|
|
/// <summary>
|
|
/// Configuration section name for binding options.
|
|
/// </summary>
|
|
public const string SectionName = "ProfileWorker";
|
|
|
|
/// <summary>
|
|
/// Interval in milliseconds between profile synchronization checks.
|
|
/// Default: 1000ms (1 second).
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lower values increase responsiveness but consume more resources.
|
|
/// Recommended range: 1000-5000ms.
|
|
/// </remarks>
|
|
public int IntervalMS { get; set; } = 1000;
|
|
}
|