diff options
Diffstat (limited to 'MediaBrowser.Common')
11 files changed, 115 insertions, 18 deletions
diff --git a/MediaBrowser.Common/MediaBrowser.Common.csproj b/MediaBrowser.Common/MediaBrowser.Common.csproj index c46dd4a4f..ad0c0cecd 100644 --- a/MediaBrowser.Common/MediaBrowser.Common.csproj +++ b/MediaBrowser.Common/MediaBrowser.Common.csproj @@ -86,6 +86,7 @@ <Compile Include="ScheduledTasks\DailyTrigger.cs" /> <Compile Include="ScheduledTasks\IntervalTrigger.cs" /> <Compile Include="ScheduledTasks\TaskCompletionEventArgs.cs" /> + <Compile Include="ScheduledTasks\TaskExecutionOptions.cs" /> <Compile Include="ScheduledTasks\WeeklyTrigger.cs" /> <Compile Include="Security\IRequiresRegistration.cs" /> <Compile Include="Security\ISecurityManager.cs" /> diff --git a/MediaBrowser.Common/Plugins/BasePlugin.cs b/MediaBrowser.Common/Plugins/BasePlugin.cs index 9d0133c67..a0716137b 100644 --- a/MediaBrowser.Common/Plugins/BasePlugin.cs +++ b/MediaBrowser.Common/Plugins/BasePlugin.cs @@ -325,7 +325,7 @@ namespace MediaBrowser.Common.Plugins AssemblyFileName = AssemblyFileName, ConfigurationDateLastModified = ConfigurationDateLastModified, Description = Description, - Id = Id.ToString("N"), + Id = Id.ToString(), ConfigurationFileName = ConfigurationFileName }; diff --git a/MediaBrowser.Common/ScheduledTasks/DailyTrigger.cs b/MediaBrowser.Common/ScheduledTasks/DailyTrigger.cs index bfecadee7..2f935607b 100644 --- a/MediaBrowser.Common/ScheduledTasks/DailyTrigger.cs +++ b/MediaBrowser.Common/ScheduledTasks/DailyTrigger.cs @@ -1,5 +1,6 @@ using System; using System.Threading; +using MediaBrowser.Model.Events; namespace MediaBrowser.Common.ScheduledTasks { @@ -21,6 +22,14 @@ namespace MediaBrowser.Common.ScheduledTasks private Timer Timer { get; set; } /// <summary> + /// Gets the execution properties of this task. + /// </summary> + /// <value> + /// The execution properties of this task. + /// </value> + public TaskExecutionOptions TaskOptions { get; set; } + + /// <summary> /// Stars waiting for the trigger action /// </summary> /// <param name="isApplicationStartup">if set to <c>true</c> [is application startup].</param> @@ -58,7 +67,7 @@ namespace MediaBrowser.Common.ScheduledTasks /// <summary> /// Occurs when [triggered]. /// </summary> - public event EventHandler<EventArgs> Triggered; + public event EventHandler<GenericEventArgs<TaskExecutionOptions>> Triggered; /// <summary> /// Called when [triggered]. @@ -67,7 +76,7 @@ namespace MediaBrowser.Common.ScheduledTasks { if (Triggered != null) { - Triggered(this, EventArgs.Empty); + Triggered(this, new GenericEventArgs<TaskExecutionOptions>(TaskOptions)); } } } diff --git a/MediaBrowser.Common/ScheduledTasks/ITaskManager.cs b/MediaBrowser.Common/ScheduledTasks/ITaskManager.cs index 01dc355c3..8d271859e 100644 --- a/MediaBrowser.Common/ScheduledTasks/ITaskManager.cs +++ b/MediaBrowser.Common/ScheduledTasks/ITaskManager.cs @@ -17,6 +17,14 @@ namespace MediaBrowser.Common.ScheduledTasks /// Cancels if running and queue. /// </summary> /// <typeparam name="T"></typeparam> + /// <param name="options">Task options.</param> + void CancelIfRunningAndQueue<T>(TaskExecutionOptions options) + where T : IScheduledTask; + + /// <summary> + /// Cancels if running and queue. + /// </summary> + /// <typeparam name="T"></typeparam> void CancelIfRunningAndQueue<T>() where T : IScheduledTask; @@ -31,6 +39,14 @@ namespace MediaBrowser.Common.ScheduledTasks /// Queues the scheduled task. /// </summary> /// <typeparam name="T"></typeparam> + /// <param name="options">Task options.</param> + void QueueScheduledTask<T>(TaskExecutionOptions options) + where T : IScheduledTask; + + /// <summary> + /// Queues the scheduled task. + /// </summary> + /// <typeparam name="T"></typeparam> void QueueScheduledTask<T>() where T : IScheduledTask; @@ -38,7 +54,8 @@ namespace MediaBrowser.Common.ScheduledTasks /// Queues the scheduled task. /// </summary> /// <param name="task">The task.</param> - void QueueScheduledTask(IScheduledTask task); + /// <param name="options">The task run options.</param> + void QueueScheduledTask(IScheduledTask task, TaskExecutionOptions options = null); /// <summary> /// Adds the tasks. @@ -47,7 +64,7 @@ namespace MediaBrowser.Common.ScheduledTasks void AddTasks(IEnumerable<IScheduledTask> tasks); void Cancel(IScheduledTaskWorker task); - Task Execute(IScheduledTaskWorker task); + Task Execute(IScheduledTaskWorker task, TaskExecutionOptions options = null); event EventHandler<GenericEventArgs<IScheduledTaskWorker>> TaskExecuting; event EventHandler<TaskCompletionEventArgs> TaskCompleted; diff --git a/MediaBrowser.Common/ScheduledTasks/ITaskTrigger.cs b/MediaBrowser.Common/ScheduledTasks/ITaskTrigger.cs index 66701650e..d30111316 100644 --- a/MediaBrowser.Common/ScheduledTasks/ITaskTrigger.cs +++ b/MediaBrowser.Common/ScheduledTasks/ITaskTrigger.cs @@ -1,4 +1,5 @@ using System; +using MediaBrowser.Model.Events; namespace MediaBrowser.Common.ScheduledTasks { @@ -10,7 +11,7 @@ namespace MediaBrowser.Common.ScheduledTasks /// <summary> /// Fires when the trigger condition is satisfied and the task should run /// </summary> - event EventHandler<EventArgs> Triggered; + event EventHandler<GenericEventArgs<TaskExecutionOptions>> Triggered; /// <summary> /// Stars waiting for the trigger action @@ -22,5 +23,13 @@ namespace MediaBrowser.Common.ScheduledTasks /// Stops waiting for the trigger action /// </summary> void Stop(); + + /// <summary> + /// Gets or sets the execution properties of this task. + /// </summary> + /// <value> + /// The execution properties of this task. + /// </value> + TaskExecutionOptions TaskOptions { get; set; } } }
\ No newline at end of file diff --git a/MediaBrowser.Common/ScheduledTasks/IntervalTrigger.cs b/MediaBrowser.Common/ScheduledTasks/IntervalTrigger.cs index cac6d1fa3..455a70d7e 100644 --- a/MediaBrowser.Common/ScheduledTasks/IntervalTrigger.cs +++ b/MediaBrowser.Common/ScheduledTasks/IntervalTrigger.cs @@ -1,5 +1,6 @@ using System; using System.Threading; +using MediaBrowser.Model.Events; namespace MediaBrowser.Common.ScheduledTasks { @@ -21,6 +22,14 @@ namespace MediaBrowser.Common.ScheduledTasks private Timer Timer { get; set; } /// <summary> + /// Gets the execution properties of this task. + /// </summary> + /// <value> + /// The execution properties of this task. + /// </value> + public TaskExecutionOptions TaskOptions { get; set; } + + /// <summary> /// Stars waiting for the trigger action /// </summary> /// <param name="isApplicationStartup">if set to <c>true</c> [is application startup].</param> @@ -53,7 +62,7 @@ namespace MediaBrowser.Common.ScheduledTasks /// <summary> /// Occurs when [triggered]. /// </summary> - public event EventHandler<EventArgs> Triggered; + public event EventHandler<GenericEventArgs<TaskExecutionOptions>> Triggered; /// <summary> /// Called when [triggered]. @@ -62,7 +71,7 @@ namespace MediaBrowser.Common.ScheduledTasks { if (Triggered != null) { - Triggered(this, EventArgs.Empty); + Triggered(this, new GenericEventArgs<TaskExecutionOptions>(TaskOptions)); } } } diff --git a/MediaBrowser.Common/ScheduledTasks/ScheduledTaskHelpers.cs b/MediaBrowser.Common/ScheduledTasks/ScheduledTaskHelpers.cs index cec6249b3..4ad33341a 100644 --- a/MediaBrowser.Common/ScheduledTasks/ScheduledTaskHelpers.cs +++ b/MediaBrowser.Common/ScheduledTasks/ScheduledTaskHelpers.cs @@ -99,6 +99,11 @@ namespace MediaBrowser.Common.ScheduledTasks info.SystemEvent = systemEventTrigger.SystemEvent; } + if (trigger.TaskOptions != null) + { + info.MaxRuntimeMs = trigger.TaskOptions.MaxRuntimeMs; + } + return info; } @@ -111,6 +116,11 @@ namespace MediaBrowser.Common.ScheduledTasks /// <exception cref="System.ArgumentException">Invalid trigger type: + info.Type</exception> public static ITaskTrigger GetTrigger(TaskTriggerInfo info) { + var options = new TaskExecutionOptions + { + MaxRuntimeMs = info.MaxRuntimeMs + }; + if (info.Type.Equals(typeof(DailyTrigger).Name, StringComparison.OrdinalIgnoreCase)) { if (!info.TimeOfDayTicks.HasValue) @@ -120,7 +130,8 @@ namespace MediaBrowser.Common.ScheduledTasks return new DailyTrigger { - TimeOfDay = TimeSpan.FromTicks(info.TimeOfDayTicks.Value) + TimeOfDay = TimeSpan.FromTicks(info.TimeOfDayTicks.Value), + TaskOptions = options }; } @@ -139,7 +150,8 @@ namespace MediaBrowser.Common.ScheduledTasks return new WeeklyTrigger { TimeOfDay = TimeSpan.FromTicks(info.TimeOfDayTicks.Value), - DayOfWeek = info.DayOfWeek.Value + DayOfWeek = info.DayOfWeek.Value, + TaskOptions = options }; } @@ -152,7 +164,8 @@ namespace MediaBrowser.Common.ScheduledTasks return new IntervalTrigger { - Interval = TimeSpan.FromTicks(info.IntervalTicks.Value) + Interval = TimeSpan.FromTicks(info.IntervalTicks.Value), + TaskOptions = options }; } @@ -165,7 +178,8 @@ namespace MediaBrowser.Common.ScheduledTasks return new SystemEventTrigger { - SystemEvent = info.SystemEvent.Value + SystemEvent = info.SystemEvent.Value, + TaskOptions = options }; } diff --git a/MediaBrowser.Common/ScheduledTasks/StartupTrigger.cs b/MediaBrowser.Common/ScheduledTasks/StartupTrigger.cs index 17e4628d0..a58fa22b9 100644 --- a/MediaBrowser.Common/ScheduledTasks/StartupTrigger.cs +++ b/MediaBrowser.Common/ScheduledTasks/StartupTrigger.cs @@ -1,5 +1,6 @@ using System; using System.Threading.Tasks; +using MediaBrowser.Model.Events; namespace MediaBrowser.Common.ScheduledTasks { @@ -10,6 +11,14 @@ namespace MediaBrowser.Common.ScheduledTasks { public int DelayMs { get; set; } + /// <summary> + /// Gets the execution properties of this task. + /// </summary> + /// <value> + /// The execution properties of this task. + /// </value> + public TaskExecutionOptions TaskOptions { get; set; } + public StartupTrigger() { DelayMs = 3000; @@ -39,7 +48,7 @@ namespace MediaBrowser.Common.ScheduledTasks /// <summary> /// Occurs when [triggered]. /// </summary> - public event EventHandler<EventArgs> Triggered; + public event EventHandler<GenericEventArgs<TaskExecutionOptions>> Triggered; /// <summary> /// Called when [triggered]. @@ -48,7 +57,7 @@ namespace MediaBrowser.Common.ScheduledTasks { if (Triggered != null) { - Triggered(this, EventArgs.Empty); + Triggered(this, new GenericEventArgs<TaskExecutionOptions>(TaskOptions)); } } } diff --git a/MediaBrowser.Common/ScheduledTasks/SystemEventTrigger.cs b/MediaBrowser.Common/ScheduledTasks/SystemEventTrigger.cs index 7f86a5a2f..a40dc6b5c 100644 --- a/MediaBrowser.Common/ScheduledTasks/SystemEventTrigger.cs +++ b/MediaBrowser.Common/ScheduledTasks/SystemEventTrigger.cs @@ -2,6 +2,7 @@ using Microsoft.Win32; using System; using System.Threading.Tasks; +using MediaBrowser.Model.Events; namespace MediaBrowser.Common.ScheduledTasks { @@ -17,6 +18,14 @@ namespace MediaBrowser.Common.ScheduledTasks public SystemEvent SystemEvent { get; set; } /// <summary> + /// Gets the execution properties of this task. + /// </summary> + /// <value> + /// The execution properties of this task. + /// </value> + public TaskExecutionOptions TaskOptions { get; set; } + + /// <summary> /// Stars waiting for the trigger action /// </summary> /// <param name="isApplicationStartup">if set to <c>true</c> [is application startup].</param> @@ -57,7 +66,7 @@ namespace MediaBrowser.Common.ScheduledTasks /// <summary> /// Occurs when [triggered]. /// </summary> - public event EventHandler<EventArgs> Triggered; + public event EventHandler<GenericEventArgs<TaskExecutionOptions>> Triggered; /// <summary> /// Called when [triggered]. @@ -66,7 +75,7 @@ namespace MediaBrowser.Common.ScheduledTasks { if (Triggered != null) { - Triggered(this, EventArgs.Empty); + Triggered(this, new GenericEventArgs<TaskExecutionOptions>(TaskOptions)); } } } diff --git a/MediaBrowser.Common/ScheduledTasks/TaskExecutionOptions.cs b/MediaBrowser.Common/ScheduledTasks/TaskExecutionOptions.cs new file mode 100644 index 000000000..41b33b1c2 --- /dev/null +++ b/MediaBrowser.Common/ScheduledTasks/TaskExecutionOptions.cs @@ -0,0 +1,11 @@ + +namespace MediaBrowser.Common.ScheduledTasks +{ + /// <summary> + /// A class that encomposases all common task run properties. + /// </summary> + public class TaskExecutionOptions + { + public int? MaxRuntimeMs { get; set; } + } +} diff --git a/MediaBrowser.Common/ScheduledTasks/WeeklyTrigger.cs b/MediaBrowser.Common/ScheduledTasks/WeeklyTrigger.cs index cfb3f1fab..a3818f83f 100644 --- a/MediaBrowser.Common/ScheduledTasks/WeeklyTrigger.cs +++ b/MediaBrowser.Common/ScheduledTasks/WeeklyTrigger.cs @@ -1,5 +1,6 @@ using System; using System.Threading; +using MediaBrowser.Model.Events; namespace MediaBrowser.Common.ScheduledTasks { @@ -21,6 +22,14 @@ namespace MediaBrowser.Common.ScheduledTasks public DayOfWeek DayOfWeek { get; set; } /// <summary> + /// Gets the execution properties of this task. + /// </summary> + /// <value> + /// The execution properties of this task. + /// </value> + public TaskExecutionOptions TaskOptions { get; set; } + + /// <summary> /// Gets or sets the timer. /// </summary> /// <value>The timer.</value> @@ -88,7 +97,7 @@ namespace MediaBrowser.Common.ScheduledTasks /// <summary> /// Occurs when [triggered]. /// </summary> - public event EventHandler<EventArgs> Triggered; + public event EventHandler<GenericEventArgs<TaskExecutionOptions>> Triggered; /// <summary> /// Called when [triggered]. @@ -97,7 +106,7 @@ namespace MediaBrowser.Common.ScheduledTasks { if (Triggered != null) { - Triggered(this, EventArgs.Empty); + Triggered(this, new GenericEventArgs<TaskExecutionOptions>(TaskOptions)); } } } |