Package io.vertx.sqlclient
Interface RowStream<T>
-
- All Superinterfaces:
ReadStream<T>,StreamBase
public interface RowStream<T> extends ReadStream<T>
A row oriented stream.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Future<Void>close()Close the stream and release the resources.RowStream<T>endHandler(Handler<Void> endHandler)Set an end handler.RowStream<T>exceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.RowStream<T>fetch(long l)Fetch the specifiedamountof elements.RowStream<T>handler(Handler<T> handler)Set a data handler.RowStream<T>pause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.RowStream<T>resume()Resume reading, and sets the buffer inflowingmode.-
Methods inherited from interface io.vertx.core.streams.ReadStream
blockingStream, collect, pipe, pipeTo
-
-
-
-
Method Detail
-
exceptionHandler
RowStream<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
RowStream<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
RowStream<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
RowStream<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
RowStream<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
-
fetch
RowStream<T> fetch(long l)
Description copied from interface:ReadStreamFetch the specifiedamountof elements. If theReadStreamhas been paused, reading will recommence with the specifiedamountof items, otherwise the specifiedamountwill be added to the current stream demand.- Specified by:
fetchin interfaceReadStream<T>- Returns:
- a reference to this, so the API can be used fluently
-
-