1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
# frozen_string_literal: true
require 'forwardable'
require 'socket'
require 'timeout'
module Dalli
module Protocol
##
# Access point for a single Memcached server, accessed via Memcached's meta
# protocol. Contains logic for managing connection state to the server (retries, etc),
# formatting requests to the server, and unpacking responses.
##
class Meta < Base
TERMINATOR = "\r\n"
def response_processor
@response_processor ||= ResponseProcessor.new(@connection_manager, @value_marshaller)
end
# NOTE: Additional public methods should be overridden in Dalli::Threadsafe
private
# Retrieval Commands
def get(key, options = nil)
encoded_key, base64 = KeyRegularizer.encode(key)
req = RequestFormatter.meta_get(key: encoded_key, base64: base64)
write(req)
response_processor.meta_get_with_value(cache_nils: cache_nils?(options))
end
def quiet_get_request(key)
encoded_key, base64 = KeyRegularizer.encode(key)
RequestFormatter.meta_get(key: encoded_key, return_cas: true, base64: base64, quiet: true)
end
def gat(key, ttl, options = nil)
ttl = TtlSanitizer.sanitize(ttl)
encoded_key, base64 = KeyRegularizer.encode(key)
req = RequestFormatter.meta_get(key: encoded_key, ttl: ttl, base64: base64)
write(req)
response_processor.meta_get_with_value(cache_nils: cache_nils?(options))
end
def touch(key, ttl)
ttl = TtlSanitizer.sanitize(ttl)
encoded_key, base64 = KeyRegularizer.encode(key)
req = RequestFormatter.meta_get(key: encoded_key, ttl: ttl, value: false, base64: base64)
write(req)
response_processor.meta_get_without_value
end
# TODO: This is confusing, as there's a cas command in memcached
# and this isn't it. Maybe rename? Maybe eliminate?
def cas(key)
encoded_key, base64 = KeyRegularizer.encode(key)
req = RequestFormatter.meta_get(key: encoded_key, value: true, return_cas: true, base64: base64)
write(req)
response_processor.meta_get_with_value_and_cas
end
# Storage Commands
def set(key, value, ttl, cas, options)
write_storage_req(:set, key, value, ttl, cas, options)
response_processor.meta_set_with_cas unless quiet?
end
def add(key, value, ttl, options)
write_storage_req(:add, key, value, ttl, nil, options)
response_processor.meta_set_with_cas unless quiet?
end
def replace(key, value, ttl, cas, options)
write_storage_req(:replace, key, value, ttl, cas, options)
response_processor.meta_set_with_cas unless quiet?
end
# rubocop:disable Metrics/ParameterLists
def write_storage_req(mode, key, raw_value, ttl = nil, cas = nil, options = {})
(value, bitflags) = @value_marshaller.store(key, raw_value, options)
ttl = TtlSanitizer.sanitize(ttl) if ttl
encoded_key, base64 = KeyRegularizer.encode(key)
req = RequestFormatter.meta_set(key: encoded_key, value: value,
bitflags: bitflags, cas: cas,
ttl: ttl, mode: mode, quiet: quiet?, base64: base64)
write(req)
end
# rubocop:enable Metrics/ParameterLists
def append(key, value)
write_append_prepend_req(:append, key, value)
response_processor.meta_set_append_prepend unless quiet?
end
def prepend(key, value)
write_append_prepend_req(:prepend, key, value)
response_processor.meta_set_append_prepend unless quiet?
end
# rubocop:disable Metrics/ParameterLists
def write_append_prepend_req(mode, key, value, ttl = nil, cas = nil, _options = {})
ttl = TtlSanitizer.sanitize(ttl) if ttl
encoded_key, base64 = KeyRegularizer.encode(key)
req = RequestFormatter.meta_set(key: encoded_key, value: value, base64: base64,
cas: cas, ttl: ttl, mode: mode, quiet: quiet?)
write(req)
end
# rubocop:enable Metrics/ParameterLists
# Delete Commands
def delete(key, cas)
encoded_key, base64 = KeyRegularizer.encode(key)
req = RequestFormatter.meta_delete(key: encoded_key, cas: cas,
base64: base64, quiet: quiet?)
write(req)
response_processor.meta_delete unless quiet?
end
# Arithmetic Commands
def decr(key, count, ttl, initial)
decr_incr false, key, count, ttl, initial
end
def incr(key, count, ttl, initial)
decr_incr true, key, count, ttl, initial
end
def decr_incr(incr, key, delta, ttl, initial)
ttl = initial ? TtlSanitizer.sanitize(ttl) : nil # Only set a TTL if we want to set a value on miss
encoded_key, base64 = KeyRegularizer.encode(key)
write(RequestFormatter.meta_arithmetic(key: encoded_key, delta: delta, initial: initial, incr: incr, ttl: ttl,
quiet: quiet?, base64: base64))
response_processor.decr_incr unless quiet?
end
# Other Commands
def flush(delay = 0)
write(RequestFormatter.flush(delay: delay))
response_processor.flush unless quiet?
end
# Noop is a keepalive operation but also used to demarcate the end of a set of pipelined commands.
# We need to read all the responses at once.
def noop
write_noop
response_processor.consume_all_responses_until_mn
end
def stats(info = nil)
write(RequestFormatter.stats(info))
response_processor.stats
end
def reset_stats
write(RequestFormatter.stats('reset'))
response_processor.reset
end
def version
write(RequestFormatter.version)
response_processor.version
end
def write_noop
write(RequestFormatter.meta_noop)
end
def authenticate_connection
raise Dalli::DalliError, 'Authentication not supported for the meta protocol.'
end
require_relative 'meta/key_regularizer'
require_relative 'meta/request_formatter'
require_relative 'meta/response_processor'
end
end
end
|
