Sha256: b15406b0c8380aa44560694c88133b19c23034bd35b44157619ffb890eb3865d

Contents?: true

Size: 1.64 KB

Versions: 43

Compression:

Stored size: 1.64 KB

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
    module Cleaner
      # Cleaner messages components related enhancements
      module Messages
        # Extensions to the message that allow for granular memory control on a per message basis
        module Message
          # @return [Object] lazy-deserialized data (deserialized upon first request)
          def payload
            # If message has already been cleaned, it cannot be deserialized again
            cleaned? ? raise(Errors::MessageCleanedError) : super
          end

          # @return [Boolean] true if the message has been cleaned
          def cleaned?
            @raw_payload == false
          end

          # Cleans the message payload and removes the deserialized data references
          # This is useful when working with big messages that take a lot of space.
          #
          # After the message content is no longer needed, it can be removed so it does not consume
          # space anymore.
          def clean!
            @deserialized = false
            @raw_payload = false
            @payload = nil
          end
        end
      end
    end
  end
end

Version data entries

43 entries across 43 versions & 1 rubygems

Version Path
karafka-2.4.16 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.15 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.14 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.13 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.12 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.11 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.10 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.9 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.8 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.7 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.6 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.5 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.4 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.3 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.0 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.0.rc1 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.3.4 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.0.beta2 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.4.0.beta1 lib/karafka/pro/cleaner/messages/message.rb
karafka-2.3.3 lib/karafka/pro/cleaner/messages/message.rb