Class: Memcache

Inherits:
Object show all
Defined in:
lib/memcache.rb,
lib/memcache/base.rb,
lib/memcache/server.rb,
lib/memcache/migration.rb,
lib/memcache/pg_server.rb,
lib/memcache/segmented.rb,
lib/memcache/null_server.rb,
lib/memcache/local_server.rb,
ext/native_server.c

Defined Under Namespace

Modules: Segmented Classes: Base, ClientError, ConnectionError, Error, LocalServer, Migration, NativeServer, NullServer, PGServer, Pool, SegmentedNativeServer, SegmentedServer, Server, ServerError

Constant Summary collapse

DEFAULT_EXPIRY = 
0
LOCK_TIMEOUT = 
5
WRITE_LOCK_WAIT = 
1

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts) ⇒ Memcache

Returns a new instance of Memcache.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/memcache.rb', line 35

def initialize(opts)
  @default_expiry   = opts[:default_expiry] || DEFAULT_EXPIRY
  @backup           = opts[:backup] # for multi-level caches
  @hash_with_prefix = opts[:hash_with_prefix].nil? ? true : opts[:hash_with_prefix]

  if opts[:native]
    native_opts = opts.clone
    native_opts[:servers] = (opts[:servers] || [ opts[:server] ]).collect do |server|
      server.is_a?(Hash) ? "#{server[:host]}:#{server[:port]}:#{server[:weight]}" : server
    end
    native_opts[:hash] ||= :crc unless native_opts[:ketama] or native_opts[:ketama_wieghted]
    native_opts[:hash_with_prefix] = @hash_with_prefix

    server_class = opts[:segment_large_values] ? SegmentedNativeServer : NativeServer
    @servers = [server_class.new(native_opts)]
  else
    raise "only CRC hashing is supported unless :native => true" if opts[:hash] and opts[:hash] != :crc

    server_class = opts[:segment_large_values] ? SegmentedServer : Server
    @servers = (opts[:servers] || [ opts[:server] ]).collect do |server|
      case server
      when Hash
        server = server_class.new(opts.merge(server))
      when String
        host, port = server.split(':')
        server = server_class.new(opts.merge(:host => host, :port => port))
      when Class
        server = server.new
      when :local
        server = Memcache::LocalServer.new
      end
      server
    end
  end

  @server = @servers.first if @servers.size == 1 and @backup.nil?
  self.namespace = opts[:namespace] if opts[:namespace]
end

Instance Attribute Details

#backup ⇒ Object (readonly)

Returns the value of attribute backup.



19
20
21
 
# File 'lib/memcache.rb', line 19

def backup
  @backup
end

#default_expiry ⇒ Object (readonly)

Returns the value of attribute default_expiry.



19
20
21
 
# File 'lib/memcache.rb', line 19

def default_expiry
  @default_expiry
end

#namespace ⇒ Object

Returns the value of attribute namespace.



19
20
21
 
# File 'lib/memcache.rb', line 19

def namespace
  @namespace
end

#servers ⇒ Object (readonly)

Returns the value of attribute servers.



19
20
21
 
# File 'lib/memcache.rb', line 19

def servers
  @servers
end

Class Method Details

.init(yaml_file = nil) ⇒ Object 



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/memcache.rb', line 337

def self.init(yaml_file = nil)
  yaml_file = File.join(Rails.root, 'config', 'memcached.yml')

  if File.exists?(yaml_file)
    yaml = YAML.load_file(yaml_file)
    defaults = (yaml.delete('defaults') || {}).symbolize_keys
    config   = (yaml[Rails.env] || {}).symbolize_keys

    if not config.empty? and not config[:disabled]
      if config[:servers]
        opts = defaults.merge(config.symbolize_keys)
        Object.const_set('CACHE', Memcache.new(opts))
      else
        config.each do |connection, opts|
          opts = defaults.merge(opts.symbolize_keys)
          Memcache.pool[connection] = Memcache.new(opts)
        end
      end
    end
  end
end

Instance Method Details

#[](key) ⇒ Object 



329
330
331
 
# File 'lib/memcache.rb', line 329

def [](key)
  get(key)
end

#[]=(key, value) ⇒ Object 



333
334
335
 
# File 'lib/memcache.rb', line 333

def []=(key, value)
  set(key, value)
end

#add(key, value, opts = {}) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
 
# File 'lib/memcache.rb', line 147

