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.
Inherited Members
Namespace: ETLBox.DataFlow
Assembly: ETLBox.dll
Syntax
public sealed class Network
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
public Network()
Network(params IDataFlowComponent[])
Declaration
public Network(params IDataFlowComponent[] startNodes)
Parameters
| Type | Name | Description |
|---|---|---|
| IDataFlowComponent[] | startNodes |
Properties
AllNodes
Declaration
public ICollection<IDataFlowComponent> AllNodes { get; }
Property Value
| Type | Description |
|---|---|
| ICollection<IDataFlowComponent> |
AlwaysRun
Declaration
public bool AlwaysRun { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Destinations
Declaration
public ICollection<IDataFlowDestination> Destinations { get; }
Property Value
| Type | Description |
|---|---|
| ICollection<IDataFlowDestination> |
Sources
Declaration
public ICollection<IDataFlowExecutableSource> Sources { get; }
Property Value
| Type | Description |
|---|---|
| ICollection<IDataFlowExecutableSource> |
StartNodes
Declaration
public ICollection<IDataFlowComponent> StartNodes { get; set; }
Property Value
| Type | Description |
|---|---|
| ICollection<IDataFlowComponent> |
Methods
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
public void Cancel()
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
public static void Cancel(params IDataFlowComponent[] startNodes)
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
public void Execute()
Execute(params IDataFlowComponent[])
Will execute the data flow for the whole network synchronously.
Declaration
public static void Execute(params IDataFlowComponent[] startNodes)
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
public void Execute(CancellationToken cancellationToken)
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
public static void Execute(CancellationToken cancellationToken, params IDataFlowComponent[] startNodes)
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
public Task ExecuteAsync()
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
public static Task ExecuteAsync(params IDataFlowComponent[] startNodes)
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
public Task ExecuteAsync(CancellationToken cancellationToken)
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
public static Task ExecuteAsync(CancellationToken cancellationToken, params IDataFlowComponent[] startNodes)
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 |