Package io.vertx.cassandra
Interface CassandraRowStream
-
- All Superinterfaces:
ReadStream<com.datastax.oss.driver.api.core.cql.Row>,StreamBase
public interface CassandraRowStream extends ReadStream<com.datastax.oss.driver.api.core.cql.Row>
AReadStreamforRowconsumption.- Author:
- Pavel Drankou, Thomas Segismont
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description com.datastax.oss.driver.api.core.cql.ColumnDefinitionscolumnDefinitions()Get theColumnDefinitionsprovided by the backingResultSetfor this stream.CassandraRowStreamendHandler(Handler<Void> handler)Set an end handler.CassandraRowStreamexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.com.datastax.oss.driver.api.core.cql.ExecutionInfoexecutionInfo()Get theExecutionInfoprovided by the backingResultSetfor this stream.CassandraRowStreamfetch(long l)Fetch the specifiedamountof elements.CassandraRowStreamhandler(Handler<com.datastax.oss.driver.api.core.cql.Row> handler)Set a data handler.CassandraRowStreampause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.default Future<Void>pipeTo(WriteStream<com.datastax.oss.driver.api.core.cql.Row> dst)Pipe thisReadStreamto theWriteStream.CassandraRowStreamresume()Resume reading, and sets the buffer inflowingmode.-
Methods inherited from interface io.vertx.core.streams.ReadStream
blockingStream, collect, pipe
-
-
-
-
Method Detail
-
exceptionHandler
CassandraRowStream exceptionHandler(Handler<Throwable> handler)
Description copied from interface:ReadStreamSet an exception handler on the read stream.- Specified by:
exceptionHandlerin interfaceReadStream<com.datastax.oss.driver.api.core.cql.Row>- Specified by:
exceptionHandlerin interfaceStreamBase- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
handler
CassandraRowStream handler(Handler<com.datastax.oss.driver.api.core.cql.Row> 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<com.datastax.oss.driver.api.core.cql.Row>- Returns:
- a reference to this, so the API can be used fluently
-
pause
CassandraRowStream 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<com.datastax.oss.driver.api.core.cql.Row>- Returns:
- a reference to this, so the API can be used fluently
-
resume
CassandraRowStream 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<com.datastax.oss.driver.api.core.cql.Row>- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
CassandraRowStream endHandler(Handler<Void> handler)
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<com.datastax.oss.driver.api.core.cql.Row>- Returns:
- a reference to this, so the API can be used fluently
-
fetch
CassandraRowStream 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<com.datastax.oss.driver.api.core.cql.Row>- Returns:
- a reference to this, so the API can be used fluently
-
pipeTo
default Future<Void> pipeTo(WriteStream<com.datastax.oss.driver.api.core.cql.Row> dst)
Description copied from interface:ReadStreamPipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
pipeToin interfaceReadStream<com.datastax.oss.driver.api.core.cql.Row>- Parameters:
dst- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
executionInfo
com.datastax.oss.driver.api.core.cql.ExecutionInfo executionInfo()
Get theExecutionInfoprovided by the backingResultSetfor this stream.
-
columnDefinitions
com.datastax.oss.driver.api.core.cql.ColumnDefinitions columnDefinitions()
Get theColumnDefinitionsprovided by the backingResultSetfor this stream.
-
-