Skip to main content Module task Copy item path Source AppendFrameOutcome Outcome of append_frame(). ClaimedTask A claimed execution with an active lease. The worker processes this task
and must call one of complete(), fail(), or cancel() when done. ConditionMatcher A condition matcher for the resume condition. ResumeSignal A signal that triggered a resume, readable by a worker after re-claim. Signal A signal to deliver to a suspended execution’s waitpoint. StreamFrames Result of read_stream / tail_stream — frames plus the terminal
signal so polling consumers can exit cleanly. FailOutcome Outcome of a fail() call. SignalOutcome Outcome of deliver_signal(). StreamCursor Opaque cursor for read_stream / tail_stream — re-export of
ff_core::contracts::StreamCursor. Wire tokens: "start", "end",
"<ms>", "<ms>-<seq>". Bare - / + are rejected — use
StreamCursor::Start / StreamCursor::End instead.
Opaque cursor for attempt-stream reads/tails. SuspendOutcome Outcome of a suspend() call. TimeoutBehavior Timeout behavior when a suspension deadline is reached. MAX_TAIL_BLOCK_MS Maximum tail block duration accepted by tail_stream . Mirrors the REST
endpoint ceiling so SDK callers can’t wedge a connection longer than the
server would accept. STREAM_READ_HARD_CAP Maximum frames per read/tail call. Mirrors
ff_core::contracts::STREAM_READ_HARD_CAP — re-exported here so SDK
callers don’t need to import ff-core just to read the bound.
Hard cap on the number of frames returned by a single read/tail call. parse_report_usage_result Parse the wire-format result of the ff_report_usage_and_check Lua
function into a typed ReportUsageResult . read_stream Read frames from a completed or in-flight attempt’s stream. tail_stream Tail a live attempt’s stream.