Package io.vertx.ext.reactivestreams
Interface ReactiveReadStream<T>
-
- All Superinterfaces:
ReadStream<T>,StreamBase,org.reactivestreams.Subscriber<T>
public interface ReactiveReadStream<T> extends ReadStream<T>, org.reactivestreams.Subscriber<T>
A Vert.x read stream that also implements reactive streams subscriber interface.- Author:
- Tim Fox
-
-
Field Summary
Fields Modifier and Type Field Description static longDEFAULT_BATCH_SIZEDefault batch size
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description ReactiveReadStream<T>endHandler(Handler<Void> endHandler)Set an end handler.ReactiveReadStream<T>exceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.ReactiveReadStream<T>handler(Handler<T> handler)Set a data handler.ReactiveReadStream<T>pause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.static <T> ReactiveReadStream<T>readStream()Create a reactive read streamstatic <T> ReactiveReadStream<T>readStream(long batchSize)Create a reactive read stream specifying batch sizeReactiveReadStream<T>resume()Resume reading, and sets the buffer inflowingmode.-
Methods inherited from interface io.vertx.core.streams.ReadStream
blockingStream, collect, fetch, pipe, pipeTo
-
-
-
-
Field Detail
-
DEFAULT_BATCH_SIZE
static final long DEFAULT_BATCH_SIZE
Default batch size- See Also:
- Constant Field Values
-
-
Method Detail
-
readStream
static <T> ReactiveReadStream<T> readStream()
Create a reactive read stream- Returns:
- the stream
-
readStream
static <T> ReactiveReadStream<T> readStream(long batchSize)
Create a reactive read stream specifying batch size- Parameters:
batchSize- the batch size- Returns:
- the stream
-
exceptionHandler
ReactiveReadStream<T> exceptionHandler(Handler<Throwable> handler)
Description copied from interface:ReadStreamSet an exception handler on the read stream.- Specified by:
exceptionHandlerin interfaceReadStream<T>- Specified by:
exceptionHandlerin interfaceStreamBase- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
handler
ReactiveReadStream<T> handler(Handler<T> handler)
Description copied from interface:ReadStreamSet a data handler. As data is read, the handler will be called with the data.- Specified by:
handlerin interfaceReadStream<T>- Returns:
- a reference to this, so the API can be used fluently
-
pause
ReactiveReadStream<T> pause()
Description copied from interface:ReadStreamPause theReadStream, it sets the buffer infetchmode and clears the actual demand.While it's paused, no data will be sent to the data
handler.- Specified by:
pausein interfaceReadStream<T>- Returns:
- a reference to this, so the API can be used fluently
-
resume
ReactiveReadStream<T> resume()
Description copied from interface:ReadStreamResume reading, and sets the buffer inflowingmode. If theReadStreamhas been paused, reading will recommence on it.- Specified by:
resumein interfaceReadStream<T>- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
ReactiveReadStream<T> endHandler(Handler<Void> endHandler)
Description copied from interface:ReadStreamSet an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.- Specified by:
endHandlerin interfaceReadStream<T>- Returns:
- a reference to this, so the API can be used fluently
-
-