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.3"

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
24
25
 
# File 'lib/redis/unique/queue.rb', line 13

def initialize(name, redis_or_options = {})
  name = name.to_s if name.kind_of? Symbol

  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 



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

def all
  peek 0, size
end

#back ⇒ Object 



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

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

#clear ⇒ Object 



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

def clear
  @redis.del name
  []
end

#expire(seconds) ⇒ Object 



86
87
88
 
# File 'lib/redis/unique/queue.rb', line 86

def expire seconds
  @redis.expire name, seconds
end

#front ⇒ Object 



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

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

#include?(data) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#peek(index, amount = 1) ⇒ Object 



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

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

#pop ⇒ Object 



37
38
39
 
# File 'lib/redis/unique/queue.rb', line 37

def pop
  block_on_atomic_attempt{ attempt_atomic_pop }
end

#pop_all ⇒ Object 



41
42
43
 
# File 'lib/redis/unique/queue.rb', line 41

def pop_all
  block_on_atomic_attempt{ attempt_atomic_pop_all }
end

#pop_multi(amount) ⇒ Object 



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

def pop_multi amount
  block_on_atomic_attempt{ attempt_atomic_pop_multi amount }
end

#push(data) ⇒ Object 



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

def push data
  [block_on_atomic_attempt{ attempt_atomic_push_multi(data) }].flatten.first
end

#push_multi(*values) ⇒ Object 



31
32
33
34
35
 
# File 'lib/redis/unique/queue.rb', line 31

def push_multi *values
  if values.size > 0
    block_on_atomic_attempt{ attempt_atomic_push_multi(*values) }
  end
end

#remove(data) ⇒ Object 



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

def remove data
  @redis.zrem name, data
end

#remove_item_by_index(index) ⇒ Object 



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

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

#size ⇒ Object 



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

def size
  @redis.zcard name
end