class Beaneater
Constants
- VERSION
Current version of gem.
Attributes
connection[R]
@!attribute connection
@return <Beaneater::Connection> returns the associated connection object
Public Class Methods
new(address=nil)
click to toggle source
Initialize new instance of Beaneater
@param [String] address in the form “host:port” @example
Beaneater.new('127.0.0.1:11300') ENV['BEANSTALKD_URL'] = '127.0.0.1:11300' @b = Beaneater.new @b.connection.host # => '127.0.0.1' @b.connection.port # => '11300'
# File lib/beaneater.rb, line 24 def initialize(address=nil) @connection = Connection.new(address) end
Protected Class Methods
configuration()
click to toggle source
Returns the configuration options set for Backburner
@example
Beaneater.configuration.default_put_ttr => 120
# File lib/beaneater.rb, line 81 def configuration @_configuration ||= Configuration.new end
configure() { |configuration| ... }
click to toggle source
Yields a configuration block
@example
Beaneater.configure do |config| config.job_parser = lamda { |body| Yaml.load(body)} end
# File lib/beaneater.rb, line 71 def configure(&block) yield(configuration) if block_given? configuration end
Public Instance Methods
close()
click to toggle source
Closes the related connection
@example
@beaneater_instance.close
# File lib/beaneater.rb, line 57 def close connection.close if connection end
jobs()
click to toggle source
Returns Beaneater::Jobs
object for accessing job related functions.
@return [Beaneater::Jobs] jobs object @api public
# File lib/beaneater.rb, line 40 def jobs @jobs ||= Beaneater::Jobs.new(self) end
stats()
click to toggle source
Returns Beaneater::Stats
object for accessing beanstalk stats.
@return [Beaneater::Stats] stats object @api public
# File lib/beaneater.rb, line 48 def stats @stats ||= Stats.new(self) end
tubes()
click to toggle source
Returns Beaneater::Tubes
object for accessing tube related functions.
@return [Beaneater::Tubes] tubes object @api public
# File lib/beaneater.rb, line 32 def tubes @tubes ||= Beaneater::Tubes.new(self) end