Class: Moneta::Adapters::Client
- Inherits:
-
Object
- Object
- Moneta::Adapters::Client
- Includes:
- Defaults
- Defined in:
- lib/moneta/adapters/client.rb
Overview
Moneta client backend
Instance Method Summary collapse
-
#clear(options = {}) ⇒ void
Clear all keys in this store.
-
#close ⇒ Object
Explicitly close the store.
-
#create(key, value, options = {}) ⇒ Boolean
Atomically sets a key to value if it’s not set.
-
#delete(key, options = {}) ⇒ Object
Delete the key from the store and return the current value.
- #features ⇒ Object
-
#increment(key, amount = 1, options = {}) ⇒ Object
Atomically increment integer value with key.
-
#initialize(options = {}) ⇒ Client
constructor
A new instance of Client.
-
#key?(key, options = {}) ⇒ Boolean
Exists the value with key.
-
#load(key, options = {}) ⇒ Object
Fetch value with key.
-
#store(key, value, options = {}) ⇒ Object
Store value with key.
Methods included from Defaults
#[], #[]=, #decrement, #each_key, #fetch, #fetch_values, included, #merge!, #slice, #supports?, #update, #values_at
Methods included from OptionSupport
#expires, #prefix, #raw, #with
Constructor Details
#initialize(options = {}) ⇒ Client
Returns a new instance of Client.
14 15 16 17 18 19 20 21 |
# File 'lib/moneta/adapters/client.rb', line 14 def initialize( = {}) @socket = if [:socket] UNIXSocket.open([:socket]) else TCPSocket.open([:host] || '127.0.0.1', [:port] || 9000) end end |
Instance Method Details
#clear(options = {}) ⇒ void
This method returns an undefined value.
Clear all keys in this store
61 62 63 64 65 |
# File 'lib/moneta/adapters/client.rb', line 61 def clear( = {}) write(:clear, ) read self end |
#close ⇒ Object
Explicitly close the store
68 69 70 71 |
# File 'lib/moneta/adapters/client.rb', line 68 def close @socket.close nil end |
#create(key, value, options = {}) ⇒ Boolean
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.
55 56 57 58 |
# File 'lib/moneta/adapters/client.rb', line 55 def create(key, value, = {}) write(:create, key, value, ) read end |
#delete(key, options = {}) ⇒ Object
Delete the key from the store and return the current value
43 44 45 46 |
# File 'lib/moneta/adapters/client.rb', line 43 def delete(key, = {}) write(:delete, key, ) read end |
#features ⇒ Object
74 75 76 77 78 79 80 |
# File 'lib/moneta/adapters/client.rb', line 74 def features @features ||= begin write(:features) read.freeze end end |
#increment(key, amount = 1, options = {}) ⇒ Object
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.
49 50 51 52 |
# File 'lib/moneta/adapters/client.rb', line 49 def increment(key, amount = 1, = {}) write(:increment, key, amount, ) read end |
#key?(key, options = {}) ⇒ Boolean
Exists the value with key
24 25 26 27 |
# File 'lib/moneta/adapters/client.rb', line 24 def key?(key, = {}) write(:key?, key, ) read end |
#load(key, options = {}) ⇒ Object
Fetch value with key. Return nil if the key doesn’t exist
30 31 32 33 |
# File 'lib/moneta/adapters/client.rb', line 30 def load(key, = {}) write(:load, key, ) read end |
#store(key, value, options = {}) ⇒ Object
Store value with key
36 37 38 39 40 |
# File 'lib/moneta/adapters/client.rb', line 36 def store(key, value, = {}) write(:store, key, value, ) read value end |