Contents

# frozen_string_literal: true

module Kafka

  # An ordered sequence of messages fetched from a Kafka partition.
  class FetchedBatch
    # @return [String]
    attr_reader :topic

    # @return [Integer]
    attr_reader :partition

    # @return [Integer] the offset of the most recent message in the partition.
    attr_reader :highwater_mark_offset

    # @return [Array<Kafka::FetchedMessage>]
    attr_accessor :messages

    def initialize(topic:, partition:, highwater_mark_offset:, messages:)
      @topic = topic
      @partition = partition
      @highwater_mark_offset = highwater_mark_offset
      @messages = messages
    end

    def empty?
      @messages.empty?
    end

    def first_offset
      if empty?
        nil
      else
        messages.first.offset
      end
    end

    def last_offset
      if empty?
        highwater_mark_offset - 1
      else
        messages.last.offset
      end
    end

    def offset_lag
      if empty?
        0
      else
        (highwater_mark_offset - 1) - last_offset
      end
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
ruby-kafka-0.7.0	lib/kafka/fetched_batch.rb
ruby-kafka-0.7.0.beta2	lib/kafka/fetched_batch.rb
ruby-kafka-0.7.0.beta1	lib/kafka/fetched_batch.rb
ruby-kafka-0.7.0.alpha4	lib/kafka/fetched_batch.rb
ruby-kafka-0.7.0.alpha3	lib/kafka/fetched_batch.rb
ruby-kafka-0.7.0.alpha2	lib/kafka/fetched_batch.rb