Sha256: 8d7022749c620f3b0ac7f16e1077a270c2c8dfef1579618527c018631a2ab24f

Contents?: true

Size: 1.64 KB

Versions: 13

Compression:

Stored size: 1.64 KB

Contents

# frozen_string_literal: true

module Karafka
  module Processing
    # Our processing patterns differ depending on various features configurations
    # In this namespace we collect strategies for particular feature combinations to simplify the
    # design. Based on features combinations we can then select handling strategy for a given case.
    #
    # @note The lack of common code here is intentional. It would get complex if there would be
    #   any type of composition, so each strategy is expected to be self-sufficient
    module Strategies
      # Base strategy that should be included in each strategy, just to ensure the API
      module Base
        # What should happen before jobs are enqueued
        # @note This runs from the listener thread, not recommended to put anything slow here
        def handle_before_enqueue
          raise NotImplementedError, 'Implement in a subclass'
        end

        # What should happen before we kick in the processing
        def handle_before_consume
          raise NotImplementedError, 'Implement in a subclass'
        end

        # What should happen in the processing
        def handle_consume
          raise NotImplementedError, 'Implement in a subclass'
        end

        # Post-consumption handling
        def handle_after_consume
          raise NotImplementedError, 'Implement in a subclass'
        end

        # Revocation handling
        def handle_revoked
          raise NotImplementedError, 'Implement in a subclass'
        end

        # Shutdown handling
        def handle_shutdown
          raise NotImplementedError, 'Implement in a subclass'
        end
      end
    end
  end
end

Version data entries

13 entries across 13 versions & 1 rubygems

Version Path
karafka-2.0.38 lib/karafka/processing/strategies/base.rb
karafka-2.0.37 lib/karafka/processing/strategies/base.rb
karafka-2.0.36 lib/karafka/processing/strategies/base.rb
karafka-2.0.35 lib/karafka/processing/strategies/base.rb
karafka-2.0.34 lib/karafka/processing/strategies/base.rb
karafka-2.0.33 lib/karafka/processing/strategies/base.rb
karafka-2.0.32 lib/karafka/processing/strategies/base.rb
karafka-2.0.31 lib/karafka/processing/strategies/base.rb
karafka-2.0.30 lib/karafka/processing/strategies/base.rb
karafka-2.0.29 lib/karafka/processing/strategies/base.rb
karafka-2.0.28 lib/karafka/processing/strategies/base.rb
karafka-2.0.27 lib/karafka/processing/strategies/base.rb
karafka-2.0.26 lib/karafka/processing/strategies/base.rb