module Emittance

The base namespace for this library. You can do some basic configuration stuff by calling methods on its singleton.

Constants

VERSION

Public Class Methods

broker() click to toggle source

@return [Class] the currently enabled broker class

# File lib/emittance.rb, line 39
def broker
  Emittance::Brokerage.broker
end

disable!() click to toggle source

Disable eventing process-wide

# File lib/emittance.rb, line 29
def disable!
  Emittance::Brokerage.disable!
end

dispatcher() click to toggle source

@return [Class] the dispatcher attached to the currently enabled broker

# File lib/emittance.rb, line 44
def dispatcher
  broker.dispatcher
end

enable!() click to toggle source

Enable eventing process-wide

# File lib/emittance.rb, line 24
def enable!
  Emittance::Brokerage.enable!
end

enabled?() click to toggle source

@return [Boolean] true if eventing is enabled, false otherwise

# File lib/emittance.rb, line 34
def enabled?
  Emittance::Brokerage.enabled?
end

suppress(&_blk) click to toggle source

Not yet implemented! Remove nocov and private flags when finished. :nocov: @private

# File lib/emittance.rb, line 56
def suppress(&_blk)
  raise NotImplementedError, "This isn't working yet!"
  # Emittance::Dispatcher.suppress(&blk)
end

use_broker(identifier) click to toggle source

@param [identifier] the identifier that can be used to identify the broker you wish to use

# File lib/emittance.rb, line 49
def use_broker(identifier)
  Emittance::Brokerage.use_broker identifier
end