Class: ValkeyObjects::Counter

Inherits:

Object

• Object
• ValkeyObjects::Counter

Defined in:

lib/valkey/objects.rb

Overview

Counter wrapper

Instance Attribute Summary

• #key ⇒ Object readonly

  Returns the value of attribute key.

• #valkey ⇒ Object readonly

  Returns the value of attribute valkey.

Instance Method Summary

• #decrement(by = 1) ⇒ Object
• #delete ⇒ Object
• #expire(seconds) ⇒ Object
• #expireat(unix_timestamp) ⇒ Object
• #increment(by = 1) ⇒ Object
• #initialize(key, valkey) ⇒ Counter constructor

  A new instance of Counter.

• #persist ⇒ Object
• #reset ⇒ Object
• #to_i ⇒ Object
• #ttl ⇒ Object
• #value ⇒ Object
• #value=(x) ⇒ Object

Constructor Details

#initialize(key, valkey) ⇒ Counter

Returns a new instance of Counter.

# File 'lib/valkey/objects.rb', line 191

def initialize(key, valkey)
  @key = key
  @valkey = valkey
end

Instance Attribute Details

#key ⇒ Object (readonly)

Returns the value of attribute key.

# File 'lib/valkey/objects.rb', line 189

def key
  @key
end

#valkey ⇒ Object (readonly)

Returns the value of attribute valkey.

# File 'lib/valkey/objects.rb', line 189

def valkey
  @valkey
end

Instance Method Details

#decrement(by = 1) ⇒ Object

# File 'lib/valkey/objects.rb', line 209

def decrement(by = 1)
  valkey.decrby(key, by)
end

#delete ⇒ Object

# File 'lib/valkey/objects.rb', line 217

def delete
  valkey.del(key)
end

#expire(seconds) ⇒ Object

# File 'lib/valkey/objects.rb', line 221

def expire(seconds)
  valkey.expire(key, seconds)
end

#expireat(unix_timestamp) ⇒ Object

# File 'lib/valkey/objects.rb', line 225

def expireat(unix_timestamp)
  valkey.expireat(key, unix_timestamp)
end

#increment(by = 1) ⇒ Object

# File 'lib/valkey/objects.rb', line 205

def increment(by = 1)
  valkey.incrby(key, by)
end

#persist ⇒ Object

# File 'lib/valkey/objects.rb', line 233

def persist
  valkey.persist(key)
end

#reset ⇒ Object

# File 'lib/valkey/objects.rb', line 213

def reset
  valkey.set(key, 0)
end

#to_i ⇒ Object

# File 'lib/valkey/objects.rb', line 237

def to_i
  value.to_i
end

#ttl ⇒ Object

# File 'lib/valkey/objects.rb', line 229

def ttl
  valkey.ttl(key)
end

#value ⇒ Object

# File 'lib/valkey/objects.rb', line 200

def value
  val = valkey.get(key)
  val ? val.to_i : 0
end

#value=(x) ⇒ Object

# File 'lib/valkey/objects.rb', line 196

def value= x
  valkey.set(key, x)
end