Vert.x 4.5.13 · io.vertx.core.streams.ReadStream · APIdia, the JavaDoc alternative

Represents a stream of items that can be read from.

Any class that implements this interface can be used by a Pipe to pipe data from it to a WriteStream.

Streaming mode

The stream is either in flowing or fetch mode.

Initially the stream is in flowing mode.

When the stream is in flowing mode, elements are delivered to the handler.
When the stream is in fetch mode, only the number of requested elements will be delivered to the handler.

The mode can be changed with the pause(), resume() and fetch methods:

Calling resume() sets the flowing mode
Calling pause() sets the fetch mode and resets the demand to 0
Calling fetch(long) requests a specific amount of elements and adds it to the actual demand

Method Summary

Modifier and Type	Method and Description
public default <R, A> Future<R>	Returns: a future notified with result produced by the `collector` applied to this stream collect(Collector<T, A, R> collector) Apply a `collector` to this stream, the obtained result is returned as a future.
public ReadStream<T>	Returns: a reference to this, so the API can be used fluently endHandler(@Nullable Handler<Void> endHandler) Set an end handler.
public ReadStream<T>	Returns: a reference to this, so the API can be used fluently exceptionHandler(@Nullable Handler<Throwable> the exception handler handler) Set an exception handler on the read stream.
public ReadStream<T>	Returns: a reference to this, so the API can be used fluently fetch(long amount) Fetch the specified `amount` of elements.
public ReadStream<T>	Returns: a reference to this, so the API can be used fluently handler(@Nullable Handler<T> handler) Set a data handler.
public ReadStream<T>	Returns: a reference to this, so the API can be used fluently pause() Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.
public default Pipe<T>	Returns: a pipe pipe() Pause this stream and return a `Pipe` to transfer the elements of this stream to a destination `WriteStream`.
public default Future<Void>	pipeTo(WriteStream<T> dst) Same as `pipeTo(WriteStream, Handler)` but returns a `Future` of the asynchronous result
public default void	pipeTo(WriteStream<T> the destination write stream dst, Handler<AsyncResult<Void>> handler) Pipe this `ReadStream` to the `WriteStream`.
public ReadStream<T>	Returns: a reference to this, so the API can be used fluently resume() Resume reading, and sets the buffer in `flowing` mode.

Inherited from io.vertx.core.streams.StreamBase:: exceptionHandler

Method Detail

collect back to summary

collect	back to summary
public default <R, A> Future<R> collect(Collector<T, A, R> collector) Apply a `collector` to this stream, the obtained result is returned as a future. Handlers of this stream are affected by this operation. Returns:Future<R> a future notified with result produced by the `collector` applied to this stream Annotations @GenIgnore

public default <R, A> Future<R> collect(Collector<T, A, R> collector)

Apply a collector to this stream, the obtained result is returned as a future.

Handlers of this stream are affected by this operation.

Returns:Future<R>

a future notified with result produced by the collector applied to this stream

Annotations

@GenIgnore

endHandler	back to summary
public ReadStream<T> endHandler(@Nullable Handler<Void> endHandler) Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called. Returns:ReadStream<T> a reference to this, so the API can be used fluently Annotations @Fluent

endHandler

back to summary

public ReadStream<T> endHandler(@Nullable Handler<Void> endHandler)

Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

Returns:ReadStream<T>

a reference to this, so the API can be used fluently

Annotations

@Fluent

exceptionHandler	back to summary
public ReadStream<T> exceptionHandler(@Nullable Handler<Throwable> handler) Set an exception handler on the read stream. Parameters handler:@Nullable Handler<Throwable> the exception handler Returns:ReadStream<T> a reference to this, so the API can be used fluently

exceptionHandler

back to summary

public ReadStream<T> exceptionHandler(@Nullable Handler<Throwable> handler)

Set an exception handler on the read stream.

Parameters

handler:@Nullable Handler<Throwable>: the exception handler

Returns:ReadStream<T>

a reference to this, so the API can be used fluently

fetch back to summary

fetch	back to summary
public ReadStream<T> fetch(long amount) Fetch the specified `amount` of elements. If the `ReadStream` has been paused, reading will recommence with the specified `amount` of items, otherwise the specified `amount` will be added to the current stream demand. Returns:ReadStream<T> a reference to this, so the API can be used fluently Annotations @Fluent

public ReadStream<T> fetch(long amount)

Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.

Returns:ReadStream<T>

a reference to this, so the API can be used fluently

Annotations

@Fluent

handler	back to summary
public ReadStream<T> handler(@Nullable Handler<T> handler) Set a data handler. As data is read, the handler will be called with the data. Returns:ReadStream<T> a reference to this, so the API can be used fluently Annotations @Fluent

handler

back to summary

public ReadStream<T> handler(@Nullable Handler<T> handler)

Set a data handler. As data is read, the handler will be called with the data.

Returns:ReadStream<T>

a reference to this, so the API can be used fluently

Annotations

@Fluent

pause back to summary

pause	back to summary
public ReadStream<T> pause() Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand. While it's paused, no data will be sent to the data `handler`. Returns:ReadStream<T> a reference to this, so the API can be used fluently Annotations @Fluent

public ReadStream<T> pause()

Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.

While it's paused, no data will be sent to the data handler.

Returns:ReadStream<T>

a reference to this, so the API can be used fluently

Annotations

@Fluent

pipe back to summary

pipe	back to summary
public default Pipe<T> pipe() Pause this stream and return a `Pipe` to transfer the elements of this stream to a destination `WriteStream`. The stream will be resumed when the pipe will be wired to a `WriteStream`. Returns:Pipe<T> a pipe

public default Pipe<T> pipe()

Pause this stream and return a Pipe to transfer the elements of this stream to a destination WriteStream.

The stream will be resumed when the pipe will be wired to a WriteStream.

Returns:Pipe<T>: a pipe

pipeTo	back to summary
public default Future<Void> pipeTo(WriteStream<T> dst) Same as `pipeTo(WriteStream, Handler)` but returns a `Future` of the asynchronous result

pipeTo back to summary

pipeTo	back to summary
public default void pipeTo(WriteStream<T> dst, Handler<AsyncResult<Void>> handler) Pipe this `ReadStream` to the `WriteStream`. Elements emitted by this stream will be written to the write stream until this stream ends or fails. Once this stream has ended or failed, the write stream will be ended and the `handler` will be called with the result. Parameters dst:WriteStream<T> the destination write stream

public default void pipeTo(WriteStream<T> dst, Handler<AsyncResult<Void>> handler)

Pipe this ReadStream to the WriteStream.

Elements emitted by this stream will be written to the write stream until this stream ends or fails.

Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.

Parameters

dst:WriteStream<T>: the destination write stream

resume back to summary

resume	back to summary
public ReadStream<T> resume() Resume reading, and sets the buffer in `flowing` mode. If the `ReadStream` has been paused, reading will recommence on it. Returns:ReadStream<T> a reference to this, so the API can be used fluently Annotations @Fluent

public ReadStream<T> resume()

Resume reading, and sets the buffer in flowing mode.

If the ReadStream has been paused, reading will recommence on it.

Returns:ReadStream<T>

a reference to this, so the API can be used fluently

Annotations

@Fluent

public Interface ReadStream<T>

Streaming mode

Method Summary

Method Detail