Skip to content

Runtime Control Frame Metadata

This page defines fixed metadata for the runtime.control frames. Multi-value fields use the Runtime Control Value Registries.

Control Request Metadata

Used by CANCEL and ABORT.

OffsetFieldTypeRequiredMeaning
0operation_idu64YesTarget operation. 0 means session-level control.
8control_sequenceu64YesMonotonic sequence within the sender.
16reason_codeu16YesSee reason_code in the value registries.
18source_roleu8YesSee role codes in the value registries.
19flagsu8YesSee flag masks in the value registries.
20diagnostic_bytesu32NoOptional diagnostic body length.
24reservedu64YesMust be zero.

Scheduling Metadata

Used by PRIORITY_UPDATE, DEADLINE, and EXPIRE_AT.

OffsetFieldTypeRequiredMeaning
0operation_idu64YesTarget operation.
8control_sequenceu64YesMonotonic sequence within the sender.
16priority_classu16For PRIORITY_UPDATENew priority class.
18priority_deltai16NoRelative priority adjustment.
20deadline_unix_msu64For DEADLINE / EXPIRE_ATAbsolute deadline or expiration timestamp.
28flagsu32YesSee flag masks in the value registries.

Supersede Metadata

Used by SUPERSEDE.

OffsetFieldTypeRequiredMeaning
0old_operation_idu64YesOperation whose late result may be dropped.
8new_operation_idu64YesReplacement operation.
16control_sequenceu64YesMonotonic sequence within the sender.
24drop_reason_codeu16YesSee drop_reason_code in the value registries.
26flagsu16YesSee flag masks in the value registries.
28diagnostic_bytesu32NoOptional diagnostic body length.

Budget Metadata

Used by BUDGET_UPDATE.

OffsetFieldTypeRequiredMeaning
0operation_idu64YesTarget operation or 0 for session-level budget.
8compute_budget_unitsu64NoCompute units under the negotiated cost model.
16memory_budget_bytesu64NoMemory budget.
24bandwidth_budget_bytesu64NoTransport budget.
32token_budgetu32NoToken budget when applicable.
36flagsu32YesSee flag masks in the value registries.

Progress Metadata

Used by PROGRESS.

OffsetFieldTypeRequiredMeaning
0operation_idu64YesOperation being reported.
8progress_sequenceu64YesMonotonic progress sequence.
16stage_codeu16YesSee stage_code in the value registries.
18percent_x100u16No0..10000; 0xffff means unknown.
20object_idu64NoRuntime object attached to this progress event.
28body_bytesu32NoOptional progress payload length.

Partial Result Metadata

Used by PARTIAL_RESULT.

OffsetFieldTypeRequiredMeaning
0operation_idu64YesOperation being reported.
8result_sequenceu64YesMonotonic result sequence.
16object_idu64NoReferenced runtime object.
24delta_sequenceu64NoObject delta sequence.
32body_bytesu32NoInline body length.
36flagsu32YesSee flag masks in the value registries.

Pressure Metadata

Used by BACKPRESSURE and CREDIT_UPDATE.

OffsetFieldTypeRequiredMeaning
0scope_idu64YesSession or operation scope.
8credit_windowu64For CREDIT_UPDATENew send window.
16pressure_levelu16For BACKPRESSURESee pressure_level in the value registries.
18pressure_reasonu16NoSee pressure_reason in the value registries.
20retry_after_msu32NoSender should wait before sending more.
24flagsu32YesSee flag masks in the value registries.
28reservedu32YesMust be zero.

Capability Metadata

Used by CAPABILITY_NEGOTIATION and DEGRADE_PROFILE.

OffsetFieldTypeRequiredMeaning
0profile_idu16YesProfile being negotiated.
2capability_countu16YesNumber of capability entries in the body.
4cost_model_idu16NoSee cost_model_id in the value registries.
6preference_ranku16NoLower value means stronger preference.
8limit_bytesu64NoAggregate byte limit for the profile.
16limit_unitsu64NoAggregate compute or token limit.
24body_bytesu32YesCapability entry body length.
28flagsu32YesSee flag masks in the value registries.

Route Hint Metadata

Used by ROUTE_HINT and EXECUTION_HINT.

OffsetFieldTypeRequiredMeaning
0operation_idu64YesOperation being routed.
8route_idu32NoPreferred route.
12executor_classu16NoSee executor_class in the value registries.
14affinity_classu16NoSee affinity_class in the value registries.
16deadline_unix_msu64NoRoute-level deadline.
24body_bytesu32NoOptional hint body length.
28flagsu32YesSee flag masks in the value registries.

Trace Context Metadata

Used by TRACE_CONTEXT.

OffsetFieldTypeRequiredMeaning
0trace_idu64YesTrace identifier, mirrored in the common header when possible.
8span_idu64YesCurrent span.
16parent_span_idu64NoParent span.
24stage_codeu16NoSee stage_code in the value registries.
26flagsu16YesSee flag masks in the value registries.
28body_bytesu32NoOptional trace attribute body length.

Result Drop Metadata

Used by RESULT_DROP_REASON.

OffsetFieldTypeRequiredMeaning
0operation_idu64YesDropped operation or result.
8result_sequenceu64NoDropped result sequence.
16drop_reason_codeu16YesSee drop_reason_code in the value registries.
18source_roleu8YesSee role codes in the value registries.
19flagsu8YesSee flag masks in the value registries.
20diagnostic_bytesu32NoOptional diagnostic body length.
24reservedu64YesMust be zero.

Recoverable Error Metadata

Used by ERROR_RECOVERABLE.

OffsetFieldTypeRequiredMeaning
0error_codeu32YesError code in the active error registry.
4error_scopeu32YesConnection, session, or frame scope.
8recovery_actionu16YesSee reason_code in the value registries.
10source_roleu8YesSee role codes in the value registries.
11flagsu8YesSee flag masks in the value registries.
12retry_after_msu32NoSuggested retry delay; 0 means no explicit delay.
16related_session_idu32NoRelated session identifier.
20related_frame_idu32NoRelated frame or operation identifier low bits.
24related_view_idu32NoRelated view identifier.
28diagnostic_bytesu32NoOptional diagnostic body length.

Retry After Metadata

Used by RETRY_AFTER.

OffsetFieldTypeRequiredMeaning
0scope_idu64YesSession or operation scope; 0 means connection.
8control_sequenceu64YesMonotonic sequence within the sender.
16retry_after_msu32YesMinimum retry delay in milliseconds.
20jitter_msu32NoOptional jitter window in milliseconds.
24reason_codeu16YesSee reason_code in the value registries.
26source_roleu8YesSee role codes in the value registries.
27flagsu8YesSee flag masks in the value registries.
28diagnostic_bytesu32NoOptional diagnostic body length.

NNRP Documentation