Package io.servicetalk.concurrent.api

Class Processors

java.lang.Object

io.servicetalk.concurrent.api.Processors

public final class Processors
extends Object

Static factory methods for creating processor instances for different type of sources. A processor is both a producer and a consumer of data.

Method Summary

Modifier and Type	Method	Description
static <T> BlockingIterable.Processor<T>	newBlockingIterableProcessor()	Create a new BlockingIterable.Processor.
static <T> BlockingIterable.Processor<T>	newBlockingIterableProcessor(int maxBufferSize)	Create a new BlockingIterable.Processor.
static <T> BlockingIterable.Processor<T>	newBlockingIterableProcessor(BlockingProcessorSignalsHolder<T> holder)	Create a new BlockingIterable.Processor.
static CompletableSource.Processor	newCompletableProcessor()	Create a new CompletableSource.Processor that allows for multiple subscribes.
static <T> PublisherSource.Processor<T,T>	newPublisherProcessor()	Create a new PublisherSource.Processor that allows for a single subscribe.
static <T> PublisherSource.Processor<T,T>	newPublisherProcessor(int maxBuffer)	Create a new PublisherSource.Processor that allows for a single subscribe.
static <T> PublisherSource.Processor<T,T>	newPublisherProcessor(PublisherProcessorSignalsHolder<T> holder)	Create a new PublisherSource.Processor that allows for a single subscribe.
static <T> PublisherSource.Processor<T,T>	newPublisherProcessorDropHeadOnOverflow(int maxBuffer)	Create a new PublisherSource.Processor that allows for a single subscribe.
static <T> PublisherSource.Processor<T,T>	newPublisherProcessorDropTailOnOverflow(int maxBuffer)	Create a new PublisherSource.Processor that allows for a single subscribe.
static <T> SingleSource.Processor<T,T>	newSingleProcessor()	Create a new SingleSource.Processor that allows for multiple subscribes.

Methods inherited from class java.lang.Object

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

Method Details

newCompletableProcessor

public static CompletableSource.Processor newCompletableProcessor()

Create a new CompletableSource.Processor that allows for multiple subscribes. The returned CompletableSource.Processor provides all the expected API guarantees when used as a CompletableSource but does not expect the same guarantees when used as a CompletableSource.Subscriber. As an example, users are not expected to call CompletableSource.Subscriber.onSubscribe(Cancellable) or they can call any of the CompletableSource.Subscriber methods concurrently and/or multiple times.

Returns:

a new CompletableSource.Processor that allows for multiple subscribes.

newSingleProcessor

public static <T> SingleSource.Processor<T,T> newSingleProcessor()

Create a new SingleSource.Processor that allows for multiple subscribes. The returned SingleSource.Processor provides all the expected API guarantees when used as a SingleSource but does not expect the same guarantees when used as a SingleSource.Subscriber. As an example, users are not expected to call SingleSource.Subscriber.onSubscribe(Cancellable) or they can call any of the SingleSource.Subscriber methods concurrently and/or multiple times.

Type Parameters:

T - The SingleSource type and SingleSource.Subscriber type of the SingleSource.Processor.

Returns:

a new SingleSource.Processor that allows for multiple subscribes.

newPublisherProcessor

public static <T> PublisherSource.Processor<T,T> newPublisherProcessor()

Create a new PublisherSource.Processor that allows for a single subscribe. The returned PublisherSource.Processor provides all the expected API guarantees when used as a PublisherSource but does not expect the same guarantees when used as a PublisherSource.Subscriber. As an example, users are not expected to call PublisherSource.Subscriber.onSubscribe(Subscription) or they can call any of the PublisherSource.Subscriber methods concurrently and/or multiple times.

The returned may choose a default strategy to handle the cases when more items are added through PublisherSource.Subscriber.onNext(Object) without being delivered to its PublisherSource.Subscriber. Use other methods here if a specific strategy is required.

Type Parameters:

T - The PublisherSource type and PublisherSource.Subscriber type of the PublisherSource.Processor.

Returns:

a new PublisherSource.Processor that allows for a single subscribe.

See Also:

• newPublisherProcessor(int)
• newPublisherProcessor(PublisherProcessorSignalsHolder)

newPublisherProcessor

public static <T> PublisherSource.Processor<T,T> newPublisherProcessor(int maxBuffer)

Create a new PublisherSource.Processor that allows for a single subscribe. The returned PublisherSource.Processor provides all the expected API guarantees when used as a PublisherSource but does not expect the same guarantees when used as a PublisherSource.Subscriber. As an example, users are not expected to call PublisherSource.Subscriber.onSubscribe(Subscription) or they can call any of the PublisherSource.Subscriber methods concurrently and/or multiple times.

Only allows for maxBuffer number of items to be added through PublisherSource.Subscriber.onNext(Object) without being delivered to its PublisherSource.Subscriber. If more items are added without being delivered, subsequent additions will fail.

