yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Some things need to be public/adjusted for Deploy

Browse Source
This commit is contained in:
Stephan
2016-09-23 16:42:42 +02:00
parent c606314c0f
commit 3f22e727f6
8 changed files with 112 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
src/Umbraco.Web/Scheduling/BackgroundTaskRunner.cs
View File

@@ -3,13 +3,17 @@ using System.Collections.Concurrent;
using System.Threading;
using System.Threading.Tasks;
using System.Web.Hosting;
using Umbraco.Core;
using Umbraco.Core.Events;
using Umbraco.Core.Logging;
namespace Umbraco.Web.Scheduling
{
// exists for logging purposes
internal class BackgroundTaskRunner
/// <summary>
/// Manages a queue of tasks and runs them in the background.
/// </summary>
/// <remarks>This class exists for logging purposes - the one you want to use is BackgroundTaskRunner{T}.</remarks>
public abstract class BackgroundTaskRunner
{ }
/// <summary>
@@ -18,7 +22,7 @@ namespace Umbraco.Web.Scheduling
/// <typeparam name="T">The type of the managed tasks.</typeparam>
/// <remarks>The task runner is web-aware and will ensure that it shuts down correctly when the AppDomain
/// shuts down (ie is unloaded).</remarks>
internal class BackgroundTaskRunner<T> : BackgroundTaskRunner, IBackgroundTaskRunner<T>
public class BackgroundTaskRunner<T> : BackgroundTaskRunner, IBackgroundTaskRunner<T>
where T : class, IBackgroundTask
{
private readonly string _logPrefix;
@@ -43,10 +47,10 @@ namespace Umbraco.Web.Scheduling
private bool _terminated; // remember we've terminated
private TaskCompletionSource<int> _terminatedSource; // awaitable source
internal event TypedEventHandler<BackgroundTaskRunner<T>, TaskEventArgs<T>> TaskError;
internal event TypedEventHandler<BackgroundTaskRunner<T>, TaskEventArgs<T>> TaskStarting;
internal event TypedEventHandler<BackgroundTaskRunner<T>, TaskEventArgs<T>> TaskCompleted;
internal event TypedEventHandler<BackgroundTaskRunner<T>, TaskEventArgs<T>> TaskCancelled;
public event TypedEventHandler<BackgroundTaskRunner<T>, TaskEventArgs<T>> TaskError;
public event TypedEventHandler<BackgroundTaskRunner<T>, TaskEventArgs<T>> TaskStarting;
public event TypedEventHandler<BackgroundTaskRunner<T>, TaskEventArgs<T>> TaskCompleted;
public event TypedEventHandler<BackgroundTaskRunner<T>, TaskEventArgs<T>> TaskCancelled;
// triggers when the runner stops (but could start again if a task is added to it)
internal event TypedEventHandler<BackgroundTaskRunner<T>, EventArgs> Stopped;
@@ -60,26 +64,33 @@ namespace Umbraco.Web.Scheduling
/// <summary>
/// Initializes a new instance of the <see cref="BackgroundTaskRunner{T}"/> class.
/// </summary>
public BackgroundTaskRunner(ILogger logger)
: this(typeof (T).FullName, new BackgroundTaskRunnerOptions(), logger)
/// <param name="logger">A logger.</param>
/// <param name="mainDomInstall">An optional action to execute when the main domain status is aquired.</param>
/// <param name="mainDomRelease">An optional action to execute when the main domain status is released.</param>
public BackgroundTaskRunner(ILogger logger, Action mainDomInstall = null, Action mainDomRelease = null)
: this(typeof (T).FullName, new BackgroundTaskRunnerOptions(), logger, mainDomInstall, mainDomRelease)
{ }
/// <summary>
/// Initializes a new instance of the <see cref="BackgroundTaskRunner{T}"/> class.
/// </summary>
/// <param name="name">The name of the runner.</param>
/// <param name="logger"></param>
public BackgroundTaskRunner(string name, ILogger logger)
: this(name, new BackgroundTaskRunnerOptions(), logger)
/// <param name="logger">A logger.</param>
/// <param name="mainDomInstall">An optional action to execute when the main domain status is aquired.</param>
/// <param name="mainDomRelease">An optional action to execute when the main domain status is released.</param>
public BackgroundTaskRunner(string name, ILogger logger, Action mainDomInstall = null, Action mainDomRelease = null)
: this(name, new BackgroundTaskRunnerOptions(), logger, mainDomInstall, mainDomRelease)
{ }
/// <summary>
/// Initializes a new instance of the <see cref="BackgroundTaskRunner{T}"/> class with a set of options.
/// </summary>
/// <param name="options">The set of options.</param>
/// <param name="logger"></param>
public BackgroundTaskRunner(BackgroundTaskRunnerOptions options, ILogger logger)
: this(typeof (T).FullName, options, logger)
/// <param name="logger">A logger.</param>
/// <param name="mainDomInstall">An optional action to execute when the main domain status is aquired.</param>
/// <param name="mainDomRelease">An optional action to execute when the main domain status is released.</param>
public BackgroundTaskRunner(BackgroundTaskRunnerOptions options, ILogger logger, Action mainDomInstall = null, Action mainDomRelease = null)
: this(typeof (T).FullName, options, logger, mainDomInstall, mainDomRelease)
{ }
/// <summary>
@@ -87,8 +98,10 @@ namespace Umbraco.Web.Scheduling
/// </summary>
/// <param name="name">The name of the runner.</param>
/// <param name="options">The set of options.</param>
/// <param name="logger"></param>
public BackgroundTaskRunner(string name, BackgroundTaskRunnerOptions options, ILogger logger)
/// <param name="logger">A logger.</param>
/// <param name="mainDomInstall">An optional action to execute when the main domain status is aquired.</param>
/// <param name="mainDomRelease">An optional action to execute when the main domain status is released.</param>
public BackgroundTaskRunner(string name, BackgroundTaskRunnerOptions options, ILogger logger, Action mainDomInstall = null, Action mainDomRelease = null)
{
if (options == null) throw new ArgumentNullException("options");
if (logger == null) throw new ArgumentNullException("logger");
@@ -99,7 +112,15 @@ namespace Umbraco.Web.Scheduling
if (options.Hosted)
HostingEnvironment.RegisterObject(this);
if (options.AutoStart)
if (mainDomRelease != null)
{
var mainDom = ApplicationContext.Current.MainDom;
var reg = mainDom == null || ApplicationContext.Current.MainDom.Register(mainDomInstall, mainDomRelease);
if (reg == false)
_isCompleted = _terminated = true;
}
if (options.AutoStart && _terminated == false)
StartUp();
}

2
src/Umbraco.Web/Scheduling/BackgroundTaskRunnerOptions.cs
View File

@@ -3,7 +3,7 @@ namespace Umbraco.Web.Scheduling
/// <summary>
/// Provides options to the <see cref="BackgroundTaskRunner{T}"/> class.
/// </summary>
internal class BackgroundTaskRunnerOptions
public class BackgroundTaskRunnerOptions
{
//TODO: Could add options for using a stack vs queue if required

28
src/Umbraco.Web/Scheduling/TaskEventArgs.cs
View File

@@ -2,21 +2,41 @@
namespace Umbraco.Web.Scheduling
{
internal class TaskEventArgs<T> : EventArgs
/// <summary>
/// Provides arguments for task runner events.
/// </summary>
/// <typeparam name="T">The type of the task.</typeparam>
public class TaskEventArgs<T> : EventArgs
where T : IBackgroundTask
{
public T Task { get; private set; }
public Exception Exception { get; private set; }
/// <summary>
/// Initializes a new instance of the <see cref="TaskEventArgs{T}"/> class with a task.
/// </summary>
/// <param name="task">The task.</param>
public TaskEventArgs(T task)
{
Task = task;
}
/// <summary>
/// Initializes a new instance of the <see cref="TaskEventArgs{T}"/> class with a task and an exception.
/// </summary>
/// <param name="task">The task.</param>
/// <param name="exception">An exception.</param>
public TaskEventArgs(T task, Exception exception)
{
Task = task;
Exception = exception;
}
/// <summary>
/// Gets or sets the task.
/// </summary>
public T Task { get; private set; }
/// <summary>
/// Gets or sets the exception.
/// </summary>
public Exception Exception { get; private set; }
}
}

4
src/Umbraco.Web/Scheduling/ThreadingTaskImmutable.cs
View File

@@ -5,10 +5,10 @@ using System.Threading.Tasks;
namespace Umbraco.Web.Scheduling
{
/// <summary>
/// Wraps a Task within an object that gives access to its GetAwaiter method and Status
/// Wraps a <see cref="Task"/> within an object that gives access to its GetAwaiter method and Status
/// property while ensuring that it cannot be modified in any way.
/// </summary>
internal class ThreadingTaskImmutable
public class ThreadingTaskImmutable
{
private readonly Task _task;