Class: RedisSingleFile::Configuration

Inherits:

Object

• Object
• RedisSingleFile::Configuration

Includes:

Singleton

Defined in:

lib/redis_single_file/configuration.rb

Overview

This class provides the ability to configure redis single file.

Examples:

RedisSingleFile configuration

RedisSingleFile.configuration do |config|
  config.host = 'localhost'
  config.port = '6379'
  config.name = 'default'
  config.expire_in = 300
end

Returns:

• (self) —

  the configuration instance

Author:

• lifeBCE

Constant Summary

DEFAULT_HOST =

configuration defaults when not provided

'localhost'

DEFAULT_PORT =

'6379'

DEFAULT_NAME =

'default'

DEFAULT_EXPIRE_IN =

5 mins

300

DEFAULT_MUTEX_KEY =

'RedisSingleFile/Mutex/%s'

DEFAULT_QUEUE_KEY =

'RedisSingleFile/Queue/%s'

DEFAULT_CONCURRENCY =

single slot enabled

1

Instance Attribute Summary

• #concurrency ⇒ String

  Redis lock concurrency value.

• #expire_in ⇒ String

  Redis keys expiration value.

• #host ⇒ String

  Redis server hostname value.

• #name ⇒ String

  Default queue name when omitted.

• #port ⇒ String

  Redis server port value.

Instance Method Summary

• #mutex_key ⇒ String

  Synchronization mutex key name.

• #queue_key ⇒ String

  Synchronization queue key name.

Instance Attribute Details

#concurrency ⇒ String

Returns redis lock concurrency value.

Returns:

• (String) —

  redis lock concurrency value

# File 'lib/redis_single_file/configuration.rb', line 66

def concurrency = @concurrency || DEFAULT_CONCURRENCY

#expire_in ⇒ String

Returns redis keys expiration value.

Returns:

• (String) —

  redis keys expiration value

# File 'lib/redis_single_file/configuration.rb', line 63

def expire_in = @expire_in || DEFAULT_EXPIRE_IN

#host ⇒ String

Returns redis server hostname value.

Returns:

• (String) —

  redis server hostname value

# File 'lib/redis_single_file/configuration.rb', line 54

def host = @host || DEFAULT_HOST

#name ⇒ String

Returns default queue name when omitted.

Returns:

• (String) —

  default queue name when omitted

# File 'lib/redis_single_file/configuration.rb', line 60

def name = @name || DEFAULT_NAME

#port ⇒ String

Returns redis server port value.

Returns:

• (String) —

  redis server port value

# File 'lib/redis_single_file/configuration.rb', line 57

def port = @port || DEFAULT_PORT

Instance Method Details

#mutex_key ⇒ String

Note:

This attr is not configurable

Returns synchronization mutex key name.

Returns:

• (String) —

  synchronization mutex key name

# File 'lib/redis_single_file/configuration.rb', line 70

def mutex_key = @mutex_key || DEFAULT_MUTEX_KEY

#queue_key ⇒ String

Note:

This attr is not configurable

Returns synchronization queue key name.

Returns:

• (String) —

  synchronization queue key name

# File 'lib/redis_single_file/configuration.rb', line 74

def queue_key = @queue_key || DEFAULT_QUEUE_KEY