Skip to content

streaming.md

Latest commit

 

History

History
36 lines (24 loc) · 1.08 KB

streaming.md

File metadata and controls

36 lines (24 loc) · 1.08 KB

Streaming & Artifacts

This document explains how events and artifacts flow between the executor and runtime (IPC-level streaming). It is user-facing; the authoritative contract is docs/contracts/CONTRACT_IPC.md.

Not to be confused with the streaming ingestion policy, which controls write batching and flush triggers on the runtime side. For the streaming ingestion policy, see docs/guides/policy.md and docs/contracts/CONTRACT_POLICY.md.

Event Streaming

Executors stream events immediately as they occur. The runtime applies ingestion policy on the receiving side.

Artifacts and Chunking

Large artifacts are chunked into multiple frames. The artifact event acts as the commit record that makes the artifact visible.

Key expectations:

  • Chunks may arrive before the artifact event.
  • The artifact event is the authoritative commit.
  • Orphaned chunks may be garbage-collected if no event arrives.

Backpressure

When the runtime applies backpressure, the executor stalls and the script blocks. This avoids hidden buffers and makes loss explicit.