Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

struct CommandResultData

fbs/control.fbs / Source schema

Result, progress, and routing information for command execution. Sent as the queryable reply for command requests; InProgress replies may stream until a terminal result is reached.

FlatBuffers root table: CommandResult

NameTypeUnit / ScaleNotes
timestamp_usulongmicrosecondsResult timestamp in monotonic boot time.
result_detailintProducer-defined extended result or error detail.
command_idushortCommand identifier this result refers to.
resultsynapse.types.CommandResultCodeCommand execution result.
progress_pctubytepercentCompletion progress from 0 to 100 while InProgress.
target_systemubyteSystem identifier that produced or should receive the result.
target_componentubyteComponent identifier that produced or should receive the result.