module Announce

publish, subscribe, & configure_broker are the 3 required methods for adapters the base adapter also has helpful base classes, but they are not necessary you can write an adapter from scratch, but these 3 class methods are required.

Constants

VERSION

Public Class Methods

adapter_class() click to toggle source 
# File lib/announce.rb, line 36
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 31
def configure(opts = {})
  Announce::Configuration.configure(opts)
  yield @options if block_given?
end
configure_broker(opts = {}) click to toggle source 
# File lib/announce.rb, line 23
def configure_broker(opts = {})
  adapter_class.configure_broker(options.merge(opts))
end
logger() click to toggle source 
# File lib/announce.rb, line 43
def logger
  @logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
end
logger=(l) click to toggle source 
# File lib/announce.rb, line 47
def logger=(l)
  @logger = l
end
options() click to toggle source 
# File lib/announce.rb, line 27
def options
  @options ||= Announce::Configuration.default_options
end
publish(subject, action, message, options = {}) click to toggle source 
# File lib/announce.rb, line 13
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 19
def subscribe(worker_class, subject, actions = [], options = {})
  adapter_class.subscribe(worker_class, subject, actions, options)
end