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>
    A ReadStream for Row consumption.
    Author:
    Pavel Drankou, Thomas Segismont

    • Method Detail

      • handler

        CassandraRowStream handler​(Handler<com.datastax.oss.driver.api.core.cql.Row> 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 interface ReadStream<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: ReadStream
        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.

        Specified by:
        pause in interface ReadStream<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: ReadStream
        Resume reading, and sets the buffer in flowing mode.

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

        Specified by:
        resume in interface ReadStream<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: 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 interface ReadStream<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: ReadStream
        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.
        Specified by:
        fetch in interface ReadStream<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: ReadStream
        Pipe this ReadStream to the WriteStream.

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

        Specified by:
        pipeTo in interface ReadStream<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 the ExecutionInfo provided by the backing ResultSet for this stream.

      • columnDefinitions

        com.datastax.oss.driver.api.core.cql.ColumnDefinitions columnDefinitions()
        Get the ColumnDefinitions provided by the backing ResultSet for this stream.