Contents

# frozen_string_literal: true

# This Karafka component is a Pro component under a commercial license.
# This Karafka component is NOT licensed under LGPL.
#
# All of the commercial components are present in the lib/karafka/pro directory of this
# repository and their usage requires commercial license agreement.
#
# Karafka has also commercial-friendly license, commercial support and commercial components.
#
# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
# your code to Maciej Mensfeld.

module Karafka
  module Pro
    # Extra methods always used in the base consumer in the pro mode
    #
    # We do not define those methods as part of the strategies flows, because they are injected
    # (strategies) on singletons and often used only in one of the strategy variants
    #
    # Methods here are suppose to be always available or are expected to be redefined
    module BaseConsumer
      # Runs the on-schedule tick periodic operations
      # This method is an alias but is part of the naming convention used for other flows, this
      # is why we do not reference the `handle_before_schedule_tick` directly
      def on_before_schedule_tick
        handle_before_schedule_tick
      end

      # Used by the executor to trigger consumer tick
      # @private
      def on_tick
        handle_tick
      rescue StandardError => e
        Karafka.monitor.instrument(
          'error.occurred',
          error: e,
          caller: self,
          type: 'consumer.tick.error'
        )
      end

      # By default we do nothing when ticking
      def tick; end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
karafka-2.3.1	lib/karafka/pro/base_consumer.rb
karafka-2.3.0	lib/karafka/pro/base_consumer.rb
karafka-2.3.0.rc1	lib/karafka/pro/base_consumer.rb
karafka-2.3.0.alpha2	lib/karafka/pro/base_consumer.rb
karafka-2.3.0.alpha1	lib/karafka/pro/base_consumer.rb