Package com.turtlequeue

Interface Reader<T>

  • All Superinterfaces:
    AutoCloseable, Closeable
    All Known Implementing Classes:
    ReaderImpl
    public interface Reader<T>
extends Closeable
    A Reader can be used to scan through all the messages currently available in a topic.

    • Method Detail

      • getTopic

        Topic getTopic()
        Returns:
        the topic from which this reader is reading from

      • readNext

        CompletableFuture<Message<T>> readNext()
        Read asynchronously the next message in the topic.

        readNextAsync() should be called subsequently once returned CompletableFuture gets complete with received message. Else it creates backlog of receive requests in the application.

        The returned future can be cancelled before completion by calling .cancel(false) (CompletableFuture.cancel(boolean)) to remove it from the the backlog of receive requests. Another choice for ensuring a proper clean up of the returned future is to use the CompletableFuture.orTimeout method which is available on JDK9+. That would remove it from the backlog of receive requests if receiving exceeds the timeout.

        Returns:
        a future that will yield a message (when it's available) or PulsarClientException if the reader is already closed.

      • closeAsync

        CompletableFuture<Void> closeAsync()
        Asynchronously close the reader and stop the broker to push more messages.
        Returns:
        a future that can be used to track the completion of the operation

      • hasReachedEndOfTopic

        boolean hasReachedEndOfTopic()
        Return true if the topic was terminated and this reader has reached the end of the topic.

        Note that this only applies to a "terminated" topic (where the topic is "sealed" and no more messages can be published) and not just that the reader is simply caught up with the publishers. Use hasMessageAvailable() to check for for that.

      • hasMessageAvailable

        CompletableFuture<Boolean> hasMessageAvailable()
        Asynchronously check if there is any message available to read from the current position.

        This check can be used by an application to scan through a topic and stop when the reader reaches the current last published message.

        Even if this call returns true, that will not guarantee that a subsequent call to readNext() will not block.

        Returns:
        a future that will yield true if the are messages available to be read, false otherwise, or a PulsarClientException if there was any error in the operation

      • isConnected

        boolean isConnected()
        Returns:
        Whether the reader is connected to the broker

      • seek

        CompletableFuture<Void> seek​(MessageId messageId)
        Reset the subscription associated with this reader to a specific message id.

        The message id can either be a specific message or represent the first or last messages in the topic.

        • MessageId.earliest : Reset the reader on the earliest message available in the topic
        • MessageId.latest : Reset the reader on the latest message in the topic

        Note: this operation can only be done on non-partitioned topics. For these, one can rather perform the seek() on the individual partitions.

        Parameters:
        messageId - the message id where to position the reader
        Returns:
        a future to track the completion of the seek operation

      • seek

        CompletableFuture<Void> seek​(long timestamp)
        Reset the subscription associated with this reader to a specific message publish time.

        Note: this operation can only be done on non-partitioned topics. For these, one can rather perform the seek() on the individual partitions.

        Parameters:
        timestamp - the message publish time where to position the reader
        Returns:
        a future to track the completion of the seek operation