Nuclex.Support/Source/Scheduling/ThreadCallbackOperation.cs
Markus Ewald 4b0d3d26cc Some lesser XML documentation improvements
git-svn-id: file:///srv/devel/repo-conversion/nusu@44 d2e56fa2-650e-0410-a79f-9358c0239efd
2007-08-31 21:24:40 +00:00

70 lines
2.5 KiB
C#

#region CPL License
/*
Nuclex Framework
Copyright (C) 2002-2007 Nuclex Development Labs
This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.
This library 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
IBM Common Public License for more details.
You should have received a copy of the IBM Common Public
License along with this library
*/
#endregion
using System;
using System.Collections.Generic;
using System.Threading;
namespace Nuclex.Support.Scheduling {
/// <summary>Operation that executes a method in a background thread</summary>
public class ThreadCallbackOperation : ThreadOperation {
/// <summary>
/// Initializes a new threaded method operation that will call back a
/// parameterless method from the background thread.
/// </summary>
/// <param name="method">Method to be invoked in a background thread</param>
/// <remarks>
/// Uses a ThreadPool thread to execute the method in
/// </remarks>
public ThreadCallbackOperation(ThreadStart method)
: this(method, true) { }
/// <summary>
/// Initializes a new threaded method operation that will call back a
/// parameterless method from the background thread and use the
/// thread pool optionally.
/// </summary>
/// <param name="method">Method to be invoked in a background thread</param>
/// <param name="useThreadPool">Whether to use a ThreadPool thread</param>
/// <remarks>
/// If useThreadPool is false, a new thread will be created. This guarantees
/// that the method will be executed immediately but has an impact on
/// performance since the creation of new threads is not a cheap operation.
/// </remarks>
public ThreadCallbackOperation(ThreadStart method, bool useThreadPool)
: base(useThreadPool) {
this.method = method;
}
/// <summary>Executes the thread callback in the background thread</summary>
protected override void Execute() {
this.method();
}
/// <summary>Method to be invoked in a background thread</summary>
private ThreadStart method;
}
} // namespace Nuclex.Support.Scheduling