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
System.Object
Network
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
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(DataFlowComponent[])

Declaration
    public Network(params DataFlowComponent[] startNodes)
Parameters
TypeNameDescription
DataFlowComponent[]startNodes

Properties

Destinations

Declaration
    public ICollection<IDataFlowDestination> Destinations { get; }
Property Value
TypeDescription
System.Collections.Generic.ICollection<IDataFlowDestination>

IncludeErrorDestinations

Declaration
    public bool IncludeErrorDestinations { get; set; }
Property Value
TypeDescription
System.Boolean

Sources

Declaration
    public ICollection<IDataFlowExecutableSource> Sources { get; }
Property Value
TypeDescription
System.Collections.Generic.ICollection<IDataFlowExecutableSource>

StartNodes

Declaration
    public ICollection<DataFlowComponent> StartNodes { get; set; }
Property Value
TypeDescription
System.Collections.Generic.ICollection<DataFlowComponent>

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(DataFlowComponent[])

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 DataFlowComponent[] startNodes)
Parameters
TypeNameDescription
DataFlowComponent[]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(DataFlowComponent[])

Will execute the data flow for the whole network synchronously.

Declaration
    public static void Execute(params DataFlowComponent[] startNodes)
Parameters
TypeNameDescription
DataFlowComponent[]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
TypeDescription
System.Threading.Tasks.Task

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

ExecuteAsync(DataFlowComponent[])

Will execute the data flow for the whole network asynchronously.

Declaration
    public static Task ExecuteAsync(params DataFlowComponent[] startNodes)
Parameters
TypeNameDescription
DataFlowComponent[]startNodes

At least one node in the network that should be executed

  • can by any node in the network
Returns
TypeDescription
System.Threading.Tasks.Task