class Async::Task

@public Since ‘stable-v1`.
Encapsulates the state of a running task and it’s result.

def self.current

@raises[RuntimeError] If task was not {set!} for the current fiber.
@returns [Task]
Lookup the {Task} for the current fiber. Raise `RuntimeError` if none is available.
def self.current
	Thread.current[:async_task] or raise RuntimeError, "No async task available!"
end

def self.current?

@returns [Task | Nil]
Check if there is a task defined for the current fiber.
def self.current?
	Thread.current[:async_task]
end

def self.yield

Deprecated:
  • With no replacement.
def self.yield
	Fiber.scheduler.transfer
end

def alive?

def alive?
	@fiber&.alive?
end

def async(*arguments, **options, &block)

Run an asynchronous task as a child of the current task.
def async(*arguments, **options, &block)
	raise "Cannot create child task within a task that has finished execution!" if self.finished?
	
	task = Task.new(self, **options, &block)
	
	task.run(*arguments)
	
	return task
end

def backtrace(*arguments)

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

def complete?

def complete?
	@status == :complete
end

def current?

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

def fail!(exception = false, propagate = true)

This is a very tricky aspect of tasks to get right. I've modelled it after `Thread` but it's slightly different in that the exception can propagate back up through the reactor. If the user writes code which raises an exception, that exception should always be visible, i.e. cause a failure. If it's not visible, such code fails silently and can be very difficult to debug.
def fail!(exception = false, propagate = true)
	@status = :failed
	@result = exception
	
	if exception
		if propagate
			raise exception
		elsif @finished.nil?
			# If no one has called wait, we log this as a warning:
			Console.logger.warn(self, "Task may have ended with unhandled exception.", exception)
		else
			Console.logger.debug(self, exception)
		end
	end
end

def failed?

def failed?
	@status == :failed
end

def finish!

Finish the current task, moving any children to the parent.
def finish!
	# Allow the fiber to be recycled.
	@fiber = nil
	
	# Attempt to remove this node from the task tree.
	consume
	
	# If this task was being used as a future, signal completion here:
	if @finished
		@finished.signal(self)
	end
end

def finished?

@returns [Boolean]
Whether we can remove this node from the reactor graph.
def finished?
	super && @fiber.nil?
end

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

@parameter parent [Task] the parent task.
@parameter reactor [Reactor] the reactor this task will run within.
Create a new task.
def initialize(parent = Task.current?, finished: nil, **options, &block)
	super(parent, **options)
	
	@status = :initialized
	@result = nil
	@finished = finished
	
	@block = block
	@fiber = nil
end

def reactor

def reactor
	self.root
end

def run(*arguments)

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

def running?

@returns [Boolean]
Check if the task is running.
def running?
	@status == :running
end

def schedule(&block)

def schedule(&block)
	@fiber = Fiber.new do
		set!
		
		begin
			@result = yield
			@status = :complete
			# Console.logger.debug(self) {"Task was completed with #{@children.size} children!"}
		rescue Stop
			stop!
		rescue StandardError => error
			fail!(error, false)
		rescue Exception => exception
			fail!(exception, true)
		ensure
			# Console.logger.info(self) {"Task ensure $! = #{$!} with #{@children&.size.inspect} children!"}
			finish!
		end
	end
	
	self.root.resume(@fiber)
end

def set!

Set the current fiber's `:async_task` to this task.
def set!
	# This is actually fiber-local:
	Thread.current[:async_task] = self
end

def sleep(duration = nil)

Deprecated:
  • Prefer {Kernel#sleep} except when compatibility with `stable-v1` is required.
def sleep(duration = nil)
	super
end

def stop(later = false)

Stop the task and all of its children.
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
				Fiber.scheduler.push(Stop::Later.new(self))
			else
				raise Stop, "Stopping current task!"
			end
		elsif @fiber&.alive?
			begin
				Fiber.scheduler.raise(@fiber, Stop)
			rescue FiberError
				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

def stop!

def stop!
	# Console.logger.info(self, self.annotation) {"Task was stopped with #{@children&.size.inspect} children!"}
	@status = :stopped
	
	stop_children(true)
end

def stopped?

def stopped?
	@status == :stopped
end

def to_s

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

def wait

@returns [Object] The final expression/result of the task's block.
@raises [RuntimeError] If the task's fiber is the current fiber.

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).

Retrieve the current result of the task. Will cause the caller to wait until result is available. If the result was an exception, raise that exception.
def wait
	raise "Cannot wait on own fiber!" if Fiber.current.equal?(@fiber)
	
	if running?
		@finished ||= Condition.new
		@finished.wait
	end
	
	if @result.is_a?(Exception)
		raise @result
	else
		return @result
	end
end

def with_timeout(duration, exception = TimeoutError, message = "execution expired", &block)

Execute the given block of code, raising the specified exception if it exceeds the given duration during a non-blocking operation.
def with_timeout(duration, exception = TimeoutError, message = "execution expired", &block)
	Fiber.scheduler.with_timeout(duration, exception, message, &block)
end

def yield

Yield back to the reactor and allow other fibers to execute.
def yield
	Fiber.scheduler.yield
end