Class: Deimos::Consumer

Inherits:
Karafka::BaseConsumer
  • Object
show all
Includes:
Deimos::Consume::BatchConsumption, Deimos::Consume::MessageConsumption, SharedConfig
Defined in:
lib/deimos/consumer.rb,
sig/defs.rbs

Overview

Basic consumer class. Inherit from this class and override either consume or consume_batch, depending on the delivery mode of your listener. consume -> use delivery :message or delivery :batch consume_batch -> use delivery :inline_batch

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Deimos::Consume::MessageConsumption

#consume_message

Class Method Details

.decoder ⇒ Deimos::SchemaBackends::Base

Returns:



122
 
# File 'sig/defs.rbs', line 122

def self.decoder: () -> Deimos::SchemaBackends::Base

.key_decoder ⇒ Deimos::SchemaBackends::Base

Returns:



124
 
# File 'sig/defs.rbs', line 124

def self.key_decoder: () -> Deimos::SchemaBackends::Base

Instance Method Details

#around_consume ⇒ void

This method returns an undefined value.

@param payload

@param metadata

Parameters:

  • payload (String)
  • metadata (::Hash[untyped, untyped]) 


155
 
# File 'sig/defs.rbs', line 155

def around_consume: (String payload, ::Hash[untyped, untyped] metadata) -> void

#around_consume_batch ⇒ void

This method returns an undefined value.

@param batch

@param metadata

Parameters:

  • batch (::Array[String])
  • metadata (::Hash[untyped, untyped]) 


143
 
# File 'sig/defs.rbs', line 143

def around_consume_batch: (::Array[String] batch, ::Hash[untyped, untyped] metadata) -> void

#consume ⇒ void

This method returns an undefined value.

Consume incoming messages.

@param _payload

@param _metadata

Parameters:

  • _payload (String)
  • _metadata (::Hash[untyped, untyped]) 


162
163
164
165
166
167
168
 
# File 'sig/defs.rbs', line 162

def consume
  if self.topic.each_message
    _consume_messages
  else
    _consume_batch
  end
end

#consume_batch ⇒ void

This method returns an undefined value.

Consume a batch of incoming messages.

@param _payloads

@param _metadata

Parameters:

  • _payloads (::Array[Phobos::BatchMessage])
  • _metadata (::Hash[untyped, untyped]) 


150
 
# File 'sig/defs.rbs', line 150

def consume_batch: (::Array[Phobos::BatchMessage] _payloads, ::Hash[untyped, untyped] _metadata) -> void

#decode_key ⇒ Object

Helper method to decode an encoded key.

@param key

@return — the decoded key.

Parameters:

  • key (String)

Returns:

  • (Object) 


131
 
# File 'sig/defs.rbs', line 131

def decode_key: (String key) -> Object

#decode_message ⇒ Object

Helper method to decode an encoded message.

@param payload

@return — the decoded message.

Parameters:

  • payload (Object)

Returns:

  • (Object) 


138
 
# File 'sig/defs.rbs', line 138

def decode_message: (Object payload) -> Object