Class: Moneta::Adapters::TokyoTyrant

Inherits:
Object
  • Object
show all
Includes:
Defaults, HashAdapter
Defined in:
lib/moneta/adapters/tokyotyrant.rb

Overview

TokyoTyrant backend

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HashAdapter

#clear, #key?

Methods included from Defaults

#[], #[]=, #decrement, #features, #fetch, included, #key?, #supports?

Methods included from OptionSupport

#expires, #prefix, #raw, #with

Constructor Details

#initialize(options = {}) ⇒ TokyoTyrant

Returns a new instance of TokyoTyrant.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :host (String) — default: '127.0.0.1' —

    Server host name

  • :port (Integer) — default: 1978 —

    Server port

  • :backend (::TokyoTyrant::RDB) —

    Use existing backend instance



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/moneta/adapters/tokyotyrant.rb', line 24

def initialize(options = {})
  options[:host] ||= '127.0.0.1'
  options[:port] ||= 1978
  if options[:backend]
    @backend = options[:backend]
  elsif defined?(::TokyoTyrant::RDB)
    # Use ruby client
    @backend = ::TokyoTyrant::RDB.new
    @backend.open(options[:host], options[:port]) or raise @backend.errmsg(@backend.ecode)
  else
    # Use native client
    @backend = ::TokyoTyrant::DB.new(options[:host], options[:port])
  end
  @native = @backend.class.name != 'TokyoTyrant::RDB'
  probe = '__tokyotyrant_endianness_probe'
  @backend.delete(probe)
  @backend.addint(probe, 1)
  @pack = @backend.delete(probe) == [1].pack('l>') ? 'l>' : 'l<'
end

Instance Attribute Details

#backend ⇒ Object (readonly) 



18
19
20
 
# File 'lib/moneta/adapters/tokyotyrant.rb', line 18

def backend
  @backend
end

Instance Method Details

#close ⇒ Object

Explicitly close the store

Returns:

  • nil



85
86
87
88
 
# File 'lib/moneta/adapters/tokyotyrant.rb', line 85

def close
  @backend.close
  nil
end

#create(key, value, options = {}) ⇒ Boolean

Note:

Not every Moneta store implements this method, a NotImplementedError is raised if it is not supported.

Atomically sets a key to value if it’s not set.

Parameters:

  • key (Object)
  • value (Object)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :expires (Integer) —

    Update expiration time (See Expires)

  • :raw (Boolean) —

    Raw access without value transformation (See Transformer)

  • :prefix (String) —

    Prefix key (See Transformer)

Returns:

  • (Boolean) —

    key was set



71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/moneta/adapters/tokyotyrant.rb', line 71

def create(key, value, options = {})
  if @native
    begin
      # Native client throws an exception
      @backend.putkeep(key, pack(value))
    rescue TokyoTyrantError
      false
    end
  else
    @backend.putkeep(key, pack(value))
  end
end

#delete(key, options = {}) ⇒ Object

Delete the key from the store and return the current value

Parameters:

  • key (Object)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :raw (Boolean) —

    Raw access without value transformation (See Transformer)

  • :prefix (String) —

    Prefix key (See Transformer)

  • Other (Object) —

    options as defined by the adapters or middleware

Returns:

  • (Object) —

    current value



57
58
59
60
61
62
63
 
# File 'lib/moneta/adapters/tokyotyrant.rb', line 57

def delete(key, options = {})
  value = load(key, options)
  if value
    @backend.delete(key)
    value
  end
end

#increment(key, amount = 1, options = {}) ⇒ Object

Note:

Not every Moneta store implements this method, a NotImplementedError is raised if it is not supported.

Atomically increment integer value with key

This method also accepts negative amounts.

Parameters:

  • key (Object)
  • amount (Integer) (defaults to: 1)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :prefix (String) —

    Prefix key (See Transformer)

  • Other (Object) —

    options as defined by the adapters or middleware

Returns:

  • (Object) —

    value from store



66
67
68
 
# File 'lib/moneta/adapters/tokyotyrant.rb', line 66

def increment(key, amount = 1, options = {})
  @backend.addint(key, amount) || raise('Tried to increment non integer value')
end

#load(key, options = {}) ⇒ Object

Fetch value with key. Return nil if the key doesn’t exist

Parameters:

  • key (Object)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :expires (Integer) —

    Update expiration time (See Expires)

  • :raw (Boolean) —

    Raw access without value transformation (See Transformer)

  • :prefix (String) —

    Prefix key (See Transformer)

  • :sync (Boolean) —

    Synchronized load (Cache reloads from adapter, Daybreak syncs with file)

  • Other (Object) —

    options as defined by the adapters or middleware

Returns:

  • (Object) —

    value



45
46
47
48
 
# File 'lib/moneta/adapters/tokyotyrant.rb', line 45

def load(key, options = {})
  value = @backend[key]
  value && unpack(value)
end

#store(key, value, options = {}) ⇒ Object

Store value with key

Parameters:

  • key (Object)
  • value (Object)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :expires (Integer) —

    Set expiration time (See Expires)

  • :raw (Boolean) —

    Raw access without value transformation (See Transformer)

  • :prefix (String) —

    Prefix key (See Transformer)

  • Other (Object) —

    options as defined by the adapters or middleware

Returns:

  • value



51
52
53
54
 
# File 'lib/moneta/adapters/tokyotyrant.rb', line 51

def store(key, value, options = {})
  @backend[key] = pack(value)
  value
end