Class BackgroundTaskRunnerOptions
Provides options to the BackgroundTaskRunner<T> class.
Inheritance
Namespace: Umbraco.Web.Scheduling
Assembly: Umbraco.Web.dll
Syntax
public class BackgroundTaskRunnerOptions
Constructors
View SourceBackgroundTaskRunnerOptions()
Initializes a new instance of the BackgroundTaskRunnerOptions class.
Declaration
public BackgroundTaskRunnerOptions()
Properties
View SourceAutoStart
Gets or sets a value indicating whether the running task should start immediately or only once a task has been added to the queue.
Declaration
public bool AutoStart { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Hosted
Gets or sets a value indicating whether the runner should register with (and be stopped by) the hosting. Otherwise, something else should take care of stopping the runner. True by default.
Declaration
public bool Hosted { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
KeepAlive
Gets or sets a value indicating whether the running task should block and wait on the queue, or end, when the queue is empty.
Declaration
public bool KeepAlive { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
LongRunning
Gets or sets a value indicating whether the running task should be a long-running, coarse grained operation.
Declaration
public bool LongRunning { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
PreserveRunningTask
Gets or sets a value indicating whether the running task should be preserved once completed, or reset to null. For unit tests.
Declaration
public bool PreserveRunningTask { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |