Class: Async::Queue

Inherits:
Notification show all
Defined in:
lib/async/queue.rb

Overview

A queue which allows items to be processed in order.

Direct Known Subclasses

LimitedQueue

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Notification

#signal

Methods inherited from Condition

#signal, #wait

Constructor Details

#initialize(parent: nil) ⇒ Queue

Returns a new instance of Queue.


28
29
30
31
32
33
# File 'lib/async/queue.rb', line 28

def initialize(parent: nil)
	super()
	
	@items = []
	@parent = parent
end

Instance Attribute Details

#itemsObject (readonly)

Returns the value of attribute items


35
36
37
# File 'lib/async/queue.rb', line 35

def items
  @items
end

Instance Method Details

#async(parent: (@parent or Task.current), &block) ⇒ Object


61
62
63
64
65
# File 'lib/async/queue.rb', line 61

def async(parent: (@parent or Task.current), &block)
	while item = self.dequeue
		parent.async(item, &block)
	end
end

#dequeueObject


53
54
55
56
57
58
59
# File 'lib/async/queue.rb', line 53

def dequeue
	while @items.empty?
		self.wait
	end
	
	@items.shift
end

#eachObject


67
68
69
70
71
# File 'lib/async/queue.rb', line 67

def each
	while item = self.dequeue
		yield item
	end
end

#empty?Boolean

Returns:

  • (Boolean)

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

def empty?
	@items.empty?
end

#enqueue(item) ⇒ Object Also known as: <<


45
46
47
48
49
# File 'lib/async/queue.rb', line 45

def enqueue(item)
	@items.push(item)
	
	self.signal unless self.empty?
end

#sizeObject


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

def size
	@items.size
end