Type Parameters:

T - The PublisherSource type and PublisherSource.Subscriber type of the PublisherSource.Processor.

Parameters:

maxBuffer - Maximum number of items to buffer.

Returns:

a new PublisherSource.Processor that allows for a single subscribe.

newPublisherProcessorDropHeadOnOverflow

public static <T> PublisherSource.Processor<T,T> newPublisherProcessorDropHeadOnOverflow(int maxBuffer)

Create a new PublisherSource.Processor that allows for a single subscribe. The returned PublisherSource.Processor provides all the expected API guarantees when used as a PublisherSource but does not expect the same guarantees when used as a PublisherSource.Subscriber. As an example, users are not expected to call PublisherSource.Subscriber.onSubscribe(Subscription) or they can call any of the PublisherSource.Subscriber methods concurrently and/or multiple times.

Only allows for maxBuffer number of items to be added through PublisherSource.Subscriber.onNext(Object) without being delivered to its PublisherSource.Subscriber. If more items are added without being delivered, the oldest buffered item (head) will be dropped.

Type Parameters:

T - The PublisherSource type and PublisherSource.Subscriber type of the PublisherSource.Processor.

Parameters:

maxBuffer - Maximum number of items to buffer.

Returns:

a new PublisherSource.Processor that allows for a single subscribe.

newPublisherProcessorDropTailOnOverflow

public static <T> PublisherSource.Processor<T,T> newPublisherProcessorDropTailOnOverflow(int maxBuffer)

Create a new PublisherSource.Processor that allows for a single subscribe. The returned PublisherSource.Processor provides all the expected API guarantees when used as a PublisherSource but does not expect the same guarantees when used as a PublisherSource.Subscriber. As an example, users are not expected to call PublisherSource.Subscriber.onSubscribe(Subscription) or they can call any of the PublisherSource.Subscriber methods concurrently and/or multiple times.

Only allows for maxBuffer number of items to be added through PublisherSource.Subscriber.onNext(Object) without being delivered to its PublisherSource.Subscriber. If more items are added without being delivered, the latest buffered item (tail) will be dropped.

Type Parameters:

T - The PublisherSource type and PublisherSource.Subscriber type of the PublisherSource.Processor.

Parameters:

maxBuffer - Maximum number of items to buffer.

Returns:

a new PublisherSource.Processor that allows for a single subscribe.

newPublisherProcessor

public static <T> PublisherSource.Processor<T,T> newPublisherProcessor(PublisherProcessorSignalsHolder<T> holder)

Create a new PublisherSource.Processor that allows for a single subscribe. The returned PublisherSource.Processor provides all the expected API guarantees when used as a PublisherSource. Users are expected to provide same API guarantees from the passed PublisherProcessorSignalsHolder as they use the returned PublisherSource.Processor as a PublisherSource.Subscriber. As an example, if users call PublisherSource.Subscriber methods concurrently the passed PublisherProcessorSignalsHolder should support concurrent invocation of its methods.

Type Parameters:

T - The PublisherSource type and PublisherSource.Subscriber type of the PublisherSource.Processor.

Parameters:

holder - A PublisherProcessorSignalsHolder to store items that are requested to be sent via PublisherSource.Subscriber.onNext(Object) but not yet emitted to the PublisherSource.Subscriber.

Returns:

a new PublisherSource.Processor that allows for a single subscribe.

newBlockingIterableProcessor

public static <T> BlockingIterable.Processor<T> newBlockingIterableProcessor()

Create a new BlockingIterable.Processor.

Type Parameters:

T - the type of elements emitted by the returned BlockingIterable.

Returns:

a new BlockingIterable.Processor.

newBlockingIterableProcessor

public static <T> BlockingIterable.Processor<T> newBlockingIterableProcessor(int maxBufferSize)

Create a new BlockingIterable.Processor.

Type Parameters:

T - the type of elements emitted by the returned BlockingIterable.

Parameters:

maxBufferSize - Maximum number of items that are requested to be sent via BlockingIterable.Processor.next(Object) but not yet emitted from a BlockingIterator. If this buffer size is reached a subsequent call to emit will block till an item is emitted from a BlockingIterator.

Returns:

a new BlockingIterable.Processor.

newBlockingIterableProcessor

public static <T> BlockingIterable.Processor<T> newBlockingIterableProcessor(BlockingProcessorSignalsHolder<T> holder)

Create a new BlockingIterable.Processor.

Type Parameters:

T - the type of elements emitted by the returned BlockingIterable.

Parameters:

holder - A BlockingProcessorSignalsHolder to store items that are requested to be sent via BlockingIterable.Processor.next(Object) but not yet emitted from a BlockingIterator.

Returns:

a new BlockingIterable.Processor.