Module: Riffer

Defined in:

lib/riffer.rb,
lib/riffer/version.rb

Defined Under Namespace

Modules: Messages, Providers, StreamEvents Classes: Agent, ArgumentError, Config, Core, Error

Constant Summary

VERSION =

"0.3.0"

Class Method Summary

• .config ⇒ Riffer::Config

  Returns the Riffer configuration.

• .configure {|config| ... } ⇒ void

  Yields the configuration for block-based setup.

• .version ⇒ String

  Returns the gem version.

Class Method Details

.config ⇒ Riffer::Config

Returns the Riffer configuration

Returns:

• (Riffer::Config)

# File 'lib/riffer.rb', line 35

def config
  @config ||= Config.new
end

.configure {|config| ... } ⇒ void

This method returns an undefined value.

Yields the configuration for block-based setup

Yield Parameters:

• config (Riffer::Config) —

  the configuration object

# File 'lib/riffer.rb', line 42

def configure
  yield config if block_given?
end

.version ⇒ String

Returns the gem version

Returns:

• (String) —

  the version string

# File 'lib/riffer.rb', line 48

def version
  VERSION
end