Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

Engine Protocol Reference

Channel and ARGUS operations composed over a TEMPEST Peer.

C++20 target: DARTWIC::EngineProtocol.

APIDescription
ValueApplication values shared with TEMPEST, independent of wire encoding.
ChannelFieldsOptional fields; omitted values leave existing data unchanged.
ChannelChangeA requested change to one channel.
ChannelChangesOne or more requested channel field changes.
ChannelUpsertRequestOwner-directed batch; execution is synchronous but not atomic.
ChannelRemoveRequestOwner-directed deletion of one channel.
ChannelQueryCurrent channel names and optional field selection; empty selections mean all.
ChannelUpdateAn observed record; local publications fill missing source lineage automatically.
ChannelUpdatesObserved channel records, including repeated timestamped samples.
ChannelQueryResultMatching current channel records returned by a synchronous query.
ChannelSnapshotComplete shared selection; an empty selection clears the receiver’s mirror.
EventTypeThe six supported ARGUS presentation and workflow types.
eventTypeNameReturn the lowercase wire name for an event type.
eventTypeFromNameParse a supported lowercase event type or throw on invalid input.
ArgusEventARGUS event identity, presentation, ownership, channel references, and details.
ArgusQueryARGUS event selection by identity, status, type, owner, time range, limit, and additional filters.
ArgusQueryResultARGUS events returned by a peer, with result and total counts.
ArgusActionAction on an ARGUS event.
ArgusActionResultEvent identity and result fields returned by an ARGUS action handler.
LogEntryText output from one process stream.
LogQuerySelects one node, process session, and stream, with optional sequence, text, channel, level, and UTC nanosecond time filters.
LogStreamIdentifies one originating node, process session, and named log source.
ArgusBoardSnapshotComplete current event board.
ChannelHandlersInstall before Peer.start.
ArgusHandlersOwner-side event commands and incoming event/complete-board telemetry.
LogHandlersSupported log-history commands and incoming batches of entries.
EngineRequestTyped synchronous requests carried by the shared Engine contract.
EngineTelemetryTyped best-effort observations and complete snapshots.
ARGUS_UPDATE_EVENT_STATUS_OPERATIONEngine operation name for owner-directed ARGUS actions.
ARGUS_RESPOND_TO_PROMPT_OPERATIONEngine operation name for owner-directed ARGUS actions.
ARGUS_RELEASE_HOLD_OPERATIONEngine operation name for owner-directed ARGUS actions.
ARGUS_DELETE_EVENT_OPERATIONEngine operation name for owner-directed ARGUS actions.
versionTEMPEST compatibility version supplied by the SDK.
fieldsEncode supplied channel fields without inventing omitted values.
operationMap a typed request to its TEMPEST operation name.
argumentsMap a typed request to its argument object.
requestValidate and parse a TEMPEST operation argument object.
resultMap a typed result to its TEMPEST response object.
channelResultParse a channel snapshot response.
argusResultParse an ARGUS query response.
actionResultParse an ARGUS action response.
topicMap typed telemetry to its TEMPEST topic.
payloadMap typed telemetry to its application object.
telemetryParse a known topic and its application object.
EngineProtocolTyped application contract over Peer.