Expand description
Phase 1 function contracts — Args + Result types for each FCALL.
Each Args struct defines the typed inputs to a Valkey Function. Each Result enum defines the possible outcomes (success variants + error codes).
Modules§
- decode
- Canonical decoders for engine-owned hash shapes.
Structs§
- AddExecution
ToFlow Args - Append
Frame Args - Apply
Dependency ToChild Args - Attempt
Summary - Currently-active attempt summary inside an
ExecutionSnapshot. - Block
Execution Args - Budget
Status - Operator-facing budget status snapshot (not an FCALL — direct HGETALL reads).
- Buffer
Signal Args - Cancel
Execution Args - Cancel
Flow Args - Change
Priority Args - Check
Admission Args - Claim
Execution Args - Claim
Grant - A claim grant issued by the scheduler for a specific execution.
- Claim
Resumed Execution Args - Claimed
Execution - Claimed
Resumed Execution - Close
Waitpoint Args - Complete
Execution Args - Create
Budget Args - Create
Execution Args - Create
Flow Args - Create
Pending Waitpoint Args - Create
Quota Policy Args - Delay
Execution Args - Deliver
Signal Args - Edge
Snapshot - Engine-decoupled read-model for one dependency edge.
- Evaluate
Flow Eligibility Args - Execution
Info - Full execution info returned by
Server::get_execution. - Execution
Snapshot - Engine-decoupled read-model for one execution.
- Execution
Summary - Summary of an execution for list views.
- Expire
Execution Args - Expire
Suspension Args - Fail
Execution Args - Flow
Snapshot - Engine-decoupled read-model for one flow.
- Issue
Claim Grant Args - Issue
Reclaim Grant Args - Lease
Summary - Currently-held lease summary inside an
ExecutionSnapshot. - List
Executions Result - Result of a list_executions query.
- List
Waitpoint Hmac Kids Args - Mark
Lease Expired Args - Move
ToWaiting Children Args - Pending
Waitpoint Info - One entry in the read-only view of an execution’s active waitpoints.
- Promote
Blocked ToEligible Args - Read
Frames Args - Inputs to
ff_read_attempt_stream(XRANGE wrapper). - Reclaim
Execution Args - Reclaim
Grant - A reclaim grant issued for a resumed (attempt_interrupted) execution.
- Release
Admission Args - Renew
Lease Args - Replay
Execution Args - Report
Usage Args - Reset
Budget Args - Resolve
Dependency Args - Resume
Execution Args - Revoke
Lease Args - Rotate
Waitpoint Hmac Secret Args - Args for
ff_rotate_waitpoint_hmac_secret. Rotates the HMAC signing kid on ONE partition. Callers fan out across every partition themselves (ff-server does the parallel fan-out inrotate_waitpoint_secret; direct-Valkey consumers mirror the pattern). - SetExecution
Tags Args - Args for
ff_set_execution_tags. Tag keys MUST match^[a-z][a-z0-9_]*\.— the caller-namespace rule — or the FCALL returnsinvalid_tag_key. Values are arbitrary strings. The map is ordered (BTreeMap) so two callers submitting the same logical set of tags produce identical ARGV. - SetFlow
Tags Args - Args for
ff_set_flow_tags. Same namespace rule asSetExecutionTagsArgs. The Lua function also lazy-migrates any pre-58.4 reserved-namespace fields stashed inline onflow_coreinto the new tags key. - Stage
Dependency Edge Args - State
Summary - Summary of state after a mutation, returned by many functions.
- Stream
Frame - A single frame read from an attempt-scoped stream.
- Stream
Frames - Result of reading frames from an attempt stream — frames plus terminal signal so consumers can stop polling without a timeout fallback.
- Suspend
Execution Args - Unblock
Execution Args - Update
Progress Args - Verifying
Kid - Waitpoint
Hmac Kids - Snapshot of the waitpoint HMAC keystore on ONE partition.
Enums§
- AddExecution
ToFlow Result - Append
Frame Result - Apply
Dependency ToChild Result - Block
Execution Result - Buffer
Signal Result - Cancel
Execution Result - Cancel
Flow Result - Change
Priority Result - Check
Admission Result - Claim
Execution Result - Claim
Resumed Execution Result - Close
Waitpoint Result - Complete
Execution Result - Create
Budget Result - Create
Execution Result - Create
Flow Result - Create
Pending Waitpoint Result - Create
Quota Policy Result - Delay
Execution Result - Deliver
Signal Result - Edge
Direction - Direction marker for
crate::engine_backend::EngineBackend::list_edges. - Evaluate
Flow Eligibility Result - Expire
Execution Result - Expire
Suspension Result - Fail
Execution Result - Outcome of a fail_execution call.
- Issue
Claim Grant Result - Issue
Reclaim Grant Result - Mark
Lease Expired Result - Move
ToWaiting Children Result - Promote
Blocked ToEligible Result - Read
Frames Result - Reclaim
Execution Result - Release
Admission Result - Renew
Lease Result - Replay
Execution Result - Report
Usage Result - Reset
Budget Result - Resolve
Dependency Result - Resume
Execution Result - Revoke
Lease Result - Rotate
Waitpoint Hmac Secret Outcome - Outcome of a single-partition rotation.
- SetExecution
Tags Result - Result of
ff_set_execution_tags. - SetFlow
Tags Result - Result of
ff_set_flow_tags. - Stage
Dependency Edge Result - Stream
Cursor - Opaque cursor for attempt-stream reads/tails.
- Stream
Cursor Parse Error - Error produced when parsing a
StreamCursorfrom a string. - Suspend
Execution Result - Unblock
Execution Result - Update
Progress Result
Constants§
- STREAM_
READ_ HARD_ CAP - Hard cap on the number of frames returned by a single read/tail call.