Package com.tnsai.agents.interrupt

Interface InterruptEvent

All Known Implementing Classes:

InterruptEvent.BudgetInterrupt, InterruptEvent.ErrorInterrupt, InterruptEvent.ExternalInterrupt, InterruptEvent.TimeoutInterrupt, InterruptEvent.UserInterrupt

public sealed interface InterruptEvent
permits InterruptEvent.UserInterrupt, InterruptEvent.TimeoutInterrupt, InterruptEvent.BudgetInterrupt, InterruptEvent.ErrorInterrupt, InterruptEvent.ExternalInterrupt

Sealed hierarchy of interrupt events for agent execution control.

Interrupt events allow graceful stopping, pausing, and resuming of agent execution with different triggers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	InterruptEvent.BudgetInterrupt	Budget interrupt when token/cost limits are hit.
static final record	InterruptEvent.ErrorInterrupt	Error interrupt for recoverable errors.
static final record	InterruptEvent.ExternalInterrupt	External system interrupt (e.g., shutdown signal, orchestrator command).
static final record	InterruptEvent.TimeoutInterrupt	Timeout interrupt when execution exceeds time limit.
static final record	InterruptEvent.UserInterrupt	User-initiated interrupt (e.g., cancel button, Ctrl+C).

Method Summary

Modifier and Type	Method	Description
static InterruptEvent.BudgetInterrupt	budget(String type, double current, double limit)	Creates a budget interrupt.
static InterruptEvent.ErrorInterrupt	error(Throwable cause, boolean recoverable)	Creates an error interrupt.
static InterruptEvent.ExternalInterrupt	external(String source, String signal)	Creates an external interrupt.
boolean	isResumable()	Returns true if the agent can be resumed after this interrupt.
String	reason()	Gets the reason for the interrupt.
boolean	shouldCheckpoint()	Returns true if the agent should checkpoint its state.
static InterruptEvent.TimeoutInterrupt	timeout(long elapsedMillis, long limitMillis)	Creates a timeout interrupt.
Instant	timestamp()	Gets the timestamp when the interrupt was triggered.
static InterruptEvent.UserInterrupt	user(String reason)	Creates a user interrupt with the given reason.

Method Details

reason

String reason()

Gets the reason for the interrupt.

timestamp

Instant timestamp()

Gets the timestamp when the interrupt was triggered.

shouldCheckpoint

boolean shouldCheckpoint()

Returns true if the agent should checkpoint its state.

isResumable

boolean isResumable()

Returns true if the agent can be resumed after this interrupt.

user

static InterruptEvent.UserInterrupt user(String reason)

Creates a user interrupt with the given reason.

timeout

static InterruptEvent.TimeoutInterrupt timeout(long elapsedMillis,
 long limitMillis)

Creates a timeout interrupt.

budget

static InterruptEvent.BudgetInterrupt budget(String type,
 double current,
 double limit)

Creates a budget interrupt.

error

static InterruptEvent.ErrorInterrupt error(Throwable cause,
 boolean recoverable)

Creates an error interrupt.

external

static InterruptEvent.ExternalInterrupt external(String source,
 String signal)

Creates an external interrupt.