Class: RedisSingleFile::Configuration

Inherits:
Object
  • Object
show all
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 collapse

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'

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#expire_in ⇒ String

Returns redis keys expiration value.

Returns:

  • (String) —

    redis keys expiration value



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

def expire_in = @expire_in || DEFAULT_EXPIRE_IN

#host ⇒ String

Returns redis server hostname value.

Returns:

  • (String) —

    redis server hostname value



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

def host = @host || DEFAULT_HOST

#name ⇒ String

Returns default queue name when omitted.

Returns:

  • (String) —

    default queue name when omitted



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

def name = @name || DEFAULT_NAME

#port ⇒ String

Returns redis server port value.

Returns:

  • (String) —

    redis server port value



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

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



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

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



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

def queue_key = @queue_key || DEFAULT_QUEUE_KEY