Module net.pincette.rs

Package net.pincette.rs

Class Per<T>

java.lang.Object

net.pincette.rs.ProcessorBase<T,R>

net.pincette.rs.Buffered<T,List<T>>

net.pincette.rs.Per<T>

Type Parameters:

T - the value type.

All Implemented Interfaces:

Flow.Processor<T,List<T>>, Flow.Publisher<List<T>>, Flow.Subscriber<T>

public class Per<T>
extends Buffered<T,List<T>>

Buffers a number of values. It always requests the number of values from the publisher that equals the buffer size. It emits the buffered values as a list. This processor uses a shared thread.

Since:

2.0

Author:

Werner Donné

Field Summary

Fields inherited from class net.pincette.rs.ProcessorBase

subscriber, subscription

Constructor Summary

Constructors

Constructor	Description
Per(int size)	Create a buffer of size.
Per(int size, Duration timeout)	Create a buffer of size with a timeout.
Per(int size, Duration timeout, Duration requestTimeout)	Create a buffer of size with a timeout.

Method Summary

Modifier and Type	Method	Description
protected void	last()	This is called when the stream has completed.
boolean	onNextAction(T value)	The onNext method uses this method.
void	onSubscribe(Flow.Subscription subscription)
static <T> Flow.Processor<T,List<T>>	per(int size)
static <T> Flow.Processor<T,List<T>>	per(int size, Duration timeout)
static <T> Flow.Processor<T,List<T>>	per(int size, Duration timeout, Duration requestTimeout)

Methods inherited from class net.pincette.rs.Buffered

addValues, cancelling, emit, emit, getRequested, isCancelled, isCompleted, onComplete, onError, onNext

Methods inherited from class net.pincette.rs.ProcessorBase

cancel, complete, dispatch, getError, setError, subscribe

Methods inherited from class java.lang.Object

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

Constructor Details

Per

public Per(int size)

Create a buffer of size. The requestTimeout is set to 0.

Parameters:

size - the buffer size, which must be larger than zero.

Per

public Per(int size,
 Duration timeout)

Create a buffer of size with a timeout. The requestTimeout is set to 0.

Parameters:

size - the buffer size, which must be larger than zero.

timeout - the timeout after which the buffer is flushed. It should be positive.

Per

public Per(int size,
 Duration timeout,
 Duration requestTimeout)

Create a buffer of size with a timeout.

Parameters:

size - the buffer size, which must be larger than zero.

timeout - the timeout after which the buffer is flushed. It should be positive.

requestTimeout - the time after which an additional element is requested, even if the upstream publisher hasn't sent all requested elements yet. This provides the opportunity to the publisher to complete properly when it has fewer elements left than the buffer size. It may be null.

Since:

3.0.2

Method Details

per

public static <T> Flow.Processor<T,List<T>> per(int size)

per

public static <T> Flow.Processor<T,List<T>> per(int size,
 Duration timeout)

per

public static <T> Flow.Processor<T,List<T>> per(int size,
 Duration timeout,
 Duration requestTimeout)

last

protected void last()

Description copied from class: Buffered

This is called when the stream has completed. It provides subclasses with the opportunity to flush any remaining data to the buffer.

Overrides:

last in class Buffered<T,List<T>>

onNextAction

public boolean onNextAction(T value)

Description copied from class: Buffered

The onNext method uses this method.

Specified by:

onNextAction in class Buffered<T,List<T>>

Parameters:

value - the received value.

Returns:

Indicated if values have been added or not.

onSubscribe

public void onSubscribe(Flow.Subscription subscription)

Specified by:

onSubscribe in interface Flow.Subscriber<T>

Overrides:

onSubscribe in class Buffered<T,List<T>>