Class: Async::Task

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

Defined Under Namespace

Classes: FinishedError

Instance Attribute Summary collapse

Attributes inherited from Node

#children, #head, #parent, #tail

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Node

#The parent node.=, #children?, #consume, #description, #print_hierarchy, #root, #terminate, #transient?, #traverse

Constructor Details

#initialize(parent = Task.current?, finished: nil, **options, &block) ⇒ Task

Create a new task.



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

def initialize(parent = Task.current?, finished: nil, **options, &block)
	super(parent, **options)
	
	# These instance variables are critical to the state of the task.
	# In the initialized state, the @block should be set, but the @fiber should be nil.
	# In the running state, the @fiber should be set.
	# In a finished state, the @block should be nil, and the @fiber should be nil.
	@block = block
	@fiber = nil
	
	@status = :initialized
	@result = nil
	@finished = finished
	
	@defer_stop = nil
end

Instance Attribute Details

#fiber ⇒ Object (readonly) 



118
119
120
 
# File 'lib/async/task.rb', line 118

def fiber
  @fiber
end

#result ⇒ Object (readonly)

Access the result of the task without waiting. May be nil if the task is not completed. Does not raise exceptions.



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

def result
  @result
end

#status ⇒ Object (readonly) 



155
156
157
 
# File 'lib/async/task.rb', line 155

def status
  @status
end

Class Method Details

.current ⇒ Object

Lookup the Async::Task for the current fiber. Raise ‘RuntimeError` if none is available. @raises If task was not #set! for the current fiber.



290
291
292
 
# File 'lib/async/task.rb', line 290

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

.current? ⇒ Boolean

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

Returns:

  • (Boolean) 


296
297
298
 
# File 'lib/async/task.rb', line 296

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

.yield ⇒ Object

Deprecated.

With no replacement.



50
51
52
 
# File 'lib/async/task.rb', line 50

def self.yield
	Fiber.scheduler.transfer
end

Instance Method Details

#alive? ⇒ Boolean

Whether the internal fiber is alive, i.e. it

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/async/task.rb', line 121

def alive?
	@fiber&.alive?
end

#annotate(annotation, &block) ⇒ Object 



82
83
84
85
86
87
88
 
# File 'lib/async/task.rb', line 82

def annotate(annotation, &block)
	if @fiber
		@fiber.annotate(annotation, &block)
	else
		super
	end
end

#annotation ⇒ Object 



90
91
92
93
94
95
96
 
# File 'lib/async/task.rb', line 90

def annotation
	if @fiber
		@fiber.annotation
	else
		super
	end
end

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

Run an asynchronous task as a child of the current task.

Raises:



171
172
173
174
175
176
177
178
179
 
# File 'lib/async/task.rb', line 171

def async(*arguments, **options, &block)
	raise FinishedError if self.finished?
	
	task = Task.new(self, **options, &block)
	
	task.run(*arguments)
	
	return task
end

#backtrace(*arguments) ⇒ Object 



78
79
80
 
# File 'lib/async/task.rb', line 78

def backtrace(*arguments)
	@fiber&.backtrace(*arguments)
end

#completed? ⇒ Boolean Also known as: complete?

The task has completed execution and generated a result.

Returns:

  • (Boolean) 


148
149
150
 
# File 'lib/async/task.rb', line 148

def completed?
	@status == :completed
end

#current? ⇒ Boolean

Returns:

  • (Boolean) 


300
301
302
 
# File 'lib/async/task.rb', line 300

def current?
	Fiber.current.equal?(@fiber)
end

#defer_stop ⇒ Object

Defer the handling of stop. During the execution of the given block, if a stop is requested, it will be deferred until the block exits. This is useful for ensuring graceful shutdown of servers and other long-running tasks. You should wrap the response handling code in a defer_stop block to ensure that the task is stopped when the response is complete but not before.

You can nest calls to defer_stop, but the stop will only be deferred until the outermost block exits.

If stop is invoked a second time, it will be immediately executed.



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/async/task.rb', line 259

def defer_stop
	# Tri-state variable for controlling stop:
	# - nil: defer_stop has not been called.
	# - false: defer_stop has been called and we are not stopping.
	# - true: defer_stop has been called and we will stop when exiting the block.
	if @defer_stop.nil?
		# If we are not deferring stop already, we can defer it now:
		@defer_stop = false
		
		begin
			yield
		rescue Stop
			# If we are exiting due to a stop, we shouldn't try to invoke stop again:
			@defer_stop = nil
			raise
		ensure
			# If we were asked to stop, we should do so now:
			if @defer_stop
				@defer_stop = nil
				raise Stop, "Stopping current task (was deferred)!"
			end
		end
	else
		# If we are deferring stop already, entering it again is a no-op.
		yield
	end
end

#failed? ⇒ Boolean

Returns:

  • (Boolean) 


138
139
140
 
# File 'lib/async/task.rb', line 138

def failed?
	@status == :failed
end

#finished? ⇒ Boolean

Whether we can remove this node from the reactor graph.

Returns:

  • (Boolean) 


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

def finished?
	# If the block is nil and the fiber is nil, it means the task has finished execution. This becomes true after `finish!` is called.
	super && @block.nil? && @fiber.nil?
end

#reactor ⇒ Object 



74
75
76
 
# File 'lib/async/task.rb', line 74

def reactor
	self.root
end

#run(*arguments) ⇒ Object

Begin the execution of the task.



158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/async/task.rb', line 158

def run(*arguments)
	if @status == :initialized
		@status = :running
		
		schedule do
			@block.call(self, *arguments)
		end
	else
		raise RuntimeError, "Task already running!"
	end
end

#running? ⇒ Boolean

Whether the task is running.

Returns:

  • (Boolean) 


134
135
136
 
# File 'lib/async/task.rb', line 134

def running?
	@status == :running
end

#sleep(duration = nil) ⇒ Object

Deprecated.

Prefer Kernel#sleep except when compatibility with ‘stable-v1` is required.



