Class: Kafka::FFI::TopicPartition

Inherits:

FFI::Struct

• Object
• FFI::Struct
• Kafka::FFI::TopicPartition

Defined in:

lib/kafka/ffi/topic_partition.rb

Instance Method Summary

• #error ⇒ nil, Kafka::ResponseError
• #offset ⇒ Integer

  Known offset for the consumer group for topic + partition.

• #partition ⇒ Integer

  Partition number.

• #topic ⇒ String

  Name of the topic.

Instance Method Details

#error ⇒ nil, Kafka::ResponseError

Returns:

• (nil) —

  The TopicPartition does not have an error set

• (Kafka::ResponseError) —

  Error for this topic occurred related to the action the TopicPartition (or TopicPartitionList) was passed to.

# File 'lib/kafka/ffi/topic_partition.rb', line 21

def error
  if self[:err] != :ok
    ::Kafka::ResponseError.new(self[:err])
  end
end

#offset ⇒ Integer

Returns Known offset for the consumer group for topic + partition.

Returns:

• (Integer) —

  Known offset for the consumer group for topic + partition.

# File 'lib/kafka/ffi/topic_partition.rb', line 39

def offset
  self[:offset]
end

#partition ⇒ Integer

Returns Partition number.

Returns:

• (Integer) —

  Partition number

# File 'lib/kafka/ffi/topic_partition.rb', line 33

def partition
  self[:partition]
end

#topic ⇒ String

Returns Name of the topic.

Returns:

• (String) —

  Name of the topic

# File 'lib/kafka/ffi/topic_partition.rb', line 28

def topic
  self[:topic]
end