Class PipelineBuilder

java.lang.Object

io.aleph0.yap.core.build.PipelineBuilder

public class PipelineBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
PipelineBuilder()

Method Summary

Modifier and Type	Method	Description
<InputT> ConsumerTaskBuilder<InputT,NoMetrics>	addConsumer(String id, ConsumerWorker<InputT> worker)	Add a consumer task to the pipeline.
<InputT, MetricsT> ConsumerTaskBuilder<InputT,MetricsT>	addConsumer(String id, ConsumerWorkerFactory<InputT,MetricsT> workerFactory)	Add a consumer task to the pipeline.
<InputT, MetricsT> ConsumerTaskBuilder<InputT,MetricsT>	addConsumer(String id, MeasuredConsumerWorker<InputT,MetricsT> worker)	Add a consumer task to the pipeline.
PipelineBuilder	addLifecycleListener(Pipeline.LifecycleListener listener)
<InputT, OutputT> ProcessorTaskBuilder<InputT,OutputT,NoMetrics>	addProcessor(String id, ProcessorWorker<InputT,OutputT> worker)	Add a processor task to the pipeline.
<InputT, OutputT, MetricsT> ProcessorTaskBuilder<InputT,OutputT,MetricsT>	addProcessor(String id, MeasuredProcessorWorker<InputT,OutputT,MetricsT> worker)	Add a processor task to the pipeline.
<InputT, OutputT, MetricsT> ProcessorTaskBuilder<InputT,OutputT,MetricsT>	addProcessor(String id, ProcessorWorkerFactory<InputT,OutputT,MetricsT> workerFactory)	Add a processor task to the pipeline.
<OutputT> ProducerTaskBuilder<OutputT,NoMetrics>	addProducer(String id, ProducerWorker<OutputT> worker)	Add a producer task to the pipeline.
<OutputT, MetricsT> ProducerTaskBuilder<OutputT,MetricsT>	addProducer(String id, MeasuredProducerWorker<OutputT,MetricsT> worker)	Add a producer task to the pipeline.
<OutputT, MetricsT> ProducerTaskBuilder<OutputT,MetricsT>	addProducer(String id, ProducerWorkerFactory<OutputT,MetricsT> workerFactory)	Add a producer task to the pipeline.
PipelineBuilder	addWrapper(PipelineWrapper wrapper)
Pipeline	build()
Pipeline	buildAndStart()
CompletableFuture<Void>	buildAndStartAsCompletableFuture()
Future<?>	buildAndStartAsFuture()
static ExecutorService	defaultPlatformThreadExecutorService()	A reasonable ExecutorService for running pipeline tasks using platform threads.
static ExecutorService	defaultVirtualThreadExecutorService()	A reasonable ExecutorService for running pipeline tasks using virtual threads.
PipelineBuilder	setExecutor(ExecutorService executor)
PipelineBuilder	setPipelineController(PipelineControllerBuilder controller)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PipelineBuilder

public PipelineBuilder()

Method Details

defaultVirtualThreadExecutorService

public static ExecutorService defaultVirtualThreadExecutorService()

A reasonable ExecutorService for running pipeline tasks using virtual threads. This will cause each thread to run in its own virtual thread.

This is the default for all new PipelineBuilder instances.

defaultPlatformThreadExecutorService

public static ExecutorService defaultPlatformThreadExecutorService()

A reasonable ExecutorService for running pipeline tasks using platform threads. This will cause each thread to run in its own platform thread.

This service has the benefit of naming individual threads reasonably, which allows for easier debugging and profiling.

setExecutor

public PipelineBuilder setExecutor(ExecutorService executor)

setPipelineController

public PipelineBuilder setPipelineController(PipelineControllerBuilder controller)

addProducer

public <OutputT>
ProducerTaskBuilder<OutputT,NoMetrics> addProducer(String id,
 ProducerWorker<OutputT> worker)

Add a producer task to the pipeline. The producer task will only support a single worker, which is the given worker. If the TaskController attempts to scale the task beyond one worker, then the task will fail with an IllegalStateException.

Type Parameters:

OutputT - the type of the producer's output

Parameters:

id - the task ID

worker - the producer worker

Returns:

a ProducerTaskBuilder to configure the producer task

See Also:

• addProducer(String, MeasuredProducerWorker)

addProducer

public <OutputT,
MetricsT>
ProducerTaskBuilder<OutputT,MetricsT> addProducer(String id,
 MeasuredProducerWorker<OutputT,MetricsT> worker)

Add a producer task to the pipeline. The producer task will only support a single worker, which is the given worker. If the TaskController attempts to scale the task beyond one worker, then the task will fail with an IllegalStateException.

Type Parameters:

OutputT - the type of the producer's output

MetricsT - the type of the producer's metrics

Parameters:

id - the task ID

worker - the producer worker

Returns:

a ProducerTaskBuilder to configure the producer task

See Also:

• SingletonProducerWorkerFactory

addProducer

public <OutputT,
MetricsT>
ProducerTaskBuilder<OutputT,MetricsT> addProducer(String id,
 ProducerWorkerFactory<OutputT,MetricsT> workerFactory)

