Class Network

The network class allows you execute, monitor and cancel data flows. You need to provide at least one start node to run the network. All other linked components will be retrieved automatically. If you provide more nodes, the algorithm will determine if a network has already started or not and ignore the other nodes. It is recommend to pass only one node from the network.

Inheritance

object

Network

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: ETLBox.DataFlow

Assembly: ETLBox.dll

Syntax

{{< /rawhtml >}} ```C# public sealed class Network ``` {{< rawhtml >}}

Examples

Network.Execute(source1); 
Network.Execute(source1, source2); //If source1 and source2 are in the same network, providing source2 is superflous
Task t = Network.ExecuteAsync(dest1);
t.Wait();

Constructors

Network()

Declaration

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

Network(params IDataFlowComponent[])

Declaration

{{< /rawhtml >}} ```C# public Network(params IDataFlowComponent[] startNodes) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
IDataFlowComponent[]	startNodes

Properties

AllNodes

Declaration

{{< /rawhtml >}} ```C# public ReadOnlyCollection AllNodes { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
ReadOnlyCollection<IDataFlowComponent>

AllowMultipleExecutions

Declaration

{{< /rawhtml >}} ```C# public bool? AllowMultipleExecutions { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
bool?

Destinations

Declaration

{{< /rawhtml >}} ```C# public ReadOnlyCollection Destinations { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
ReadOnlyCollection<IDataFlowDestination>

IgnoreUnlinkedNodes

Declaration

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

Property Value

Type	Description
bool

OnCompletion

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

Sources

Declaration

{{< /rawhtml >}} ```C# public ReadOnlyCollection Sources { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
ReadOnlyCollection<IDataFlowExecutableSource>

StartNodes

Declaration

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

Property Value

Type	Description
ICollection<IDataFlowComponent>

TryAddComplementVoidLinks

Declaration

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

Property Value

Type	Description
bool

Methods

AddComplementVoidLinks()

Declaration

{{< /rawhtml >}} ```C# public Network AddComplementVoidLinks() ``` {{< rawhtml >}}

Returns

Type	Description
Network

ApplyToAllNodes(Action<IDataFlowComponent>)

Will apply the given action on all nodes in the network.

Declaration

{{< /rawhtml >}} ```C# public Network ApplyToAllNodes(Action onNode) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
Action<IDataFlowComponent>	onNode	An action that is performed on each node.

Returns

Type	Description
Network	The current Network instance.

Cancel()

Cancel the BufferCompletion(s) on all nodes in the network, will start cancelation from the sources. This will result in all nodes canceled in the whole network.

Declaration

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

Cancel(params IDataFlowComponent[])

Cancel the BufferCompletion(s) on all nodes in the network, will start cancelation from the sources. This will result in all nodes canceled in the whole network.

Declaration

{{< /rawhtml >}} ```C# public static void Cancel(params IDataFlowComponent[] startNodes) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
IDataFlowComponent[]	startNodes	The start nodes - only one node in the whole network is sufficient

Execute()

Will execute the data flow for the whole network synchronously. The network is derived from the given StartNodes (only one node of the network is needed)

Declaration

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

Execute(params IDataFlowComponent[])

Will execute the data flow for the whole network synchronously.

Declaration

{{< /rawhtml >}} ```C# public static void Execute(params IDataFlowComponent[] startNodes) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
IDataFlowComponent[]	startNodes	At least one node in the network that should be executed - can by any node in the network

Execute(CancellationToken)

Will execute the data flow for the whole network synchronously. The network is derived from the given StartNodes (only one node of the network is needed)

Declaration

{{< /rawhtml >}} ```C# public void Execute(CancellationToken cancellationToken) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the whole network when still running

Execute(CancellationToken, params IDataFlowComponent[])

Will execute the data flow for the whole network synchronously.

Declaration

{{< /rawhtml >}} ```C# public static void Execute(CancellationToken cancellationToken, params IDataFlowComponent[] startNodes) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A cancellation token which cancels the whole network when still running
IDataFlowComponent[]	startNodes	At least one node in the network that should be executed - can by any node in the network

ExecuteAsync()

Will execute the data flow for the whole network asynchronously. The network is derived from the given StartNodes (only one node of the network is needed)

Declaration

{{< /rawhtml >}} ```C# public Task ExecuteAsync() ``` {{< rawhtml >}}

Returns

Type	Description
Task	A task that is ran to completion when the whole network is completed.

ExecuteAsync(params IDataFlowComponent[])