def add(key, value, opts = {})
  opts = compatible_opts(opts)
  key  = key.to_s
  backup.add(key, value, opts) if backup

  expiry = opts[:expiry] || default_expiry
  flags  = opts[:flags]  || 0
  data   = marshal(value, opts)
  server(key).add(key, data, expiry, flags) && value
end

#add_or_get(key, value, opts = {}) ⇒ Object 



241
242
243
244
 
# File 'lib/memcache.rb', line 241

def add_or_get(key, value, opts = {})
  # Try to add, but if that fails, get the existing value.
  add(key, value, opts) || get(key)
end

#append(key, value) ⇒ Object 



180
181
182
183
184
 
# File 'lib/memcache.rb', line 180

def append(key, value)
  key = key.to_s
  backup.append(key, value) if backup
  server(key).append(key, value)
end

#cas(key, value, opts) ⇒ Object 



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/memcache.rb', line 169

def cas(key, value, opts)
  raise 'opts must be hash' unless opts.instance_of?(Hash)
  key = key.to_s
  backup.cas(key, value, opts) if backup

  expiry = opts[:expiry] || default_expiry
  flags  = opts[:flags]  || 0
  data   = marshal(value, opts)
  server(key).cas(key, data, opts[:cas], expiry, flags) && value
end

#clone ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/memcache.rb', line 74

def clone
  self.class.new(
    :default_expiry => default_expiry,
    :namespace      => namespace,
    :servers        => servers.collect {|s| s.clone}
  )
end

#count(key) ⇒ Object 



192
193
194
 
# File 'lib/memcache.rb', line 192

def count(key)
  get(key, :raw => true).to_i
end

#decr(key, amount = 1) ⇒ Object 



202
203
204
205
206
 
# File 'lib/memcache.rb', line 202

def decr(key, amount = 1)
  key = key.to_s
  backup.decr(key, amount) if backup
  server(key).decr(key, amount)
end

#delete(key) ⇒ Object 



293
294
295
296
297
 
# File 'lib/memcache.rb', line 293

def delete(key)
  key = key.to_s
  backup.delete(key) if backup
  server(key).delete(key)
end

#flush_all(opts = {}) ⇒ Object Also known as: clear 



299
300
301
302
303
304
305
306
307
 
# File 'lib/memcache.rb', line 299

def flush_all(opts = {})
  delay    = opts[:delay].to_i
  interval = opts[:interval].to_i

  servers.each do |server|
    server.flush_all(delay)
    delay += interval
  end
end

#get(keys, opts = {}) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/memcache.rb', line 107

def get(keys, opts = {})
  raise 'opts must be hash' unless opts.instance_of?(Hash)

  if keys.instance_of?(Array)
    keys.collect! {|key| key.to_s}
    multi_get(keys, opts)
  else
    key = keys.to_s
    if opts[:expiry]
      value = server(key).gets(key)
      cas(key, value, :raw => true, :cas => value.memcache_cas, :expiry => opts[:expiry]) if value
    else
      value = server(key).get(key, opts[:cas])
    end

    return backup.get(key, opts) if backup and value.nil?
    opts[:raw] ? value : unmarshal(value, key)
  end
end

#get_or_add(key, *args) ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/memcache.rb', line 218

def get_or_add(key, *args)
  # Pseudo-atomic get and update.
  key = key.to_s
  if block_given?
    opts = args[0] || {}
    get(key) || add(key, yield, opts) || get(key)
  else
    opts = args[1] || {}
    get(key) || add(key, args[0], opts) || get(key)
  end
end

#get_or_set(key, *args) ⇒ Object 



230
231
232
233
234
235
236
237
238
239
 
# File 'lib/memcache.rb', line 230

def get_or_set(key, *args)
  key = key.to_s
  if block_given?
    opts = args[0] || {}
    get(key) || set(key, yield, opts)
  else
    opts = args[1] || {}
    get(key) || set(key, args[0], opts)
  end
end

#get_some(keys, opts = {}) ⇒ Object 



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/memcache.rb', line 246

def get_some(keys, opts = {})
  keys = keys.collect {|key| key.to_s}
  records = opts[:disable] ? {} : self.multi_get(keys, opts)
  if opts[:validation]
    records.delete_if do |key, value|
      not opts[:validation].call(key, value)
    end
  end

  keys_to_fetch = keys - records.keys
  method = opts[:overwrite] ? :set : :add_or_get
  if keys_to_fetch.any?
    yield(keys_to_fetch).each do |key, value|
      value = self.send(method, key, value, opts) unless opts[:disable] or opts[:disable_write]
      records[key] = value
    end
  end
  records
