Package io.helidon.common.reactive.valve

Class InputStreamValve

java.lang.Object

io.helidon.common.reactive.valve.InputStreamValve

All Implemented Interfaces:

Pausable, Valve<ByteBuffer>

public class InputStreamValve
extends Object
implements Valve<ByteBuffer>

The InputStreamValve is a ByteBuffer based Valve that transforms a possibly blocking InputStream into the Valve.

Method Summary

Modifier and Type	Method	Description
static Collector<ByteBuffer,ByteArrayOutputStream,ByteBuffer>	byteBuffer2Collector()	A collector of ByteBuffer instances into a single ByteBuffer instance.
static Collector<ByteBuffer,ByteArrayOutputStream,byte[]>	byteBufferByteArrayCollector()	A collector of ByteBuffer instances into a single byte array.
static Collector<ByteBuffer,ByteArrayOutputStream,String>	byteBufferStringCollector(Charset charset)	A collector of ByteBuffer instances into a String of the provided charset.
protected boolean	canContinueProcessing()	Implementation of tryProcess() which initially was accepted by canProcess() should call this method before every iteration to be sure, that processing can continue (is not paused).
protected boolean	canProcess()	Implementation of tryProcess() method should call this to reserve initial handle processing (if possible).
protected Runnable	getOnComplete()
protected BiConsumer<T,Pausable>	getOnData()
protected Consumer<Throwable>	getOnError()
void	handle(BiConsumer<T,Pausable> onData, Consumer<Throwable> onError, Runnable onComplete)
protected void	handleError(Throwable thr)
protected ByteBuffer	moreData()
void	pause()	Pause data chunks flow until Pausable.resume().
protected boolean	paused()
protected void	releaseProcessing()
void	resume()	Resume data chunks flow after Pausable.pause().
protected void	tryProcess()	Implements item handling / processing.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.reactive.valve.Pausable

pause, resume

Methods inherited from interface io.helidon.common.reactive.valve.Valve

collect, executeOn, filter, flatMap, handle, handle, handle, handle, handle, handle, map, peek, toIterator, toPublisher

Method Detail

moreData

protected ByteBuffer moreData()
                       throws Throwable

Throws:

Throwable

byteBufferStringCollector

public static Collector<ByteBuffer,ByteArrayOutputStream,String> byteBufferStringCollector(Charset charset)

A collector of ByteBuffer instances into a String of the provided charset.

Parameters:

charset - the desired charset of the returned string

Returns:

a string representation of the collected byte buffers

byteBuffer2Collector

public static Collector<ByteBuffer,ByteArrayOutputStream,ByteBuffer> byteBuffer2Collector()

A collector of ByteBuffer instances into a single ByteBuffer instance.

Returns:

a single byte buffer from the collected byte buffers

byteBufferByteArrayCollector

public static Collector<ByteBuffer,ByteArrayOutputStream,byte[]> byteBufferByteArrayCollector()

A collector of ByteBuffer instances into a single byte array.

Returns:

a single byte array from the collected byte buffers

tryProcess

protected void tryProcess()

Implements item handling / processing. Implementation can use canProcess() and canContinueProcessing() method to ensure, that processing is done by a single thread at a time.

pause

public void pause()

Description copied from interface: Pausable

Pause data chunks flow until Pausable.resume().

Specified by:

pause in interface Pausable

resume

public void resume()

Description copied from interface: Pausable

Resume data chunks flow after Pausable.pause().

Specified by:

resume in interface Pausable

handle

public void handle(BiConsumer<T,Pausable> onData,
                   Consumer<Throwable> onError,
                   Runnable onComplete)

canProcess

protected boolean canProcess()

Implementation of tryProcess() method should call this to reserve initial handle processing (if possible). The same method should call canContinueProcessing() before every iteration to be sure, that handle processing should continue.

Returns:

true only if method can process (handle) item

canContinueProcessing

protected boolean canContinueProcessing()

Implementation of tryProcess() which initially was accepted by canProcess() should call this method before every iteration to be sure, that processing can continue (is not paused).

Returns:

true only if method can continue with handle processing

paused

protected boolean paused()

releaseProcessing

protected void releaseProcessing()

handleError

protected void handleError(Throwable thr)

getOnData

protected BiConsumer<T,Pausable> getOnData()

getOnError

protected Consumer<Throwable> getOnError()

getOnComplete

protected Runnable getOnComplete()