Class: Leveret::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/leveret/configuration.rb

Overview

Contains everything needed to configure leveret for work. Sensible defaults are included and will be initialized with the class.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Create a new instance of Configuration with a set of sane defaults.



40
41
42
 
# File 'lib/leveret/configuration.rb', line 40

def initialize
  assign_defaults
end

Instance Attribute Details

#after_fork ⇒ Proc

Returns A proc which will be executed in a child after forking to process a message. Default: proc {}.

Returns:

  • (Proc) —

    A proc which will be executed in a child after forking to process a message. Default: proc {}



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/leveret/configuration.rb', line 35

class Configuration
  attr_accessor :amqp, :exchange_name, :queue_name_prefix, :log_file, :log_level, :default_queue_name, :after_fork,
    :error_handler, :concurrent_fork_count, :delay_exchange_name, :delay_queue_name, :delay_time

  # Create a new instance of Configuration with a set of sane defaults.
  def initialize
    assign_defaults
  end

  private

  def assign_defaults
    self.amqp = "amqp://guest:guest@localhost:5672"
    self.exchange_name = 'leveret_exch'
    self.log_file = STDOUT
    self.log_level = Logger::DEBUG
    self.queue_name_prefix = 'leveret_queue'
    self.default_queue_name = 'standard'
    self.delay_exchange_name = 'leveret_delay_exch'
    self.delay_queue_name = 'leveret_delay_queue'
    self.delay_time = 10_000
    self.after_fork = proc {}
    self.error_handler = proc { |ex| ex }
    self.concurrent_fork_count = 1
  end
end

#amqp ⇒ String

Returns Location of your RabbitMQ server. Default: “amqp://guest:guest@localhost:5672/”.

Returns:

  • (String) —

    Location of your RabbitMQ server. Default: “amqp://guest:guest@localhost:5672/”



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/leveret/configuration.rb', line 35

class Configuration
  attr_accessor :amqp, :exchange_name, :queue_name_prefix, :log_file, :log_level, :default_queue_name, :after_fork,
    :error_handler, :concurrent_fork_count, :delay_exchange_name, :delay_queue_name, :delay_time

  # Create a new instance of Configuration with a set of sane defaults.
  def initialize
    assign_defaults
  end

  private

  def assign_defaults
    self.amqp = "amqp://guest:guest@localhost:5672"
    self.exchange_name = 'leveret_exch'
    self.log_file = STDOUT
    self.log_level = Logger::DEBUG
    self.queue_name_prefix = 'leveret_queue'
    self.default_queue_name = 'standard'
    self.delay_exchange_name = 'leveret_delay_exch'
    self.delay_queue_name = 'leveret_delay_queue'
    self.delay_time = 10_000
    self.after_fork = proc {}
    self.error_handler = proc { |ex| ex }
    self.concurrent_fork_count = 1
  end
end

#concurrent_fork_count ⇒ Integer

Returns The number of jobs that can be processes simultanously. Default: 1.

Returns:

  • (Integer) —

    The number of jobs that can be processes simultanously. Default: 1



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/leveret/configuration.rb', line 35

class Configuration
  attr_accessor :amqp, :exchange_name, :queue_name_prefix, :log_file, :log_level, :default_queue_name, :after_fork,
    :error_handler, :concurrent_fork_count, :delay_exchange_name, :delay_queue_name, :delay_time

  # Create a new instance of Configuration with a set of sane defaults.
  def initialize
    assign_defaults
  end

  private

  def assign_defaults
    self.amqp = "amqp://guest:guest@localhost:5672"
    self.exchange_name = 'leveret_exch'
    self.log_file = STDOUT
    self.log_level = Logger::DEBUG
    self.queue_name_prefix = 'leveret_queue'
    self.default_queue_name = 'standard'
    self.delay_exchange_name = 'leveret_delay_exch'
    self.delay_queue_name = 'leveret_delay_queue'
    self.delay_time = 10_000
    self.after_fork = proc {}
    self.error_handler = proc { |ex| ex }
    self.concurrent_fork_count = 1
  end
end

#default_queue_name ⇒ String

Returns The name of the queue that will be use unless explicitly specified in a job. Default: “standard”.

Returns:

  • (String) —

    The name of the queue that will be use unless explicitly specified in a job. Default: “standard”



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/leveret/configuration.rb', line 35

class Configuration
  attr_accessor :amqp, :exchange_name, :queue_name_prefix, :log_file, :log_level, :default_queue_name, :after_fork,
    :error_handler, :concurrent_fork_count, :delay_exchange_name, :delay_queue_name, :delay_time

  # Create a new instance of Configuration with a set of sane defaults.
  def initialize
    assign_defaults
  end

  private

  def assign_defaults
    self.amqp = "amqp://guest:guest@localhost:5672"
    self.exchange_name = 'leveret_exch'
    self.log_file = STDOUT
    self.log_level = Logger::DEBUG
    self.queue_name_prefix = 'leveret_queue'
    self.default_queue_name = 'standard'
    self.delay_exchange_name = 'leveret_delay_exch'
    self.delay_queue_name = 'leveret_delay_queue'
    self.delay_time = 10_000
    self.after_fork = proc {}
    self.error_handler = proc { |ex| ex }
    self.concurrent_fork_count = 1
  end
