Class: Gitlab::ReferenceCounter
- Inherits:
-
Object
- Object
- Gitlab::ReferenceCounter
- Defined in:
- lib/gitlab/reference_counter.rb
Overview
Reference Counter
A reference counter is used as a mechanism to identify when a repository is being accessed by a writable operation.
Maintenance operations would use this as a clue to when it should execute significant changes in order to avoid disrupting running traffic
Constant Summary collapse
- REFERENCE_EXPIRE_TIME =
600
Instance Attribute Summary collapse
-
#gl_repository ⇒ Object
readonly
Returns the value of attribute gl_repository.
-
#key ⇒ Object
readonly
Returns the value of attribute key.
Instance Method Summary collapse
-
#decrease ⇒ Boolean
Decrease the counter.
-
#expires_in ⇒ Integer
When the reference counter would expire.
-
#increase ⇒ Boolean
Increase the counter.
-
#initialize(gl_repository) ⇒ ReferenceCounter
constructor
Reference Counter instance.
-
#reset! ⇒ Boolean
Reset the reference counter.
-
#value ⇒ Integer
Return the actual counter value.
Constructor Details
#initialize(gl_repository) ⇒ ReferenceCounter
Reference Counter instance
23 24 25 26 |
# File 'lib/gitlab/reference_counter.rb', line 23 def initialize(gl_repository) @gl_repository = gl_repository @key = "git-receive-pack-reference-counter:#{gl_repository}" end |
Instance Attribute Details
#gl_repository ⇒ Object (readonly)
Returns the value of attribute gl_repository.
14 15 16 |
# File 'lib/gitlab/reference_counter.rb', line 14 def gl_repository @gl_repository end |
#key ⇒ Object (readonly)
Returns the value of attribute key.
14 15 16 |
# File 'lib/gitlab/reference_counter.rb', line 14 def key @key end |
Instance Method Details
#decrease ⇒ Boolean
Decrease the counter
50 51 52 53 54 55 56 57 58 59 |
# File 'lib/gitlab/reference_counter.rb', line 50 def decrease redis_cmd do |redis| current_value = redis.decr(key) if current_value < 0 Gitlab::AppLogger.warn("Reference counter for #{gl_repository} decreased" \ " when its value was less than 1. Resetting the counter.") redis.del(key) end end end |
#expires_in ⇒ Integer
When the reference counter would expire
75 76 77 78 79 |
# File 'lib/gitlab/reference_counter.rb', line 75 def expires_in Gitlab::Redis::SharedState.with do |redis| redis.ttl(key) end end |
#increase ⇒ Boolean
Increase the counter
40 41 42 43 44 45 |
# File 'lib/gitlab/reference_counter.rb', line 40 def increase redis_cmd do |redis| redis.incr(key) redis.expire(key, REFERENCE_EXPIRE_TIME) end end |
#reset! ⇒ Boolean
Reset the reference counter
65 66 67 68 69 |
# File 'lib/gitlab/reference_counter.rb', line 65 def reset! redis_cmd do |redis| redis.del(key) end end |
#value ⇒ Integer
Return the actual counter value
31 32 33 34 35 |
# File 'lib/gitlab/reference_counter.rb', line 31 def value Gitlab::Redis::SharedState.with do |redis| (redis.get(key) || 0).to_i end end |