Class: Moneta::Adapters::MemcachedDalli

Inherits:
Object
  • Object
show all
Includes:
Defaults, ExpiresSupport
Defined in:
lib/moneta/adapters/memcached/dalli.rb

Overview

Memcached backend (using gem dalli)

Instance Attribute Summary collapse

Attributes included from ExpiresSupport

#default_expires

Instance Method Summary collapse

Methods included from Defaults

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

Methods included from OptionSupport

#expires, #prefix, #raw, #with

Constructor Details

#initialize(options = {}) ⇒ MemcachedDalli

Returns a new instance of MemcachedDalli

Parameters:

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

Options Hash (options):

  • :server (String) — default: '127.0.0.1:11211'

    Memcached server

  • :expires (Integer)

    Default expiration time

  • :backend (::Dalli::Client)

    Use existing backend instance

  • Other (Object)

    options passed to `Dalli::Client#new`


19
20
21
22
23
24
25
26
# File 'lib/moneta/adapters/memcached/dalli.rb', line 19

def initialize(options = {})
  self.default_expires = options.delete(:expires)
  @backend = options[:backend] ||
    begin
      server = options.delete(:server) || '127.0.0.1:11211'
      ::Dalli::Client.new(server, options)
    end
end

Instance Attribute Details

#backendObject (readonly)


12
13
14
# File 'lib/moneta/adapters/memcached/dalli.rb', line 12

def backend
  @backend
end

Instance Method Details

#clear(options = {}) ⇒ void

This method returns an undefined value.

Clear all keys in this store

Parameters:

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

72
73
74
75
# File 'lib/moneta/adapters/memcached/dalli.rb', line 72

def clear(options = {})
  @backend.flush_all
  self
end

#closeObject

Explicitly close the store

Returns:

  • nil


83
84
85
86
# File 'lib/moneta/adapters/memcached/dalli.rb', line 83

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


78
79
80
# File 'lib/moneta/adapters/memcached/dalli.rb', line 78

def create(key, value, options = {})
  !!@backend.add(key, value, expires_value(options) || nil, raw: true)
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


45
46
47
48
49
# File 'lib/moneta/adapters/memcached/dalli.rb', line 45

def delete(key, options = {})
  value = @backend.get(key)
  @backend.delete(key)
  value
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


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/moneta/adapters/memcached/dalli.rb', line 52

def increment(key, amount = 1, options = {})
  # FIXME: There is a Dalli bug, load(key) returns a wrong value after increment
  # therefore we set default = nil and create the counter manually
  # See https://github.com/mperham/dalli/issues/309
  result =
    if amount >= 0
      @backend.incr(key, amount, expires_value(options) || nil, nil)
    else
      @backend.decr(key, -amount, expires_value(options) || nil, nil)
    end
  if result
    result
  elsif create(key, amount.to_s, options)
    amount
  else
    increment(key, amount, options)
  end
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


29
30
31
32
33
34
35
36
# File 'lib/moneta/adapters/memcached/dalli.rb', line 29

def load(key, options = {})
  value = @backend.get(key)
  if value
    expires = expires_value(options, nil)
    @backend.set(key, value, expires || nil, raw: true) if expires != nil
    value
  end
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


39
40
41
42
# File 'lib/moneta/adapters/memcached/dalli.rb', line 39

def store(key, value, options = {})
  @backend.set(key, value, expires_value(options) || nil, raw: true)
  value
end