Class: Karafka::Pro::Processing::Schedulers::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/karafka/pro/processing/schedulers/base.rb

Overview

Note:

All the on_ methods can be redefined with a non-thread-safe versions without locks if needed, however when doing so, ensure that your scheduler is stateless.

Base for all the Pro custom schedulers

It wraps the Scheduler API with mutex to ensure, that during scheduling we do not start scheduling other work that could impact the decision making in between multiple subscription groups running in separate threads.

Direct Known Subclasses

Default

Instance Method Summary collapse

Constructor Details

#initialize(queue) ⇒ Base

Returns a new instance of Base.

Parameters:

  • queue where we want to put the jobs



38
39
40
41
 
# File 'lib/karafka/pro/processing/schedulers/base.rb', line 38

def initialize(queue)
  @queue = queue
  @mutex = Mutex.new
end

Instance Method Details

#clear(_group_id) ⇒ Object

By default schedulers are stateless, so nothing to clear.

Parameters:

  • Subscription group id



139
140
141
 
# File 'lib/karafka/pro/processing/schedulers/base.rb', line 139

def clear(_group_id)
  nil
end

#manage ⇒ Object

Should manage scheduling on jobs state changes

By default does nothing as default schedulers are stateless



125
126
127
 
# File 'lib/karafka/pro/processing/schedulers/base.rb', line 125

def manage
  nil
end

#on_clear(group_id) ⇒ Object

Runs clearing under mutex

Parameters:

  • Subscription group id



132
133
134
 
# File 'lib/karafka/pro/processing/schedulers/base.rb', line 132

def on_clear(group_id)
  @mutex.synchronize { clear(group_id) }
end

#on_manage ⇒ Object

Runs the manage tick under mutex



118
119
120
 
# File 'lib/karafka/pro/processing/schedulers/base.rb', line 118

def on_manage
  @mutex.synchronize { manage }
end

#on_schedule_consumption(jobs_array) ⇒ Object

Runs the consumption jobs scheduling flow under a mutex

Parameters:

  • Array<Karafka::Processing::Jobs::Consume, Processing::Jobs::ConsumeNonBlocking>

    jobs for scheduling



56
57
58
59
60
 
# File 'lib/karafka/pro/processing/schedulers/base.rb', line 56

def on_schedule_consumption(jobs_array)
  @mutex.synchronize do
    schedule_consumption(jobs_array)
  end
end

#on_schedule_idle(jobs_array) ⇒ Object

Runs the idle jobs scheduling flow under a mutex

Parameters:

  • jobs for scheduling



94
95
96
97
98
 
# File 'lib/karafka/pro/processing/schedulers/base.rb', line 94

def on_schedule_idle(jobs_array)
  @mutex.synchronize do
    schedule_idle(jobs_array)
  end
end

#on_schedule_periodic(jobs_array) ⇒ Object

Runs the periodic jobs scheduling flow under a mutex

Parameters:

  • Array<Processing::Jobs::Periodic, Processing::Jobs::PeriodicNonBlocking>

    jobs for scheduling



105
106
107
108
109
 
# File 'lib/karafka/pro/processing/schedulers/base.rb', line 105

def on_schedule_periodic(jobs_array)
  @mutex.synchronize do
    schedule_periodic(jobs_array)
  end
end

#on_schedule_revocation(jobs_array) ⇒ Object

Runs the revocation jobs scheduling flow under a mutex

Parameters:

  • Array<Karafka::Processing::Jobs::Revoked, Processing::Jobs::RevokedNonBlocking>

    jobs for scheduling



76
77
78
79
80
 
# File 'lib/karafka/pro/processing/schedulers/base.rb', line 76

def on_schedule_revocation(jobs_array)
  @mutex.synchronize do
    schedule_revocation(jobs_array)
  end
end

#on_schedule_shutdown(jobs_array) ⇒ Object

Runs the shutdown jobs scheduling flow under a mutex

Parameters:

  • jobs for scheduling



85
86
87
88
89
 
# File 'lib/karafka/pro/processing/schedulers/base.rb', line 85

def on_schedule_shutdown(jobs_array)
  @mutex.synchronize do
    schedule_shutdown(jobs_array)
  end
end

#schedule_consumption(_jobs_array) ⇒ Object

Should schedule the consumption jobs

Parameters:

  • Array<Karafka::Processing::Jobs::Consume, Processing::Jobs::ConsumeNonBlocking>

    jobs for scheduling

Raises:



67
68
69
 
# File 'lib/karafka/pro/processing/schedulers/base.rb', line 67

def schedule_consumption(_jobs_array)
  raise NotImplementedError, "Implement in a subclass"
end

#schedule_fifo(jobs_array) ⇒ Object Also known as: schedule_revocation, schedule_shutdown, schedule_idle, schedule_periodic

Schedules any jobs provided in a fifo order

Parameters:



45
46
47
48
49
 
# File 'lib/karafka/pro/processing/schedulers/base.rb', line 45

def schedule_fifo(jobs_array)
  jobs_array.each do |job|
    @queue << job
  end
end