Class: Karafka::Processing::Jobs::Idle

Inherits:

Base

• Object
• Base
• Karafka::Processing::Jobs::Idle

Defined in:

lib/karafka/processing/jobs/idle.rb

Overview

Type of job that we may use to run some extra handling that happens without the user related lifecycle event like consumption, revocation, etc.

Instance Attribute Summary

Attributes inherited from Base

#executor

Instance Method Summary

• #before_schedule ⇒ Object

  Runs code prior to scheduling this idle job.

• #call ⇒ Object

  Run the idle work via the executor.

• #initialize(executor) ⇒ Shutdown constructor

Methods inherited from Base

#after_call, #before_call, #finish!, #finished?, #non_blocking?, #wrap

Constructor Details

#initialize(executor) ⇒ Shutdown

Parameters:

• executor (Karafka::Processing::Executor) —

  executor that is suppose to run a given job on an active consumer

# File 'lib/karafka/processing/jobs/idle.rb', line 14

def initialize(executor)
  @executor = executor
  super()
end

Instance Method Details

#before_schedule ⇒ Object

Runs code prior to scheduling this idle job

# File 'lib/karafka/processing/jobs/idle.rb', line 20

def before_schedule
  executor.before_schedule_idle
end

#call ⇒ Object

Run the idle work via the executor

# File 'lib/karafka/processing/jobs/idle.rb', line 25

def call
  executor.idle
end