Module: TorqueBox::Messaging::Backgroundable

Defined in:

lib/torquebox/messaging/backgroundable.rb

Overview

Backgroundable provides mechanism for executing an object’s methods asynchronously.

Defined Under Namespace

Modules: ClassMethods, Util Classes: BackgroundProxy

Constant Summary

MUTEX =

Mutex.new

Class Method Summary

• .included(base) ⇒ Object
• .newrelic_available? ⇒ Boolean

  Signals if the newrelic gem is loaded.

Instance Method Summary

• #background(options = { }) ⇒ Future

  Allows you to background any method that has not been marked as a backgrounded method via ClassMethods#always_background.

Class Method Details

.included(base) ⇒ Object

# File 'lib/torquebox/messaging/backgroundable.rb', line 33

def self.included(base)
  base.extend(ClassMethods)
  base.send(:include, FutureStatus)
end

.newrelic_available? ⇒ Boolean

Signals if the newrelic gem is loaded.

Returns:

• (Boolean)

# File 'lib/torquebox/messaging/backgroundable.rb', line 39

def self.newrelic_available?
  defined?(NewRelic::Agent)
end

Instance Method Details

#background(options = { }) ⇒ Future

Allows you to background any method that has not been marked as a backgrounded method via TorqueBox::Messaging::Backgroundable::ClassMethods#always_background.

Parameters:

• options (Hash) (defaults to: { }) —

  that are passed through to Destination#publish

Returns:

• (Future)

# File 'lib/torquebox/messaging/backgroundable.rb', line 48

def background(options = { })
  BackgroundProxy.new(self, options)
end