module Announce

publish, subscribe, and configure_broker are the 3 required methods for an adapter this base adapter also has some helpful base classes, but they are not necessary you could write an adapter from scratch so long as the class has these 3 class methods.

Constants

VERSION

Public Class Methods

adapter_class() click to toggle source 
# File lib/announce.rb, line 37
def adapter_class
  announce_adapter = Announce.options[:adapter]
  require "announce/adapters/#{announce_adapter.to_s.downcase}_adapter"
  "::Announce::Adapters::#{announce_adapter.to_s.camelize}Adapter".constantize
end
announce(subject, action, message, options={})
Alias for: publish
configure(opts = {}) { |options| ... } click to toggle source 
# File lib/announce.rb, line 32
def configure(opts = {})
  Announce::Configuration.configure(opts)
  yield @options if block_given?
end
configure_broker() click to toggle source 
# File lib/announce.rb, line 24
def configure_broker
  adapter_class.configure_broker(options)
end
logger() click to toggle source 
# File lib/announce.rb, line 43
def logger
  @logger ||= if defined?(Rails)
    Rails.logger
  else
    Logger.new(STDOUT)
  end
end
logger=(l) click to toggle source 
# File lib/announce.rb, line 51
def logger=(l)
  @logger = l
end
options() click to toggle source 
# File lib/announce.rb, line 28
def options
  @options ||= Announce::Configuration.default_options
end
publish(subject, action, message, options={}) click to toggle source 
# File lib/announce.rb, line 14
def publish(subject, action, message, options={})
  adapter_class.publish(subject, action, message, options)
end
Also aliased as: announce
subscribe(worker_class, subject, actions = [], options = {}) click to toggle source 
# File lib/announce.rb, line 20
def subscribe(worker_class, subject, actions = [], options = {})
  adapter_class.subscribe(worker_class, subject, actions, options)
end