Search Results for

    Show / Hide Table of Contents

    Class PortPassThroughTarget<TInputOutput>

    A dataflow worker that passes rows from the Input port on this worker, to an output port on a downstream worker (normally residing under a different parent compared to this worker). This is mainly used when encapsulating a child dataflow worker with an output port (i.e. a source or transform) inside a parent dataflow worker, and passing the child output rows to the parent output port. This allows using dataflow (and other) workers as building blocks when creating new dataflow workers.

    The parent worker can have any number of input and output ports, as well as any number of child workers, and would add a PortPassThroughSource<TOutput> for each port to pass from parent to child worker, and a PortPassThroughTarget for each port to pass from child to parent worker. Use both PortPassThroughSource and PortPassThroughTarget to create a parent transform.

    Note that the parent must await the completion of the PortPassThroughTarget worker before it itself completes, otherwise the parent output port will not have completed and will raise an exception.

    Please also see the Compose Source with Pass-through example.

    Inheritance
    Object
    WorkerParent
    WorkerBase
    WorkerBase<PortPassThroughTarget<TInputOutput>>
    PortPassThroughTarget<TInputOutput>
    Implements
    IDisposeOnFinished
    Inherited Members
    WorkerBase<PortPassThroughTarget<TInputOutput>>.AddCompletedCallback(Func<PortPassThroughTarget<TInputOutput>, OutcomeStatus, Task<OutcomeStatus>>)
    WorkerBase<PortPassThroughTarget<TInputOutput>>.AddRanCallback(Func<PortPassThroughTarget<TInputOutput>, OutcomeStatus, WorkerParentChildrenState, Task<OutcomeStatus>>)
    WorkerBase<PortPassThroughTarget<TInputOutput>>.AddStartingCallback(Func<PortPassThroughTarget<TInputOutput>, Task<ProgressStatus>>)
    WorkerBase.AddCompletedCallback(Func<WorkerBase, OutcomeStatus, Task<OutcomeStatus>>)
    WorkerBase.AddRanCallback(Func<WorkerBase, OutcomeStatus, WorkerParentChildrenState, Task<OutcomeStatus>>)
    WorkerBase.AddStartingCallback(Func<WorkerBase, Task<ProgressStatus>>)
    WorkerBase.DefaultIsStartable()
    WorkerBase.ErroredPortErrorsWorkerProtected
    WorkerBase.ErrorOutputs
    WorkerBase.EscalateError
    WorkerBase.Inputs
    WorkerBase.IsStartable
    WorkerBase.Outputs
    WorkerBase.Parent
    WorkerBase.SucceededSequence<TLastWorker>(WorkerBase, WorkerBase, WorkerBase, WorkerBase, WorkerBase, TLastWorker)
    WorkerBase.SucceededSequence<TLastWorker>(WorkerBase, WorkerBase, WorkerBase, WorkerBase, TLastWorker)
    WorkerBase.SucceededSequence<TLastWorker>(WorkerBase, WorkerBase, WorkerBase, TLastWorker)
    WorkerBase.SucceededSequence<TLastWorker>(WorkerBase, WorkerBase, TLastWorker)
    WorkerBase.SucceededSequence<TLastWorker>(WorkerBase, TLastWorker)
    WorkerBase.SucceededSequence<TLastWorker>(TLastWorker)
    WorkerParent.AddChildCompletedCallback(Action<WorkerBase>)
    WorkerParent.AddStartingChildrenCallback(Func<WorkerParent, Task<ProgressStatus>>)
    WorkerParent.Children
    WorkerParent.DisposeOnFinished<TDisposable>(TDisposable)
    WorkerParent.GetDownstreamFactory<TInput>()
    WorkerParent.HasChildren
    WorkerParent.IsCanceled
    WorkerParent.IsCompleted
    WorkerParent.IsCreated
    WorkerParent.IsError
    WorkerParent.IsFailed
    WorkerParent.IsFatal
    WorkerParent.IsRunning
    WorkerParent.IsSucceeded
    WorkerParent.KeepChildrenLevels
    WorkerParent.Locator
    WorkerParent.LogFactory
    WorkerParent.Logger
    WorkerParent.MaxRunningChildren
    WorkerParent.Name
    WorkerParent.RemoveChildren()
    WorkerParent.RescheduleChildren()
    WorkerParent.RunChildrenAsync(Boolean)
    WorkerParent.RunChildrenAsync()
    WorkerParent.Status
    WorkerParent.Item[String]
    WorkerParent.ToString()
    WorkerParent.WorkerSystem
    WorkerParent.DebugCommands
    WorkerParent.AggregateErrorOutputRows
    WorkerParent.AggregateOutputRows
    WorkerParent.AggregateWorkersCompleted
    WorkerParent.InstantCompleted
    WorkerParent.InstantCreated
    WorkerParent.InstantStarted
    WorkerParent.RunningDuration
    Namespace: actionETL
    Assembly: actionETL.dll
    Syntax
    public class PortPassThroughTarget<TInputOutput> : WorkerBase<PortPassThroughTarget<TInputOutput>>, IDisposeOnFinished where TInputOutput : class
    Type Parameters
    Name Description
    TInputOutput

    The type of the input and output rows.

    Properties

    Input

    Gets the input port for receiving rows from an upstream worker.

    Declaration
    public InputPort<TInputOutput> Input { get; }
    Property Value
    Type Description
    InputPort<TInputOutput>

    PassThroughOutput

    Gets or sets the output port to send rows to.

    Declaration
    public OutputPort<TInputOutput> PassThroughOutput { get; set; }
    Property Value
    Type Description
    OutputPort<TInputOutput>

    The pass-through output port.

    Methods

    RunAsync()

    This method can be overridden to add custom functionality to the derived worker that runs before and after the main processing. In this case, the base class base.RunAsync() must be called for the worker to function correctly.

    Typically, this worker is used without overriding this method.

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

    A Task describing the success or failure of the worker. An asynchronous async implementation would e.g. return OutcomeStatus.Succeeded on success, while a synchronous implementation would return OutcomeStatus.SucceededTask.

    Overrides
    WorkerParent.RunAsync()

    Implements

    IDisposeOnFinished

    See Also

    PortPassThroughTargetFactory
    In This Article
    Back to top Copyright © 2021 Envobi Ltd