aboutsummaryrefslogtreecommitdiff
path: root/lib/VNLib.Plugins.Extensions.Loading/src/Events/AsyncIntervalAttribute.cs
blob: 139a3acb0b3c8d4f849705e39d3c92604fe07a7a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/*
* Copyright (c) 2023 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins.Extensions.Loading
* File: AsyncIntervalAttribute.cs 
*
* AsyncIntervalAttribute.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>
    [AttributeUsage(AttributeTargets.Method)]
    public sealed class AsyncIntervalAttribute : Attribute
    {
        internal readonly TimeSpan Interval;

        /// <summary>
        /// Initializes a new <see cref="AsyncIntervalAttribute"/> with allowing 
        /// a configurable
        /// </summary>
        public AsyncIntervalAttribute()
        {}

        /// <summary>
        /// Gets or sets the interval in seconds. Choose only ONE internval resolution
        /// </summary>
        public int Seconds
        {
            get => (int)Interval.TotalSeconds;
            init => Interval = TimeSpan.FromSeconds(value);
        }

        /// <summary>
        /// Gets or sets the interval in milliseconds. Choose only ONE internval resolution
        /// </summary>
        public int MilliSeconds
        {
            get => (int)Interval.TotalMilliseconds;
            init => Interval = TimeSpan.FromMilliseconds(value);
        }

        /// <summary>
        /// Gets or sets the interval in minutes. Choose only ONE internval resolution
        /// </summary>
        public int Minutes
        {
            get => (int)Interval.TotalMinutes; 
            init => Interval = TimeSpan.FromMinutes(value);
        }

        /// <summary>
        /// Gets or sets the interval in hours. Choose only ONE internval resolution
        /// </summary>
        public int Hours
        {
            get => (int)Interval.TotalMinutes;
            init => Interval = TimeSpan.FromHours(value);
        }
    }
}