Will execute the data flow for the whole network asynchronously.

Declaration

{{< /rawhtml >}} ```C# public static Task ExecuteAsync(params IDataFlowComponent[] startNodes) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
IDataFlowComponent[]	startNodes	At least one node in the network that should be executed - can by any node in the network

Returns

Type	Description
Task

ExecuteAsync(CancellationToken)

Will execute the data flow for the whole network asynchronously. The network is derived from the given StartNodes (only one node of the network is needed)

Declaration

{{< /rawhtml >}} ```C# public Task ExecuteAsync(CancellationToken cancellationToken) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A cancellation token to cancel the whole network when running

Returns

Type	Description
Task	A task that is ran to completion when the whole network is completed.

ExecuteAsync(CancellationToken, params IDataFlowComponent[])

Will execute the data flow for the whole network asynchronously.

Declaration

{{< /rawhtml >}} ```C# public static Task ExecuteAsync(CancellationToken cancellationToken, params IDataFlowComponent[] startNodes) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A cancellation token which cancels the whole network when still running
IDataFlowComponent[]	startNodes	At least one node in the network that should be executed - can by any node in the network

Returns

Type	Description
Task

Init()

Declaration

{{< /rawhtml >}} ```C# public static Network Init() ``` {{< rawhtml >}}

Returns

Type	Description
Network

Init(params IDataFlowComponent[])

Creates a new network with the given start nodes.

Declaration

{{< /rawhtml >}} ```C# public static Network Init(params IDataFlowComponent[] startNodes) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
IDataFlowComponent[]	startNodes	At least one or more nodes from the network. Connected nodes will be automatically collected.

Returns

Type	Description
Network	A new Network instance.

InitAndStartWith<T>(IDataFlowSource<T>)

Declaration

{{< /rawhtml >}} ```C# public static Network InitAndStartWith(IDataFlowSource source) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
IDataFlowSource<T>	source

Returns

Type	Description
Network

Type Parameters

Name	Description
T

LinkAllErrorTo(IDataFlowDestination<ETLBoxError>)

Declaration

{{< /rawhtml >}} ```C# public Network LinkAllErrorTo(IDataFlowDestination errorDestination) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
IDataFlowDestination<ETLBoxError>	errorDestination

Returns

Type	Description
Network

LinkTo<T>(IDataFlowDestination<T>)

Declaration

{{< /rawhtml >}} ```C# public Network LinkTo(IDataFlowDestination destination) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
IDataFlowDestination<T>	destination

Returns

Type	Description
Network

Type Parameters

Name	Description
T

ParallelExecute(params Network[])

Allows to execute multiple networks in parallel.

Declaration

{{< /rawhtml >}} ```C# public static Task ParallelExecute(params Network[] networks) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
Network[]	networks	Network that should run in parallel

Returns

Type	Description
Task	An awaitable task that completes when all networks are execute successfully.

PrintAsJson()

Declaration

{{< /rawhtml >}} ```C# public string PrintAsJson() ``` {{< rawhtml >}}

Returns

Type	Description
string

PrintAsJson(Func<DataFlowComponent, Dictionary<string, object>>)

Prints the network as a json string.

Declaration

{{< /rawhtml >}} ```C# public string PrintAsJson(Func> propertyExtraction) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
Func<DataFlowComponent, Dictionary<string, object>>	propertyExtraction

Returns

Type	Description
string

PrintAsNodes()

Declaration

{{< /rawhtml >}} ```C# public NetworkNode PrintAsNodes() ``` {{< rawhtml >}}

Returns

Type	Description
NetworkNode

PrintAsNodes(Func<DataFlowComponent, Dictionary<string, object>>)

Create a representation of the network using NetworkNode objects.

Declaration

{{< /rawhtml >}} ```C# public NetworkNode PrintAsNodes(Func> propertyExtraction) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
Func<DataFlowComponent, Dictionary<string, object>>	propertyExtraction

Returns

Type	Description
NetworkNode	The current network using NetworkNode objects

SetLogInstance(ILogger)

Declaration

{{< /rawhtml >}} ```C# public Network SetLogInstance(ILogger logger) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
ILogger	logger

Returns

Type	Description
Network

StartWith<T>(IDataFlowSource<T>)

Declaration

{{< /rawhtml >}} ```C# public Network StartWith(IDataFlowSource source) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
IDataFlowSource<T>	source

Returns

Type	Description
Network

Type Parameters

Name	Description
T