Class: Redis::Unique::Queue

Inherits:
Object
  • Object
show all
Defined in:
lib/redis/unique/queue.rb

Defined Under Namespace

Classes: InvalidNameException, InvalidRedisConfigException

Constant Summary collapse

VERSION = 
"1.0.1"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, redis_or_options = {}) ⇒ Queue

Returns a new instance of Queue.

Raises:



13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/redis/unique/queue.rb', line 13

def initialize(name, redis_or_options = {})
  raise InvalidNameException.new unless name.kind_of?(String) && name.size > 0
  @name  = name
  @redis = if redis_or_options.kind_of? Redis
             redis_or_options
           elsif redis_or_options.kind_of? Hash
             Redis.new redis_or_options
           else
            raise InvalidRedisConfigException.new
           end
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



6
7
8
 
# File 'lib/redis/unique/queue.rb', line 6

def name
  @name
end

Instance Method Details

#all ⇒ Object 



76
77
78
 
# File 'lib/redis/unique/queue.rb', line 76

def all
  peek 0, size
end

#back ⇒ Object 



60
61
62
 
# File 'lib/redis/unique/queue.rb', line 60

def back
  @redis.zrevrange(name, 0, 0).first
end

#clear ⇒ Object 



88
89
90
91
 
# File 'lib/redis/unique/queue.rb', line 88

def clear
  @redis.del name
  []
end

#expire(seconds) ⇒ Object 



93
94
95
 
# File 'lib/redis/unique/queue.rb', line 93

def expire seconds
  @redis.expire name, seconds
end

#front ⇒ Object 



56
57
58
 
# File 'lib/redis/unique/queue.rb', line 56

def front
  @redis.zrange(name, 0, 0).first
end

#include?(data) ⇒ Boolean

Returns:

  • (Boolean) 


84
85
86
 
# File 'lib/redis/unique/queue.rb', line 84

def include? data
  !@redis.zscore(name, data).nil?
end

#peek(index, amount = 1) ⇒ Object 



80
81
82
 
# File 'lib/redis/unique/queue.rb', line 80

def peek index, amount=1
  @redis.zrange name, index, index + amount - 1
end

#pop ⇒ Object 



44
45
46
 
# File 'lib/redis/unique/queue.rb', line 44

def pop
  block_on_atomic_attempt{ attempt_atomic_pop }
end

#pop_all ⇒ Object 



48
49
50
 
# File 'lib/redis/unique/queue.rb', line 48

def pop_all
  block_on_atomic_attempt{ attempt_atomic_pop_all }
end

#pop_multi(amount) ⇒ Object 



52
53
54
 
# File 'lib/redis/unique/queue.rb', line 52

def pop_multi amount
  block_on_atomic_attempt{ attempt_atomic_pop_multi amount }
end

#push(data) ⇒ Object 



25
26
27
28
 
# File 'lib/redis/unique/queue.rb', line 25

def push data
  score = Time.now.to_f
  @redis.zadd(name, score, data)
end

#push_multi(*values) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/redis/unique/queue.rb', line 30

def push_multi *values
  if values.size > 0
    score = Time.now.to_f

    values = values.first if 1 == values.size && values.first.kind_of?(Array)
    scored_values = []
    values.each_with_index do |value, i|
      scored_values << [score + i, value]
    end

    @redis.zadd name, scored_values
  end
end

#remove(data) ⇒ Object 



64
65
66
 
# File 'lib/redis/unique/queue.rb', line 64

def remove data
  @redis.zrem name, data
end

#remove_item_by_index(index) ⇒ Object 



68
69
70
 
# File 'lib/redis/unique/queue.rb', line 68

def remove_item_by_index index
  @redis.zremrangebyrank name, index, index
end

#size ⇒ Object 



72
73
74
 
# File 'lib/redis/unique/queue.rb', line 72

def size
  @redis.zcard name
end