Class Worker

A worker which only has the intrinsic functionality inherited from WorkerBase<TDerived>, such as Start constraints and Grouping children.

If it runs, this worker will always complete with a Succeeded status. Use ActionWorker instead to complete with a failure or calculated status.

Common use cases:

Start constraintsUseful for concentrating multiple start constraints in one worker, e.g. to mark the end of one stage in the processing. Later stages can then reference this worker in their start constraints.
Grouping childrenUsed when adding children to a worker from either another worker, or from outside the worker system (typically before starting the worker system).

This class is sealed. WorkerBase is available to derive from.

Inheritance
Object
WorkerParent
WorkerBase
WorkerBase<Worker>
Worker
Implements
Inherited Members
Namespace: actionETL
Assembly: actionETL.dll
Syntax
public sealed class Worker : WorkerBase<Worker>, IDisposeOnFinished

Constructors

Worker(WorkerParent, String)

Initializes a new instance of Worker.

Declaration
public Worker(WorkerParent workerParent, string workerName)
Parameters
Type Name Description
WorkerParent workerParent

The parent worker or worker system that the new child worker will be added to. Cannot be null.
String workerName

Name of the worker.

Set to a prefix plus a trailing "/" (e.g. "MyPrefix-/") to generate a unique name from the prefix plus an increasing number starting at 1.

While less useful, set to null, whitespace or "/" to generate a unique name from the worker type plus an increasing number starting at 1.

The name cannot otherwise contain "/", and cannot start with double underscore "__".

Exceptions
Type Condition
ArgumentException

workerName:

  • Workers with the same parent must have unique names.
  • Worker and worker system names cannot contain '/' or start with double underscore '__'.
ArgumentNullException

workerParent - All workers must have a parent. The top level workers have the worker system as parent.
InvalidOperationException
  • Cannot add child worker to parent which has completed. Are you adding it to the correct parent?
  • Cannot add worker to parent, since its children have been started. Are you adding it to the correct parent?

Worker(WorkerParent, String, Func<Boolean>)

Initializes a new instance of Worker.

Declaration
public Worker(WorkerParent workerParent, string workerName, Func<bool> isStartableFunc)
Parameters
Type Name Description
WorkerParent workerParent

The parent worker or worker system that the new child worker will be added to. Cannot be null.
String workerName

Name of the worker.

Set to a prefix plus a trailing "/" (e.g. "MyPrefix-/") to generate a unique name from the prefix plus an increasing number starting at 1.

While less useful, set to null, whitespace or "/" to generate a unique name from the worker type plus an increasing number starting at 1.

The name cannot otherwise contain "/", and cannot start with double underscore "__".

Func<Boolean> isStartableFunc

Function to calculate the worker start constraint; it should return true for startable and false for not startable. Defaults to startable if null.
Exceptions
Type Condition
ArgumentException

workerName:

  • Workers with the same parent must have unique names.
  • Worker and worker system names cannot contain '/' or start with double underscore '__'.
ArgumentNullException

workerParent - All workers must have a parent. The top level workers have the worker system as parent.
InvalidOperationException
  • Cannot add child worker to parent which has completed. Are you adding it to the correct parent?
  • Cannot add worker to parent, since its children have been started. Are you adding it to the correct parent?

Methods

RunAsync()

For internal use.

Declaration
protected override Task<OutcomeStatus> RunAsync()
Returns
Type Description
Task<OutcomeStatus>
Overrides

Implements