/*
* Copyright (c) 2024 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins.Extensions.Loading
* File: ConfigurableAsyncIntervalAttribute.cs 
*
* ConfigurableAsyncIntervalAttribute.cs is part of VNLib.Plugins.Extensions.Loading which is part of the larger 
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Extensions.Loading is free software: you can redistribute it and/or modify 
* it under the terms of the GNU Affero General Public License as 
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Extensions.Loading is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program.  If not, see https://www.gnu.org/licenses/.
*/

using System;

namespace VNLib.Plugins.Extensions.Loading.Events
{
    /// <summary>
    /// When added to a method schedules it as a callback on a specified interval when 
    /// the plugin is loaded, and stops when unloaded
    /// </summary>
    [Obsolete("Depricated in favor of more verbose IIntervaleSchedulable apis")]
    [AttributeUsage(AttributeTargets.Method)]
    public sealed class ConfigurableAsyncIntervalAttribute : Attribute
    {
        /// <summary>
        /// The configuration property name for the event interval
        /// </summary>
        public string IntervalPropertyName { get; }

        /// <summary>
        /// The time resoltion for the event interval
        /// </summary>
        public IntervalResultionType Resolution { get; }

        /// <summary>
        /// Initializes a <see cref="ConfigurableAsyncIntervalAttribute"/> with the specified
        /// interval property name
        /// </summary>
        /// <param name="intervalPropertyName">The configuration property name for the event interval</param>
        /// <param name="resolution">The time resoltion for the event interval</param>
        public ConfigurableAsyncIntervalAttribute(string intervalPropertyName, IntervalResultionType resolution)
        {
            IntervalPropertyName = intervalPropertyName;
            Resolution = resolution;
        }
    }
}