Module: Karafka::Pro::Routing::Features::ScheduledMessages::Topic

Defined in:
lib/karafka/pro/routing/features/scheduled_messages/topic.rb

Overview

Topic extensions to be able to check if given topic is a scheduled messages topic Please note, that this applies to both the schedules topic and logs topic

Instance Method Summary collapse

Instance Method Details

#initialize ⇒ Object

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



18
19
20
21
 
# File 'lib/karafka/pro/routing/features/scheduled_messages/topic.rb', line 18

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

#scheduled_messages(active = false) ⇒ Object

Parameters:

  • active (Boolean) (defaults to: false) —

    should this topic be considered related to scheduled messages



24
25
26
 
# File 'lib/karafka/pro/routing/features/scheduled_messages/topic.rb', line 24

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

#scheduled_messages? ⇒ Boolean

Returns is this an ActiveJob topic.

Returns:

  • (Boolean) —

    is this an ActiveJob topic



29
30
31
 
# File 'lib/karafka/pro/routing/features/scheduled_messages/topic.rb', line 29

def scheduled_messages?
  scheduled_messages.active?
end

#to_h ⇒ Hash

messages namespace settings

Returns:

  • (Hash) —

    topic with all its native configuration options plus scheduled



35
36
37
38
39
 
# File 'lib/karafka/pro/routing/features/scheduled_messages/topic.rb', line 35

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