README.md in backburner-1.3.1 vs README.md in backburner-1.4.0

- old
+ new

@@ -86,11 +86,11 @@ Backburner is extremely simple to setup. Just configure basic settings for backburner: ```ruby Backburner.configure do |config| - config.beanstalk_url = ["beanstalk://127.0.0.1", "..."] + config.beanstalk_url = "beanstalk://127.0.0.1" config.tube_namespace = "some.app.production" config.namespace_separator = "." config.on_error = lambda { |e| puts e } config.max_job_retries = 3 # default 0 retries config.retry_delay = 2 # default 5 seconds @@ -100,18 +100,21 @@ config.default_worker = Backburner::Workers::Simple config.logger = Logger.new(STDOUT) config.primary_queue = "backburner-jobs" config.priority_labels = { :custom => 50, :useless => 1000 } config.reserve_timeout = nil + config.job_serializer_proc = lambda { |body| JSON.dump(body) } + config.job_parser_proc = lambda { |body| JSON.parse(body) } + end ``` The key options available are: | Option | Description | | ----------------- | ------------------------------- | -| `beanstalk_url` | Address such as 'beanstalk://127.0.0.1' or an array of addresses. | +| `beanstalk_url` | Address for beanstalkd connection i.e 'beanstalk://127.0.0.1' | | `tube_namespace` | Prefix used for all tubes related to this backburner queue. | | `namespace_separator` | Separator used for namespace and queue name | | `on_error` | Lambda invoked with the error whenever any job in the system fails. | | `max_job_retries` | Integer defines how many times to retry a job before burying. | | `retry_delay` | Integer defines the base time to wait (in secs) between job retries. | @@ -121,9 +124,11 @@ | `default_worker` | Worker class that will be used if no other worker is specified. | | `logger` | Logger recorded to when backburner wants to report info or errors. | | `primary_queue` | Primary queue used for a job when an alternate queue is not given. | | `priority_labels` | Hash of named priority definitions for your app. | | `reserve_timeout` | Duration to wait for work from a single server, or nil for forever. | +| `job_serializer_proc` | Lambda serializes a job body to a string to write to the task | +| `job_parser_proc` | Lambda parses a task body string to a hash | ## Breaking Changes Before **v0.4.0**: Jobs were placed into default queues based on the name of the class creating the queue. i.e NewsletterJob would be put into a 'newsletter-job' queue. As of 0.4.0, all jobs are placed into a primary queue named "my.app.namespace.backburner-jobs"