end

#in_namespace(namespace) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
 
# File 'lib/memcache.rb', line 96

def in_namespace(namespace)
  # Temporarily change the namespace for convenience.
  begin
    old_namespace  = self.namespace
    self.namespace = old_namespace ? "#{old_namespace}:#{namespace}" : namespace
    yield
  ensure
    self.namespace = old_namespace
  end
end

#incr(key, amount = 1) ⇒ Object 



196
197
198
199
200
 
# File 'lib/memcache.rb', line 196

def incr(key, amount = 1)
  key = key.to_s
  backup.incr(key, amount) if backup
  server(key).incr(key, amount)
end

#inspect ⇒ Object 



82
83
84
 
# File 'lib/memcache.rb', line 82

def inspect
  "<Memcache: %d servers, ns: %p>" % [@servers.length, namespace]
end

#lock(key, opts = {}) ⇒ Object 



266
267
268
269
270
 
# File 'lib/memcache.rb', line 266

def lock(key, opts = {})
  # Returns false if the lock already exists.
  expiry = opts[:expiry] || LOCK_TIMEOUT
  add(lock_key(key), Socket.gethostname, :expiry => expiry, :raw => true)
end

#lock_key(key) ⇒ Object 



285
286
287
 
# File 'lib/memcache.rb', line 285

def lock_key(key)
  "lock:#{key}"
end

#locked?(key) ⇒ Boolean

Returns:

  • (Boolean) 


289
290
291
 
# File 'lib/memcache.rb', line 289

def locked?(key)
  get(lock_key(key), :raw => true)
end

#prepend(key, value) ⇒ Object 



186
187
188
189
190
 
# File 'lib/memcache.rb', line 186

def prepend(key, value)
  key = key.to_s
  backup.prepend(key, value) if backup
  server(key).prepend(key, value)
end

#read(keys, opts = {}) ⇒ Object 



127
128
129
 
# File 'lib/memcache.rb', line 127

def read(keys, opts = {})
  get(keys, opts.merge(:raw => true))
end

#replace(key, value, opts = {}) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/memcache.rb', line 158

def replace(key, value, opts = {})
  opts = compatible_opts(opts)
  key  = key.to_s
  backup.replace(key, value, opts) if backup

  expiry = opts[:expiry] || default_expiry
  flags  = opts[:flags]  || 0
  data   = marshal(value, opts)
  server(key).replace(key, data, expiry, flags) && value
end

#reset ⇒ Object 



309
310
311
 
# File 'lib/memcache.rb', line 309

def reset
  servers.each {|server| server.close if server.respond_to?(:close)}
end

#set(key, value, opts = {}) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/memcache.rb', line 131

def set(key, value, opts = {})
  opts = compatible_opts(opts)
  key  = key.to_s
  backup.set(key, value, opts) if backup

  expiry = opts[:expiry] || default_expiry
  flags  = opts[:flags]  || 0
  data   = marshal(value, opts)
  server(key).set(key, data, expiry, flags)
  value
end

#stats(field = nil) ⇒ Object 



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/memcache.rb', line 313

def stats(field = nil)
  if field
    servers.collect do |server|
      server.stats[field]
    end
  else
    stats = {}
    servers.each do |server|
      stats[server.name] = server.stats
    end
    stats
  end
end

#unlock(key) ⇒ Object 



272
273
274
 
# File 'lib/memcache.rb', line 272

def unlock(key)
  delete(lock_key(key))
end

#update(key, opts = {}) ⇒ Object 



208
209
210
211
212
213
214
215
216
 
# File 'lib/memcache.rb', line 208

def update(key, opts = {})
  key   = key.to_s
  value = get(key, :cas => true)
  if value
    cas(key, yield(value), opts.merge!(:cas => value.memcache_cas))
  else
    add(key, yield(value), opts)
  end
end

#with_lock(key, opts = {}) ⇒ Object 



276
277
278
279
280
281
282
283
 
# File 'lib/memcache.rb', line 276

def with_lock(key, opts = {})
  until lock(key) do
    return if opts[:ignore]
    sleep(WRITE_LOCK_WAIT) # just wait
  end
  yield
  unlock(key) unless opts[:keep]
end

#write(key, value, opts = {}) ⇒ Object 



143
144
145
 
# File 'lib/memcache.rb', line 143

def write(key, value, opts = {})
  set(key, value, opts.merge(:raw => true))
end