module BackgroundWorker::State

Attributes

state[RW]

Public Instance Methods

report_failed(message = 'Failed', detailed_message = nil) click to toggle source
# File lib/background_worker/state.rb, line 31
def report_failed(message = 'Failed', detailed_message = nil)
  state.detailed_message = detailed_message
  state.set_completed(message, :failed)
end
report_minor_progress(message) click to toggle source

Report a minor progress – may get called a lot, so don’t save it so often

# File lib/background_worker/state.rb, line 15
def report_minor_progress(message)
  state.message = message

  # Only report minor events once per second
  @last_report ||= Time.now - 2
  time_elapsed =  Time.now - @last_report
  return unless time_elapsed > 1

  @last_report = Time.now
  state.save
end
report_progress(message) click to toggle source

Report progress…

# File lib/background_worker/state.rb, line 9
def report_progress(message)
  state.message = message
  state.save
end
report_successful(message = 'Finished successfully') click to toggle source
# File lib/background_worker/state.rb, line 27
def report_successful(message = 'Finished successfully')
  state.set_completed(message, :successful)
end