org.vertx.java.core.streams

Interface ReadStream<T>

All Superinterfaces:

ExceptionSupport<T>

All Known Subinterfaces:

AsyncFile, HttpClientResponse, HttpServerFileUpload, HttpServerRequest, NetSocket, ServerWebSocket, SockJSSocket, WebSocket, WebSocketBase<T>

All Known Implementing Classes:

DefaultAsyncFile, DefaultHttpClientResponse, DefaultHttpServerRequest, DefaultNetSocket, DefaultServerWebSocket, DefaultWebSocket, SockJSSocketBase

public interface ReadStream<T>
extends ExceptionSupport<T>

Represents a stream of data that can be read from.

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

This interface exposes a fluent api and the type T represents the type of the object that implements the interface to allow method chaining

Method Summary

Methods

Modifier and Type	Method and Description
T	dataHandler(Handler<Buffer> handler) Set a data handler.
T	endHandler(Handler<java.lang.Void> endHandler) Set an end handler.
T	pause() Pause the ReadStream.
T	resume() Resume reading.

Methods inherited from interface org.vertx.java.core.streams.ExceptionSupport

exceptionHandler

Method Detail

dataHandler

T dataHandler(Handler<Buffer> handler)

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

pause

T pause()

Pause the ReadStream. While the stream is paused, no data will be sent to the dataHandler

resume

T resume()

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

endHandler

T endHandler(Handler<java.lang.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.