51Degrees Pipeline .NET  4.1

51Degrees Pipeline for .NET

FiftyOne.Pipeline.Engines.FlowElements.PrePackagedPipelineBuilderBase< TBuilder > Class Template Reference

Detailed Description

Base class for pipeline builders that will produce a pipeline with specific flow elements.

Template Parameters
TBuilder -
Type Constraints
TBuilder :PrePackagedPipelineBuilderBase<TBuilder> 

Inheritance diagram for FiftyOne.Pipeline.Engines.FlowElements.PrePackagedPipelineBuilderBase< TBuilder >:

[legend]

Collaboration diagram for FiftyOne.Pipeline.Engines.FlowElements.PrePackagedPipelineBuilderBase< TBuilder >:

[legend]

Public Member Functions

 PrePackagedPipelineBuilderBase (ILoggerFactory loggerFactory)
Constructor More...
TBuilder  UseLazyLoading ()
Enable lazy loading of results. More...
TBuilder  UseLazyLoading (int timeoutMilliseconds)
Enable lazy loading of results. More...
TBuilder  UseLazyLoading (TimeSpan timeout)
Enable lazy loading of results. More...
TBuilder  UseLazyLoading (CancellationToken cancellationToken)
Enable lazy loading of results. More...
TBuilder  UseLazyLoading (TimeSpan timeout, CancellationToken cancellationToken)
Enable lazy loading of results. More...
TBuilder  UseResultsCache ()
Enable caching of results. More...
TBuilder  UseResultsCache (int size)
Enable caching of results. More...

Public Member Functions inherited from FiftyOne.Pipeline.Core.FlowElements.PipelineBuilderBase< TBuilder >

 PipelineBuilderBase (ILoggerFactory loggerFactory)
Create a new PipelineBuilderBase<T> instance. More...
virtual IPipeline  Build ()
Build the pipeline More...
T  AddFlowElement (IFlowElement element)
Add the specified IFlowElement to the pipeline. More...
T  AddFlowElementsParallel (params IFlowElement[] elements)
Add the specified IFlowElement array to the pipeline. More...
T  SetAutoDisposeElements (bool autoDispose)
Configure the Pipeline to either call dispose on it's child FlowElements when it is disposed or not. More...
T  SetSuppressProcessException (bool suppressExceptions)
Configure the Pipeline to either suppress exceptions added to IFlowData.Errors during processing or to throw them as an aggregate exception once processing is complete. More...

Properties

bool  LazyLoading = false [get, set]
True if lazy loading is enabled for the relevant engine(s). More...
bool  ResultsCache = false [get, set]
True if a results cache should be added to the relevant engine(s). More...
TimeSpan  LazyLoadingTimeout = TimeSpan.FromSeconds(5) [get, set]
The timeout to be used by the lazy loading feature. More...
CancellationToken  LazyLoadingCancellationToken = default(CancellationToken) [get, set]
The cancellation token to be used by the lazy loading feature. More...
int  ResultsCacheSize = 1000 [get, set]
The cache size to use for the results cache More...

Properties inherited from FiftyOne.Pipeline.Core.FlowElements.PipelineBuilderBase< TBuilder >

List< IFlowElement >  FlowElements [get]
The elements to be added to the pipeline More...
ILogger< T >  Logger [get]
Logger More...
ILoggerFactory  LoggerFactory [get]
A factory used to create logger instances. More...

Constructor & Destructor Documentation

Member Function Documentation

◆ UseLazyLoading() [4/5]

TBuilder FiftyOne.Pipeline.Engines.FlowElements.PrePackagedPipelineBuilderBase< TBuilder >.UseLazyLoading ( CancellationToken   cancellationToken )

Enable lazy loading of results.

Uses a default timeout of 5 seconds.

Parameters
cancellationToken - The cancellation token to observe while attempting to access lazy-loaded values.
Returns
This builder instance.

◆ UseLazyLoading() [5/5]

TBuilder FiftyOne.Pipeline.Engines.FlowElements.PrePackagedPipelineBuilderBase< TBuilder >.UseLazyLoading ( TimeSpan   timeout,
CancellationToken   cancellationToken  
)

Enable lazy loading of results.

Parameters
timeout - The timeout to use when attempting to access lazy-loaded values. Default is 5 seconds.
cancellationToken - The cancellation token to observe while attempting to access lazy-loaded values.
Returns
This builder instance.

Property Documentation