reactor.core.publisher

Class WorkQueueProcessor.Builder<T>

java.lang.Object

reactor.core.publisher.WorkQueueProcessor.Builder<T>

Type Parameters:

T - Type of dispatched signal

Enclosing class:

WorkQueueProcessor<E>

public static final class WorkQueueProcessor.Builder<T>
extends Object

WorkQueueProcessor builder that can be used to create new processors. Instantiate it through the WorkQueueProcessor.builder() static method:

WorkQueueProcessor<String> processor = WorkQueueProcessor.<String>builder().build()

Method Summary

Modifier and Type	Method and Description
WorkQueueProcessor.Builder<T>	autoCancel(boolean autoCancel) Configures auto-cancel for this builder.
WorkQueueProcessor.Builder<T>	bufferSize(int bufferSize) Configures buffer size for this builder.
WorkQueueProcessor<T>	build() Creates a new WorkQueueProcessor using the properties of this builder.
WorkQueueProcessor.Builder<T>	executor(ExecutorService executor) Configures an ExecutorService to execute as many event-loop consuming the ringbuffer as subscribers.
WorkQueueProcessor.Builder<T>	name(String name) Configures name for this builder.
WorkQueueProcessor.Builder<T>	requestTaskExecutor(ExecutorService requestTaskExecutor) Configures an additional ExecutorService that is used internally on each subscription.
WorkQueueProcessor.Builder<T>	share(boolean share) Configures sharing state for this builder.
WorkQueueProcessor.Builder<T>	waitStrategy(WaitStrategy waitStrategy) Configures wait strategy for this builder.

Methods inherited from class java.lang.Object

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

Method Detail

name

public WorkQueueProcessor.Builder<T> name(@Nullable
                                          String name)

Configures name for this builder. Default value is WorkQueueProcessor. Name is push to default if the provided name is null.

Parameters:

name - Use a new cached ExecutorService and assign this name to the created threads if executor(ExecutorService) is not configured.

Returns:

builder with provided name

bufferSize

public WorkQueueProcessor.Builder<T> bufferSize(int bufferSize)

Configures buffer size for this builder. Default value is Queues.SMALL_BUFFER_SIZE.

Parameters:

bufferSize - the internal buffer size to hold signals, must be a power of 2

Returns:

builder with provided buffer size

waitStrategy

public WorkQueueProcessor.Builder<T> waitStrategy(@Nullable
                                                  WaitStrategy waitStrategy)

Configures wait strategy for this builder. Default value is WaitStrategy.liteBlocking(). Wait strategy is push to default if the provided waitStrategy is null.

Parameters:

waitStrategy - A RingBuffer WaitStrategy to use instead of the default smart blocking wait strategy.

Returns:

builder with provided wait strategy

autoCancel

public WorkQueueProcessor.Builder<T> autoCancel(boolean autoCancel)

Configures auto-cancel for this builder. Default value is true.

Parameters:

autoCancel - automatically cancel

Returns:

builder with provided auto-cancel

executor

public WorkQueueProcessor.Builder<T> executor(@Nullable
                                              ExecutorService executor)

Configures an ExecutorService to execute as many event-loop consuming the ringbuffer as subscribers. Name configured using name(String) will be ignored if executor is push.

Parameters:

executor - A provided ExecutorService to manage threading infrastructure

Returns:

builder with provided executor

requestTaskExecutor

public WorkQueueProcessor.Builder<T> requestTaskExecutor(@Nullable
                                                         ExecutorService requestTaskExecutor)

Configures an additional ExecutorService that is used internally on each subscription.

Parameters:

requestTaskExecutor - internal request executor

Returns:

builder with provided internal request executor

share

public WorkQueueProcessor.Builder<T> share(boolean share)

Configures sharing state for this builder. A shared Processor authorizes concurrent onNext calls and is suited for multi-threaded publisher that will fan-in data.

Parameters:

share - true to support concurrent onNext calls

Returns:

builder with specified sharing

build

public WorkQueueProcessor<T> build()

Creates a new WorkQueueProcessor using the properties of this builder.

Returns:

a fresh processor