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 specifiedamount
of elements.RowStream<T>
handler(Handler<T> handler)
Set a data handler.RowStream<T>
pause()
Pause theReadStream
, it sets the buffer infetch
mode and clears the actual demand.RowStream<T>
resume()
Resume reading, and sets the buffer inflowing
mode.-
Methods inherited from interface io.vertx.core.streams.ReadStream
collect, pipe, pipeTo
-
-
-
-
Method Detail
-
exceptionHandler
RowStream<T> exceptionHandler(Handler<Throwable> handler)
Description copied from interface:ReadStream
Set an exception handler on the read stream.- Specified by:
exceptionHandler
in interfaceReadStream<T>
- Specified by:
exceptionHandler
in 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:ReadStream
Set a data handler. As data is read, the handler will be called with the data.- Specified by:
handler
in interfaceReadStream<T>
- Returns:
- a reference to this, so the API can be used fluently
-
pause
RowStream<T> pause()
Description copied from interface:ReadStream
Pause theReadStream
, it sets the buffer infetch
mode and clears the actual demand.While it's paused, no data will be sent to the data
handler
.- Specified by:
pause
in interfaceReadStream<T>
- Returns:
- a reference to this, so the API can be used fluently
-
resume
RowStream<T> resume()
Description copied from interface:ReadStream
Resume reading, and sets the buffer inflowing
mode. If theReadStream
has been paused, reading will recommence on it.- Specified by:
resume
in 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:ReadStream
Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.- Specified by:
endHandler
in interfaceReadStream<T>
- Returns:
- a reference to this, so the API can be used fluently
-
fetch
RowStream<T> fetch(long l)
Description copied from interface:ReadStream
Fetch the specifiedamount
of elements. If theReadStream
has been paused, reading will recommence with the specifiedamount
of items, otherwise the specifiedamount
will be added to the current stream demand.- Specified by:
fetch
in interfaceReadStream<T>
- Returns:
- a reference to this, so the API can be used fluently
-
-