end

#delay_exchange_name ⇒ String

Returns Name of the exchange for Leveret to publish messages to. Default: “leveret_exch”.

Returns:

  • (String) —

    Name of the exchange for Leveret to publish messages to. Default: “leveret_exch”



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/leveret/configuration.rb', line 35

class Configuration
  attr_accessor :amqp, :exchange_name, :queue_name_prefix, :log_file, :log_level, :default_queue_name, :after_fork,
    :error_handler, :concurrent_fork_count, :delay_exchange_name, :delay_queue_name, :delay_time

  # Create a new instance of Configuration with a set of sane defaults.
  def initialize
    assign_defaults
  end

  private

  def assign_defaults
    self.amqp = "amqp://guest:guest@localhost:5672"
    self.exchange_name = 'leveret_exch'
    self.log_file = STDOUT
    self.log_level = Logger::DEBUG
    self.queue_name_prefix = 'leveret_queue'
    self.default_queue_name = 'standard'
    self.delay_exchange_name = 'leveret_delay_exch'
    self.delay_queue_name = 'leveret_delay_queue'
    self.delay_time = 10_000
    self.after_fork = proc {}
    self.error_handler = proc { |ex| ex }
    self.concurrent_fork_count = 1
  end
end

#delay_queue_name ⇒ String

Returns Name of the queue for Leveret to use to store messages that should be processed later. Default: “leveret_delay_queue”.

Returns:

  • (String) —

    Name of the queue for Leveret to use to store messages that should be processed later. Default: “leveret_delay_queue”



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/leveret/configuration.rb', line 35

class Configuration
  attr_accessor :amqp, :exchange_name, :queue_name_prefix, :log_file, :log_level, :default_queue_name, :after_fork,
    :error_handler, :concurrent_fork_count, :delay_exchange_name, :delay_queue_name, :delay_time

  # Create a new instance of Configuration with a set of sane defaults.
  def initialize
    assign_defaults
  end

  private

  def assign_defaults
    self.amqp = "amqp://guest:guest@localhost:5672"
    self.exchange_name = 'leveret_exch'
    self.log_file = STDOUT
    self.log_level = Logger::DEBUG
    self.queue_name_prefix = 'leveret_queue'
    self.default_queue_name = 'standard'
    self.delay_exchange_name = 'leveret_delay_exch'
    self.delay_queue_name = 'leveret_delay_queue'
    self.delay_time = 10_000
    self.after_fork = proc {}
    self.error_handler = proc { |ex| ex }
    self.concurrent_fork_count = 1
  end
end

#delay_time ⇒ Integer

Returns Amount of time a delayed message should say on the delay queue in milliseconds Default: 10000.

Returns:

  • (Integer) —

    Amount of time a delayed message should say on the delay queue in milliseconds Default: 10000



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/leveret/configuration.rb', line 35

class Configuration
  attr_accessor :amqp, :exchange_name, :queue_name_prefix, :log_file, :log_level, :default_queue_name, :after_fork,
    :error_handler, :concurrent_fork_count, :delay_exchange_name, :delay_queue_name, :delay_time

  # Create a new instance of Configuration with a set of sane defaults.
  def initialize
    assign_defaults
  end

  private

  def assign_defaults
    self.amqp = "amqp://guest:guest@localhost:5672"
    self.exchange_name = 'leveret_exch'
    self.log_file = STDOUT
    self.log_level = Logger::DEBUG
    self.queue_name_prefix = 'leveret_queue'
    self.default_queue_name = 'standard'
    self.delay_exchange_name = 'leveret_delay_exch'
    self.delay_queue_name = 'leveret_delay_queue'
    self.delay_time = 10_000
    self.after_fork = proc {}
    self.error_handler = proc { |ex| ex }
    self.concurrent_fork_count = 1
  end
end

#error_handler ⇒ Proc

Returns A proc which will be called if a job raises an exception. Default: proc {|ex| ex }.

Returns:

  • (Proc) —

    A proc which will be called if a job raises an exception. Default: proc {|ex| ex }



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/leveret/configuration.rb', line 35

class Configuration
  attr_accessor :amqp, :exchange_name, :queue_name_prefix, :log_file, :log_level, :default_queue_name, :after_fork,
    :error_handler, :concurrent_fork_count, :delay_exchange_name, :delay_queue_name, :delay_time

  # Create a new instance of Configuration with a set of sane defaults.
  def initialize
    assign_defaults
  end

  private

  def assign_defaults
    self.amqp = "amqp://guest:guest@localhost:5672"
    self.exchange_name = 'leveret_exch'
    self.log_file = STDOUT
    self.log_level = Logger::DEBUG
    self.queue_name_prefix = 'leveret_queue'
    self.default_queue_name = 'standard'
    self.delay_exchange_name = 'leveret_delay_exch'
    self.delay_queue_name = 'leveret_delay_queue'
    self.delay_time = 10_000
    self.after_fork = proc {}
    self.error_handler = proc { |ex| ex }
    self.concurrent_fork_count = 1
  end
