Module: Karafka::Routing::Features::ConsumerGroups::ManualOffsetManagement::Topic

Defined in:

lib/karafka/routing/features/consumer_groups/manual_offset_management/topic.rb

Overview

Topic extensions to be able to manage manual offset management settings

Instance Method Summary

• #initialize ⇒ Object

  This method sets up the extra instance variable to nil before calling the parent class initializer.

• #manual_offset_management(active = false) ⇒ Config

  where the boolean would be an argument.

• #manual_offset_management? ⇒ Boolean

  Is manual offset management enabled for a given topic.

• #to_h ⇒ Hash

  Topic with all its native configuration options plus manual offset management namespace settings.

Instance Method Details

#initialize ⇒ Object

This method sets up the extra instance variable to nil before calling the parent class initializer. The explicit initialization to nil is included as an optimization for Ruby's object shapes system, which improves memory layout and access performance.

# File 'lib/karafka/routing/features/consumer_groups/manual_offset_management/topic.rb', line 14

def initialize(...)
  @manual_offset_management = nil
  super
end

#manual_offset_management(active = false) ⇒ Config

Note:

Since this feature supports only one setting (active), we can use the old API

where the boolean would be an argument

# File 'lib/karafka/routing/features/consumer_groups/manual_offset_management/topic.rb', line 25

def manual_offset_management(active = false)
  @manual_offset_management ||= Config.new(active: active)
end

#manual_offset_management? ⇒ Boolean

# File 'lib/karafka/routing/features/consumer_groups/manual_offset_management/topic.rb', line 30

def manual_offset_management?
  manual_offset_management.active?
end

#to_h ⇒ Hash

# File 'lib/karafka/routing/features/consumer_groups/manual_offset_management/topic.rb', line 36

def to_h
  super.merge(
    manual_offset_management: manual_offset_management.to_h
  ).freeze
end