Add a producer task to the pipeline. The given workerFactory will be used to create new workers for the task as requested by the TaskController.

Type Parameters:

OutputT - the type of the producer's output

MetricsT - the type of the producer's metrics

Parameters:

id - the task ID

workerFactory - the producer worker factory

Returns:

a ProducerTaskBuilder to configure the producer task

See Also:

• ProducerTaskBuilder.setController(ProducerTaskControllerBuilder)
• DefaultProducerTaskController.builder()

addProcessor

public <InputT,
OutputT>
ProcessorTaskBuilder<InputT,OutputT,NoMetrics> addProcessor(String id,
 ProcessorWorker<InputT,OutputT> worker)

Add a processor task to the pipeline. The processor task will only support a single worker, which is the given worker. If the TaskController attempts to scale the task beyond one worker, then the task will fail with an IllegalStateException.

Type Parameters:

InputT - the type of the processor's input

OutputT - the type of the processor's output

Parameters:

id - the task ID

worker - the processor worker

Returns:

a ProcessorTaskBuilder to configure the processor task

See Also:

• addProcessor(String, MeasuredProcessorWorker)

addProcessor

public <InputT,
OutputT,
MetricsT>
ProcessorTaskBuilder<InputT,OutputT,MetricsT> addProcessor(String id,
 MeasuredProcessorWorker<InputT,OutputT,MetricsT> worker)

Add a processor task to the pipeline. The processor task will only support a single worker, which is the given worker. If the TaskController attempts to scale the task beyond one worker, then the task will fail with an IllegalStateException.

Type Parameters:

InputT - the type of the processor's input

OutputT - the type of the processor's output

MetricsT - the type of the processor's metrics

Parameters:

id - the task ID

worker - the processor worker

Returns:

a ProcessorTaskBuilder to configure the processor task

See Also:

• SingletonProcessorWorkerFactory

addProcessor

public <InputT,
OutputT,
MetricsT>
ProcessorTaskBuilder<InputT,OutputT,MetricsT> addProcessor(String id,
 ProcessorWorkerFactory<InputT,OutputT,MetricsT> workerFactory)

Add a processor task to the pipeline. The given workerFactory will be used to create new workers for the task as requested by the TaskController.

Type Parameters:

InputT - the type of the processor's input

OutputT - the type of the processor's output

MetricsT - the type of the processor's metrics

Parameters:

id - the task ID

workerFactory - the processor worker factory

Returns:

a ProcessorTaskBuilder to configure the processor task

See Also:

• ProcessorTaskBuilder.setController(ProcessorTaskControllerBuilder)
• DefaultProcessorTaskController.builder()

addConsumer

public <InputT>
ConsumerTaskBuilder<InputT,NoMetrics> addConsumer(String id,
 ConsumerWorker<InputT> worker)

Add a consumer task to the pipeline. The consumer task will only support a single worker, which is the given worker. If the TaskController attempts to scale the task beyond one worker, then the task will fail with an IllegalStateException.

Type Parameters:

InputT - the type of the consumer's input

Parameters:

id - the task ID

worker - the consumer worker

Returns:

a ConsumerTaskBuilder to configure the consumer task

See Also:

• addConsumer(String, MeasuredConsumerWorker)

addConsumer

public <InputT,
MetricsT>
ConsumerTaskBuilder<InputT,MetricsT> addConsumer(String id,
 MeasuredConsumerWorker<InputT,MetricsT> worker)

Add a consumer task to the pipeline. The consumer task will only support a single worker, which is the given worker. If the TaskController attempts to scale the task beyond one worker, then the task will fail with an IllegalStateException.

Type Parameters:

InputT - the type of the consumer's input

MetricsT - the type of the consumer's metrics

Parameters:

id - the task ID

worker - the consumer worker

Returns:

a ConsumerTaskBuilder to configure the consumer task

See Also:

• SingletonConsumerWorkerFactory

addConsumer

public <InputT,
MetricsT>
ConsumerTaskBuilder<InputT,MetricsT> addConsumer(String id,
 ConsumerWorkerFactory<InputT,MetricsT> workerFactory)

Add a consumer task to the pipeline. The given workerFactory will be used to create new workers for the task as requested by the TaskController.

Type Parameters:

InputT - the type of the consumer's input

MetricsT - the type of the consumer's metrics

Parameters:

id - the task ID

workerFactory - the consumer worker factory

Returns:

a ConsumerTaskBuilder to configure the consumer task

See Also:

• ConsumerTaskBuilder.setController(TaskControllerBuilder)
• DefaultConsumerTaskController.builder()

addWrapper

public PipelineBuilder addWrapper(PipelineWrapper wrapper)

addLifecycleListener

public PipelineBuilder addLifecycleListener(Pipeline.LifecycleListener listener)

build

public Pipeline build()

buildAndStart

public Pipeline buildAndStart()

buildAndStartAsFuture

public Future<?> buildAndStartAsFuture()

buildAndStartAsCompletableFuture

public CompletableFuture<Void> buildAndStartAsCompletableFuture()