Class: Async::Variable

Inherits:

Object

• Object
• Async::Variable

Defined in:

lib/async/variable.rb

Overview

A synchronization primitive that allows one task to wait for another task to resolve a value.

Instance Method Summary

• #initialize(condition = Condition.new) ⇒ Variable constructor

  Create a new variable.

• #resolve(value = true) ⇒ Object

  Resolve the value.

• #resolved? ⇒ Boolean

  Whether the value has been resolved.

• #value ⇒ Object

  Alias for #wait.

• #value=(value) ⇒ Object

  Alias for #resolve.

• #wait ⇒ Object

  Wait for the value to be resolved.

Constructor Details

#initialize(condition = Condition.new) ⇒ Variable

Create a new variable.

# File 'lib/async/variable.rb', line 14

def initialize(condition = Condition.new)
	@condition = condition
	@value = nil
end

Instance Method Details

#resolve(value = true) ⇒ Object

Resolve the value.

Signals all waiting tasks.

# File 'lib/async/variable.rb', line 24

def resolve(value = true)
	@value = value
	condition = @condition
	@condition = nil
	
	self.freeze
	
	condition.signal(value)
end

#resolved? ⇒ Boolean

Whether the value has been resolved.

Returns:

• (Boolean)

# File 'lib/async/variable.rb', line 42

def resolved?
	@condition.nil?
end

#value ⇒ Object

Alias for #wait.

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

def value
	self.wait
end

#value=(value) ⇒ Object

Alias for #resolve.

# File 'lib/async/variable.rb', line 35

def value=(value)
	self.resolve(value)
end

#wait ⇒ Object

Wait for the value to be resolved.

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

def wait
	@condition&.wait
	return @value
end