Class: Async::Condition

Inherits:

Object

• Object
• Async::Condition

Defined in:

lib/async/condition.rb

Overview

A synchronization primitive, which allows fibers to wait until a particular condition is (edge) triggered.

Direct Known Subclasses

Notification

Instance Method Summary

• #empty? ⇒ Boolean deprecated Deprecated.

  Replaced by #waiting?

• #initialize ⇒ Condition constructor

  Create a new condition.

• #signal(value = nil) ⇒ Object

  Signal to a given task that it should resume operations.

• #wait ⇒ Object

  Queue up the current fiber and wait on yielding the task.

• #waiting? ⇒ Boolean

Constructor Details

#initialize ⇒ Condition

Create a new condition.

# File 'lib/async/condition.rb', line 15

def initialize
	@waiting = List.new
end

Instance Method Details

#empty? ⇒ Boolean

Deprecated.

Replaced by #waiting?

Returns:

• (Boolean)

# File 'lib/async/condition.rb', line 44

def empty?
	@waiting.empty?
end

#signal(value = nil) ⇒ Object

Signal to a given task that it should resume operations.

# File 'lib/async/condition.rb', line 55

def signal(value = nil)
	return if @waiting.empty?
	
	waiting = self.exchange
	
	waiting.each do |fiber|
		Fiber.scheduler.resume(fiber, value) if fiber.alive?
	end
	
	return nil
end

#wait ⇒ Object

Queue up the current fiber and wait on yielding the task.

# File 'lib/async/condition.rb', line 37

def wait
	@waiting.stack(FiberNode.new(Fiber.current)) do
		Fiber.scheduler.transfer
	end
end

#waiting? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/async/condition.rb', line 49

def waiting?
	@waiting.size > 0
end