Module: Karafka::Pro::Routing::Features::Expiring::Topic

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

Overview

Topic expiring API extensions

Instance Method Summary collapse

Instance Method Details

#expire_in ⇒ Object

Just an alias for nice API



38
39
40
 
# File 'lib/karafka/pro/routing/features/expiring/topic.rb', line 38

def expire_in(*)
  expiring(*)
end

#expiring(ttl = nil) ⇒ Object

Parameters:

  • ttl (Integer, nil) (defaults to: nil) —

    maximum time in ms a message is considered alive



23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/karafka/pro/routing/features/expiring/topic.rb', line 23

def expiring(ttl = nil)
  # Those settings are used for validation
  @expiring ||= begin
    config = Config.new(active: !ttl.nil?, ttl: ttl)

    if config.active?
      factory = ->(*) { Pro::Processing::Filters::Expirer.new(ttl) }
      filter(factory)
    end

    config
  end
end

#expiring? ⇒ Boolean

Returns is a given job expiring.

Returns:

  • (Boolean) —

    is a given job expiring



43
44
45
 
# File 'lib/karafka/pro/routing/features/expiring/topic.rb', line 43

def expiring?
  expiring.active?
end

#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.



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

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

#to_h ⇒ Hash

Returns topic with all its native configuration options plus expiring.

Returns:

  • (Hash) —

    topic with all its native configuration options plus expiring



48
49
50
51
52
 
# File 'lib/karafka/pro/routing/features/expiring/topic.rb', line 48

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