Class: LLM::Function::Task

Inherits:

Object

• Object
• LLM::Function::Task

Defined in:

lib/llm/function/task.rb

Overview

This class is the superclass that all concurrency strategies must subclass in order to implement their own Task class. It provides a common interface that is the same across all concurrency strategies.

Direct Known Subclasses

Async::Task, Fiber::Task, Fork::Task, Ractor::Task, Sequential::Task, LLM::Function::Thread::Task

Instance Attribute Summary

• #function ⇒ LLM::Function readonly

Instance Method Summary

• #alive? ⇒ Boolean abstract
• #group_class ⇒ Class abstract
• #initialize(fn, options = {}) ⇒ Task constructor

  A new instance of Task.

• #interrupt! ⇒ nil (also: #cancel!) abstract
• #spawn ⇒ nil abstract
• #wait ⇒ LLM::Function::Return (also: #value) abstract

Constructor Details

#initialize(fn, options = {}) ⇒ Task

Returns a new instance of Task.

Parameters:

• fn (LLM::Function)
• options (Hash) (defaults to: {}) —

  An optional set of options that are specific to a given concurrency strategy.

Options Hash (options):

• :guarded (LLM::Function::Return, nil) —

  A blocked return produced by the function's guard. When set, the task yields it without running the tool.

# File 'lib/llm/function/task.rb', line 22

def initialize(fn, options = {})
  @function = fn
  @guarded = options[:guarded]
end

Instance Attribute Details

#function ⇒ LLM::Function (readonly)

Returns:

• (LLM::Function)

# File 'lib/llm/function/task.rb', line 12

def function
  @function
end

Instance Method Details

#alive? ⇒ Boolean

This method is abstract.

Returns:

• (Boolean)

Raises:

• (NotImplementedError)

# File 'lib/llm/function/task.rb', line 37

def alive?
  raise NotImplementedError
end

#group_class ⇒ Class

This method is abstract.

Returns:

• (Class)

Raises:

• (NotImplementedError)

# File 'lib/llm/function/task.rb', line 60

def group_class
  raise NotImplementedError
end

#interrupt! ⇒ nil Also known as: cancel!

This method is abstract.

Returns:

• (nil)

Raises:

• (NotImplementedError)

# File 'lib/llm/function/task.rb', line 44

def interrupt!
  raise NotImplementedError
end

#spawn ⇒ nil

This method is abstract.

Returns:

• (nil)

Raises:

• (NotImplementedError)

# File 'lib/llm/function/task.rb', line 30

def spawn
  raise NotImplementedError
end

#wait ⇒ LLM::Function::Return Also known as: value

This method is abstract.

Returns:

• (LLM::Function::Return)

Raises:

• (NotImplementedError)

# File 'lib/llm/function/task.rb', line 52

def wait
  raise NotImplementedError
end