Class DataFlowComponent

The completion task of the component. A component is completed when all predecessors (if any) are completed and the current component has completed its buffer.

Declaration

{{< /rawhtml >}} ```C# public Task Completion { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
Task

ErrorCount

Declaration

{{< /rawhtml >}} ```C# public int ErrorCount { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
int

ErrorSource

The ErrorSource is the source block used for sending errors into the linked error flow.

Declaration

{{< /rawhtml >}} ```C# public ErrorSource ErrorSource { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
ErrorSource

Exception

If a component encountered an exception or entered a fault state because another component in the data flow faulted, the thrown exception will be stored in this property.

Declaration

{{< /rawhtml >}} ```C# public Exception Exception { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
Exception

ExecutionEndTime

Declaration

{{< /rawhtml >}} ```C# public DateTimeOffset? ExecutionEndTime { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
DateTimeOffset?

ExecutionStartTime

Declaration

{{< /rawhtml >}} ```C# public DateTimeOffset? ExecutionStartTime { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
DateTimeOffset?

IsReadyForProcessing

Indicates if a component was successfully initialized, linked and prepared for execution.

Declaration

{{< /rawhtml >}} ```C# public bool IsReadyForProcessing { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
bool

MaxBufferSize

Each component can have one or more buffers to improve throughput and allow faster processing of data. Set this value to restrict the number of rows that can be stored in the buffer. The default value is -1 (unlimited)

Declaration

{{< /rawhtml >}} ```C# public virtual int MaxBufferSize { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
int

OnCompletion

When a component has completed and processed all rows, the OnCompletion action is executed.

Declaration

{{< /rawhtml >}} ```C# public Action OnCompletion { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
Action

OnException

Declaration

{{< /rawhtml >}} ```C# public Action OnException { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
Action<Exception, string>

OnInitialization

Declaration

{{< /rawhtml >}} ```C# public Action OnInitialization { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
Action

OnProgress

This delegate is invoked each time the progress counter changes

Declaration

{{< /rawhtml >}} ```C# public Action OnProgress { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
Action<int>

Predecessors

All predecessors that are linked to this component.

Declaration

{{< /rawhtml >}} ```C# public List Predecessors { get; protected set; } ``` {{< rawhtml >}}

Property Value

Type	Description
List<DataFlowComponent>

ProgressCount

The amount of rows the current component has already processed.

Declaration

{{< /rawhtml >}} ```C# public int ProgressCount { get; protected set; } ``` {{< rawhtml >}}

Property Value

Type	Description
int

Successors

All successors that this component is linked to.

Declaration

{{< /rawhtml >}} ```C# public List Successors { get; protected set; } ``` {{< rawhtml >}}

Property Value

Type	Description
List<DataFlowComponent>

Tag

A tag that can be used to store any object in the component.

Declaration

{{< /rawhtml >}} ```C# public object Tag { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
object

Methods

AddComplementVoidLinkToOtherTargets(Func<Type, IDataFlowDestination>, Delegate)

Declaration

{{< /rawhtml >}} ```C# protected virtual void AddComplementVoidLinkToOtherTargets(Func createAutomaticVoidDestination, Delegate pred) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
Func<Type, IDataFlowDestination>	createAutomaticVoidDestination
Delegate	pred

CancelBufferAndThrowOperationCanceledException()

Declaration

{{< /rawhtml >}} ```C# protected void CancelBufferAndThrowOperationCanceledException() ``` {{< rawhtml >}}

CancelComponent()

Will cancel completion task for this component only. If you want to cancel the whole network, use Network.Cancel(..) instead

Declaration

{{< /rawhtml >}} ```C# public void CancelComponent() ``` {{< rawhtml >}}

CheckParameter()

Declaration

{{< /rawhtml >}} ```C# protected abstract void CheckParameter() ``` {{< rawhtml >}}

CleanUpOnFaulted(Exception)

Declaration

{{< /rawhtml >}} ```C# protected virtual void CleanUpOnFaulted(Exception e = null) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
Exception	e

CleanUpOnSuccess()

Declaration

{{< /rawhtml >}} ```C# protected virtual void CleanUpOnSuccess() ``` {{< rawhtml >}}

CompleteBuffer()

Declaration

{{< /rawhtml >}} ```C# protected abstract void CompleteBuffer() ``` {{< rawhtml >}}

