Module: LLM::Agent::Interrupt

Defined in:
lib/llm/agent/interrupt.rb

Overview

Note:

The method provided by this module is not called directly, and the @caller instance variable is private. The #interrupt! and Context#interrupt! methods call it on your behalf.

Stop an agent in its tracks.

The Interrupt module extends the instance variable @caller (an instance of Object) that belongs to an agent and its context.

The @caller instance variable captures the agent's thread, fiber, and scheduler. The variable is in scope for as long as an agent is running and it provides other threads and fibers with access to the agent's thread, fiber and scheduler.

A different thread or fiber can use this module and the object it extends (@caller) to stop an agent in its tracks via the raise of LLM::Interrupt on the agent's thread, or fiber.

See Also:

Instance Method Summary collapse

Instance Method Details

#interrupt!

This method returns an undefined value.

Stops an agent in its tracks.

When this method is called from the agent's thread but a different fiber an interrupt is raised on the caller's fiber.

And when it is called from a thread other than the agent's thread, the interrupt is raised on the caller's thread.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/llm/agent/interrupt.rb', line 49

def interrupt!
  if thread.equal?(Thread.current)
    if fiber
      if scheduler
        scheduler.fiber_interrupt(fiber, LLM::Interrupt.new("agent interrupted"))
      else
        fiber.raise(LLM::Interrupt, "agent interrupted")
      end
    end
  else
    thread.raise(LLM::Interrupt, "agent interrupted")
  end
  nil
rescue ThreadError, FiberError
  nil
end