end

#exchange_name ⇒ String

Returns Name of the exchange for Leveret to publish messages to. Default: “leveret_exch”.

Returns:

  • (String) —

    Name of the exchange for Leveret to publish messages to. Default: “leveret_exch”



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/leveret/configuration.rb', line 35

class Configuration
  attr_accessor :amqp, :exchange_name, :queue_name_prefix, :log_file, :log_level, :default_queue_name, :after_fork,
    :error_handler, :concurrent_fork_count, :delay_exchange_name, :delay_queue_name, :delay_time

  # Create a new instance of Configuration with a set of sane defaults.
  def initialize
    assign_defaults
  end

  private

  def assign_defaults
    self.amqp = "amqp://guest:guest@localhost:5672"
    self.exchange_name = 'leveret_exch'
    self.log_file = STDOUT
    self.log_level = Logger::DEBUG
    self.queue_name_prefix = 'leveret_queue'
    self.default_queue_name = 'standard'
    self.delay_exchange_name = 'leveret_delay_exch'
    self.delay_queue_name = 'leveret_delay_queue'
    self.delay_time = 10_000
    self.after_fork = proc {}
    self.error_handler = proc { |ex| ex }
    self.concurrent_fork_count = 1
  end
end

#log_file ⇒ String

Returns The path where logfiles should be written to. Default: STDOUT.

Returns:

  • (String) —

    The path where logfiles should be written to. Default: STDOUT



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/leveret/configuration.rb', line 35

class Configuration
  attr_accessor :amqp, :exchange_name, :queue_name_prefix, :log_file, :log_level, :default_queue_name, :after_fork,
    :error_handler, :concurrent_fork_count, :delay_exchange_name, :delay_queue_name, :delay_time

  # Create a new instance of Configuration with a set of sane defaults.
  def initialize
    assign_defaults
  end

  private

  def assign_defaults
    self.amqp = "amqp://guest:guest@localhost:5672"
    self.exchange_name = 'leveret_exch'
    self.log_file = STDOUT
    self.log_level = Logger::DEBUG
    self.queue_name_prefix = 'leveret_queue'
    self.default_queue_name = 'standard'
    self.delay_exchange_name = 'leveret_delay_exch'
    self.delay_queue_name = 'leveret_delay_queue'
    self.delay_time = 10_000
    self.after_fork = proc {}
    self.error_handler = proc { |ex| ex }
    self.concurrent_fork_count = 1
  end
end

#log_level ⇒ Integer

Returns The log severity which should be output to the log. Default: Logger::DEBUG.

Returns:

  • (Integer) —

    The log severity which should be output to the log. Default: Logger::DEBUG



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/leveret/configuration.rb', line 35

class Configuration
  attr_accessor :amqp, :exchange_name, :queue_name_prefix, :log_file, :log_level, :default_queue_name, :after_fork,
    :error_handler, :concurrent_fork_count, :delay_exchange_name, :delay_queue_name, :delay_time

  # Create a new instance of Configuration with a set of sane defaults.
  def initialize
    assign_defaults
  end

  private

  def assign_defaults
    self.amqp = "amqp://guest:guest@localhost:5672"
    self.exchange_name = 'leveret_exch'
    self.log_file = STDOUT
    self.log_level = Logger::DEBUG
    self.queue_name_prefix = 'leveret_queue'
    self.default_queue_name = 'standard'
    self.delay_exchange_name = 'leveret_delay_exch'
    self.delay_queue_name = 'leveret_delay_queue'
    self.delay_time = 10_000
    self.after_fork = proc {}
    self.error_handler = proc { |ex| ex }
    self.concurrent_fork_count = 1
  end
end

#queue_name_prefix ⇒ String

Returns This value will be prefixed to all queues created on your RabbitMQ instance. Default: “leveret_queue”.

Returns:

  • (String) —

    This value will be prefixed to all queues created on your RabbitMQ instance. Default: “leveret_queue”



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/leveret/configuration.rb', line 35

class Configuration
  attr_accessor :amqp, :exchange_name, :queue_name_prefix, :log_file, :log_level, :default_queue_name, :after_fork,
    :error_handler, :concurrent_fork_count, :delay_exchange_name, :delay_queue_name, :delay_time

  # Create a new instance of Configuration with a set of sane defaults.
  def initialize
    assign_defaults
  end

  private

  def assign_defaults
    self.amqp = "amqp://guest:guest@localhost:5672"
    self.exchange_name = 'leveret_exch'
    self.log_file = STDOUT
    self.log_level = Logger::DEBUG
    self.queue_name_prefix = 'leveret_queue'
    self.default_queue_name = 'standard'
    self.delay_exchange_name = 'leveret_delay_exch'
    self.delay_queue_name = 'leveret_delay_queue'
    self.delay_time = 10_000
    self.after_fork = proc {}
    self.error_handler = proc { |ex| ex }
    self.concurrent_fork_count = 1
  end
end