CompleteOrFaultBufferOnPredecessorCompletion(Task)

Declaration

{{< /rawhtml >}} ```C# protected void CompleteOrFaultBufferOnPredecessorCompletion(Task WhenAllPredecessorCompletionTasks) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
Task	WhenAllPredecessorCompletionTasks

FaultBuffer(Exception)

Declaration

{{< /rawhtml >}} ```C# protected abstract void FaultBuffer(Exception e) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
Exception	e

InitBufferObjects(CancellationToken?)

Inits the underlying TPL.Dataflow buffer objects. After this, the component is ready for linking its source or target blocks. The initialization is done automatically when a network is executed.

Declaration

{{< /rawhtml >}} ```C# public void InitBufferObjects(CancellationToken? cancellationToken = null) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
CancellationToken?	cancellationToken	A cancellation token that is linked with the cancellation token of each buffer

InitCheckedParameter()

Declaration

{{< /rawhtml >}} ```C# protected virtual void InitCheckedParameter() ``` {{< rawhtml >}}

InitComponent()

Declaration

{{< /rawhtml >}} ```C# protected abstract void InitComponent() ``` {{< rawhtml >}}

InternalLinkErrorTo(IDataFlowDestination<ETLBoxError>)

Declaration

{{< /rawhtml >}} ```C# protected IDataFlowSource InternalLinkErrorTo(IDataFlowDestination target) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
IDataFlowDestination<ETLBoxError>	target

Returns

Type	Description
IDataFlowSource<ETLBoxError>

InternalLinkTo<T>(IDataFlowDestination, object, object)

Declaration

{{< /rawhtml >}} ```C# protected IDataFlowSource InternalLinkTo(IDataFlowDestination target, object predicate = null, object voidPredicate = null) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
IDataFlowDestination	target
object	predicate
object	voidPredicate

Returns

Type	Description
IDataFlowSource<T>

Type Parameters

Name	Description
T

LinkErrorTo(IDataFlowDestination<ETLBoxError>)

If an error occurs in the component, by default the component will throw an exception and stop execution. If you use the error linking, any erroneous records will be caught and redirected.

Declaration

{{< /rawhtml >}} ```C# public virtual IDataFlowSource LinkErrorTo(IDataFlowDestination target) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
IDataFlowDestination<ETLBoxError>	target	The target for erroneous rows.

Returns

Type	Description
IDataFlowSource<ETLBoxError>	The linked component.

LogProgressBatch_AfterThrowOrRedirectError(int)

Declaration

{{< /rawhtml >}} ```C# protected void LogProgressBatch_AfterThrowOrRedirectError(int rowsProcessed) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
int	rowsProcessed

LogProgress_AfterThrowOrRedirectError()

Declaration

{{< /rawhtml >}} ```C# protected void LogProgress_AfterThrowOrRedirectError() ``` {{< rawhtml >}}

LoggingFinishOnce()

Declaration

{{< /rawhtml >}} ```C# protected void LoggingFinishOnce() ``` {{< rawhtml >}}

LoggingStartOnce()

Declaration

{{< /rawhtml >}} ```C# protected void LoggingStartOnce() ``` {{< rawhtml >}}

PrepareParameterForCheck()

Declaration

{{< /rawhtml >}} ```C# protected virtual void PrepareParameterForCheck() ``` {{< rawhtml >}}

Reset()

Declaration

{{< /rawhtml >}} ```C# protected virtual void Reset() ``` {{< rawhtml >}}

ResetComponent()

Declaration

{{< /rawhtml >}} ```C# public void ResetComponent() ``` {{< rawhtml >}}

SetParentComponent(DataFlowComponent)

Will set another component as a parent component - only needed for constructing subflow inside data flow components.

Declaration

{{< /rawhtml >}} ```C# public void SetParentComponent(DataFlowComponent parent) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
DataFlowComponent	parent

ThrowErrorAndFaultNetwork(Exception, string)

Declaration

{{< /rawhtml >}} ```C# protected void ThrowErrorAndFaultNetwork(Exception e, string erroneousData) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
Exception	e
string	erroneousData

ThrowOrRedirectError(Exception, string, string)

Declaration

{{< /rawhtml >}} ```C# protected void ThrowOrRedirectError(Exception e, string erroneousData, string errorContext = null) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
Exception	e
string	erroneousData
string	errorContext

Implements

IDataFlowComponent

ILoggableTask