Module: Sidetiq

Defined in:

lib/sidetiq.rb,
lib/sidetiq/web.rb,
lib/sidetiq/clock.rb,
lib/sidetiq/config.rb,
lib/sidetiq/version.rb,
lib/sidetiq/schedule.rb,
lib/sidetiq/middleware.rb,
lib/sidetiq/schedulable.rb,
ext/sidetiq_ext/sidetiq_ext.c

Overview

The Sidetiq namespace.

Defined Under Namespace

Modules: Schedulable, VERSION, Web Classes: Clock, Error, Middleware, Schedule

Class Attribute Summary

• .config ⇒ Object

  Public: Returns the current configuration used by Sidetiq.

Class Method Summary

• .configure {|config| ... } ⇒ Object

  Public: Configuration wrapper for block configurations.

Class Attribute Details

.config ⇒ Object

Public: Returns the current configuration used by Sidetiq.

# File 'lib/sidetiq/config.rb', line 21

def config
  @config ||= OpenStruct.new
end

Class Method Details

.configure {|config| ... } ⇒ Object

Public: Configuration wrapper for block configurations.

Examples

Sidetiq.configure do |config|
  config.resolution = 0.2
end

Yields the configuration OpenStruct currently set. Returns nothing.

Yields:

• (config)

# File 'lib/sidetiq/config.rb', line 16

def configure
  yield config
end