Sha256: 3a0a5cfd041f6dac899da4093a56b7775953703113c68875f786b22dff467c64
Contents?: true
Size: 1.92 KB
Versions: 23
Compression:
Stored size: 1.92 KB
Contents
# frozen_string_literal: true
module Karafka
module Responders
# Topic describes a single topic on which we want to respond with responding requirements
# @example Define topic (required by default)
# Karafka::Responders::Topic.new(:topic_name, {}) #=> #<Karafka::Responders::Topic...
# @example Define optional topic
# Karafka::Responders::Topic.new(:topic_name, required: false)
# @example Define topic that on which we want to respond multiple times
# Karafka::Responders::Topic.new(:topic_name, multiple_usage: true)
class Topic
# Name of the topic on which we want to respond
attr_reader :name
# @param name [Symbol, String] name of a topic on which we want to respond
# @param options [Hash] non-default options for this topic
# @return [Karafka::Responders::Topic] topic description object
def initialize(name, options)
@name = name.to_s
@options = options
end
# @return [Boolean] is this a required topic (if not, it is optional)
def required?
@options.key?(:required) ? @options[:required] : true
end
# @return [Boolean] do we expect to use it multiple times in a single respond flow
def multiple_usage?
@options[:multiple_usage] || false
end
# @return [Boolean] was usage of this topic registered or not
def registered?
@options[:registered] == true
end
# @return [Boolean] do we want to use async producer. Defaults to false as the sync producer
# is safer and introduces less problems
def async?
@options.key?(:async) ? @options[:async] : false
end
# @return [Hash] hash with this topic attributes and options
def to_h
{
name: name,
multiple_usage: multiple_usage?,
required: required?,
registered: registered?,
async: async?
}
end
end
end
end
Version data entries
23 entries across 23 versions & 1 rubygems