103
104
105
 
# File 'lib/async/task.rb', line 103

def sleep(duration = nil)
	super
end

#stop(later = false) ⇒ Object

Stop the task and all of its children.

If ‘later` is false, it means that `stop` has been invoked directly. When `later` is true, it means that `stop` is invoked by `stop_children` or some other indirect mechanism. In that case, if we encounter the “current” fiber, we can’t stop it right away, as it’s currently performing ‘#stop`. Stopping it immediately would interrupt the current stop traversal, so we need to schedule the stop to occur later.



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/async/task.rb', line 211

def stop(later = false)
	if self.stopped?
		# If the task is already stopped, a `stop` state transition re-enters the same state which is a no-op. However, we will also attempt to stop any running children too. This can happen if the children did not stop correctly the first time around. Doing this should probably be considered a bug, but it's better to be safe than sorry.
		return stopped!
	end
	
	# If we are deferring stop...
	if @defer_stop == false
		# Don't stop now... but update the state so we know we need to stop later.
		@defer_stop = true
		return false
	end
	
	# If the fiber is alive, we need to stop it:
	if @fiber&.alive?
		if self.current?
			# If the fiber is current, and later is `true`, we need to schedule the fiber to be stopped later, as it's currently invoking `stop`:
			if later
				# If the fiber is the current fiber and we want to stop it later, schedule it:
				Fiber.scheduler.push(Stop::Later.new(self))
			else
				# Otherwise, raise the exception directly:
				raise Stop, "Stopping current task!"
			end
		else
			# If the fiber is not curent, we can raise the exception directly:
			begin
				# There is a chance that this will stop the fiber that originally called stop. If that happens, the exception handling in `#stopped` will rescue the exception and re-raise it later.
				Fiber.scheduler.raise(@fiber, Stop)
			rescue FiberError
				# In some cases, this can cause a FiberError (it might be resumed already), so we schedule it to be stopped later:
				Fiber.scheduler.push(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

The task has been stopped

Returns:

  • (Boolean) 


143
144
145
 
# File 'lib/async/task.rb', line 143

def stopped?
	@status == :stopped
end

#to_s ⇒ Object 



98
99
100
 
# File 'lib/async/task.rb', line 98

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

#wait ⇒ Object

Retrieve the current result of the task. Will cause the caller to wait until result is available. If the task resulted in an unhandled error (derived from ‘StandardError`), this will be raised. If the task was stopped, this will return `nil`.

Conceptually speaking, waiting on a task should return a result, and if it throws an exception, this is certainly an exceptional case that should represent a failure in your program, not an expected outcome. In other words, you should not design your programs to expect exceptions from ‘#wait` as a normal flow control, and prefer to catch known exceptions within the task itself and return a result that captures the intention of the failure, e.g. a `TimeoutError` might simply return `nil` or `false` to indicate that the operation did not generate a valid result (as a timeout was an expected outcome of the internal operation in this case).



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/async/task.rb', line 187

def wait
	raise "Cannot wait on own fiber!" if Fiber.current.equal?(@fiber)
	
	# `finish!` will set both of these to nil before signaling the condition:
	if @block || @fiber
		@finished ||= Condition.new
		@finished.wait
	end
	
	if @status == :failed
		raise @result
	else
		return @result
	end
end

#with_timeout(duration, exception = TimeoutError, message = "execution expired", &block) ⇒ Object

Execute the given block of code, raising the specified exception if it exceeds the given duration during a non-blocking operation.



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

def with_timeout(duration, exception = TimeoutError, message = "execution expired", &block)
	Fiber.scheduler.with_timeout(duration, exception, message, &block)
end

#yield ⇒ Object

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



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

def yield
	Fiber.scheduler.yield
end