gatos.wait
tool World and discovery
Wait without polling until snapshot, event, or universal-time state changes.
- Use when
- Coordinating an agent loop with live simulation progress instead of sleeping blindly.
- Availability
- Events require the event telemetry stream; snapshot and UT waits use SnapshotStore.
Input
| Field | Type | Requirement | Description |
|---|---|---|---|
after_sequence | integer | null | Optional · null | Return after a snapshot newer than this sequence is published. |
event_type | string | null | Optional · null | Return on the next selected event type. |
vessel_id | string | null | Optional · null | Optional raw vessel filter for event_type. |
until_ut | number | null | Optional · null | Return when simulation UT reaches or exceeds this value in seconds. |
timeout_ms | integer | Optional · 30000 | Wall-clock timeout from 1 through 120000 ms. |
Call example
gatos.wait({"after_sequence":812,"event_type":"stage.activated","vessel_id":"Hunter","timeout_ms":30000})Result
The first matching condition and current freshness metadata.
Errors
- EINVAL when no condition is supplied or timeout is outside bounds.
- ETIMEDOUT with retryable=true when no condition matches in time.
Operational notes
- When several conditions are supplied, the first match wins.
- Closing the HTTP request cancels the wait.