Class: Async::Task

Inherits:
Node
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/async/task.rb

Overview

A task represents the state associated with the execution of an asynchronous block.

Instance Attribute Summary collapse

Attributes inherited from Node

#annotation, #children, #parent

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Node

#annotate, #consume, #description, #inspect, #print_hierarchy, #reap, #traverse

Constructor Details

#initialize(reactor, parent = Task.current?, logger: nil, &block) ⇒ Task

Create a new task.

Parameters:

  • reactor (Async::Reactor) —

    the reactor this task will run within.

  • parent (Async::Task) (defaults to: Task.current?) —

    the parent task.



73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/async/task.rb', line 73

def initialize(reactor, parent = Task.current?, logger: nil, &block)
	super(parent || reactor)
	
	@reactor = reactor
	
	@status = :initialized
	@result = nil
	@finished = nil
	
	@logger = logger
	
	@fiber = make_fiber(&block)
end

Instance Attribute Details

#fiber ⇒ Object (readonly) 



105
106
107
 
# File 'lib/async/task.rb', line 105

def fiber
  @fiber
end

#reactor ⇒ Object (readonly) 



96
97
98
 
# File 'lib/async/task.rb', line 96

def reactor
  @reactor
end

#status ⇒ Object (readonly) 



112
113
114
 
# File 'lib/async/task.rb', line 112

def status
  @status
end

Class Method Details

.current ⇒ Async::Task

Lookup the Async::Task for the current fiber. Raise RuntimeError if none is available.

Returns:

Raises:

  • (RuntimeError) —

    if task was not #set! for the current fiber.



181
182
183
 
# File 'lib/async/task.rb', line 181

def self.current
	Thread.current[:async_task] or raise RuntimeError, "No async task available!"
end

.current? ⇒ Async::Task?

Check if there is a task defined for the current fiber.

Returns:



187
188
189
 
# File 'lib/async/task.rb', line 187

def self.current?
	Thread.current[:async_task]
end

.yield {|result| ... } ⇒ Object

Yield the unerlying result for the task. If the result is an Exception, then that result will be raised an its exception.

Yields:

  • (result) —

    result of the task if a block if given.

Returns:

  • (Object) —

    result of the task

Raises:

  • (Exception) —

    if the result is an exception



56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/async/task.rb', line 56

def self.yield
	if block_given?
		result = yield
	else
		result = Fiber.yield
	end
	
	if result.is_a? Exception
		raise result
	else
		return result
	end
end

Instance Method Details

#alive? ⇒ Boolean

Returns:

  • (Boolean) 


107
108
109
 
# File 'lib/async/task.rb', line 107

def alive?
	@fiber&.alive?
end

#async(*args, **options, &block) ⇒ Object 



124
125
126
127
128
129
130
 
# File 'lib/async/task.rb', line 124

def async(*args, **options, &block)
	task = Task.new(@reactor, self, **options, &block)
	
	task.run(*args)
	
	return task
end

#complete? ⇒ Boolean

Returns:

  • (Boolean) 


219
220
221
 
# File 'lib/async/task.rb', line 219

def complete?
	@status == :complete
end

#current? ⇒ Boolean

Returns:

  • (Boolean) 


191
192
193
 
# File 'lib/async/task.rb', line 191

def current?
	self.equal?(Thread.current[:async_task])
end

#failed? ⇒ Boolean

Returns:

  • (Boolean) 


207
208
209
 
# File 'lib/async/task.rb', line 207

def failed?
	@status == :failed
end

#finished? ⇒ Boolean

Whether we can remove this node from the reactor graph.

Returns:

  • (Boolean) 


203
204
205
 
# File 'lib/async/task.rb', line 203

def finished?
	super && @status != :running
end

#logger ⇒ Object 



91
92
93
 
# File 'lib/async/task.rb', line 91

def logger
	@logger ||= @parent&.logger
end

#run(*args) ⇒ Object

Begin the execution of the task.



115
116
117
118
119
120
121
122
 
# File 'lib/async/task.rb', line 115

def run(*args)
	if @status == :initialized
		@status = :running
		@fiber.resume(*args)
	else
		raise RuntimeError, "Task already running!"
	end
end

#running? ⇒ Boolean

Check if the task is running.

Returns:

  • (Boolean) 


197
198
199
 
# File 'lib/async/task.rb', line 197

def running?
	@status == :running
end

#stop(later = false) ⇒ void

This method returns an undefined value.

Stop the task and all of its children.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/async/task.rb', line 152

def stop(later = false)
	if self.stopped?
		# If we already stopped this task... don't try to stop it again:
		return
	end
	
	if self.running?
		if self.current?
			if later
				@reactor << Stop::Later.new(self)
			else
				raise Stop, "Stopping current task!"
			end
		elsif @fiber&.alive?
			begin
				@fiber.resume(Stop.new)
			rescue FiberError
				@reactor << Stop::Later.new(self)
			end
		end
	else
		# We are not running, but children might be, so transition directly into stopped state:
		stop!
	end
end

#stopped? ⇒ Boolean

Returns:

  • (Boolean) 


215
216
217
 
# File 'lib/async/task.rb', line 215

def stopped?
	@status == :stopped
end

#stopping? ⇒ Boolean

Returns:

  • (Boolean) 


211
212
213
 
# File 'lib/async/task.rb', line 211

def stopping?
	@status == :stopping
end

#to_s ⇒ Object 



87
88
89
 
# File 'lib/async/task.rb', line 87

def to_s
	"\#<#{self.description} (#{@status})>"
end

#wait ⇒ Object Also known as: result

Retrieve the current result of the task. Will cause the caller to wait until result is available.

Returns:

  • (Object) —

    the final expression/result of the task's block.

Raises:

  • (RuntimeError) —

    if the task's fiber is the current fiber.



135
136
137
138
139
140
141
142
143
144
 
# File 'lib/async/task.rb', line 135

def wait
	raise RuntimeError, "Cannot wait on own fiber" if Fiber.current.equal?(@fiber)
	
	if running?
		@finished ||= Condition.new
		@finished.wait
	else
		Task.yield{@result}
	end
end

#yield ⇒ Object

Yield back to the reactor and allow other fibers to execute.



100
101
102
 
# File 'lib/async/task.rb', line 100

def yield
	Task.yield{reactor.yield}
end