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.
| API | Description |
|---|---|
| Value | Application values shared with TEMPEST, independent of wire encoding. |
| ChannelFields | Optional fields; omitted values leave existing data unchanged. |
| ChannelChange | A requested change to one channel. |
| ChannelChanges | One or more requested channel field changes. |
| ChannelUpsertRequest | Owner-directed batch; execution is synchronous but not atomic. |
| ChannelRemoveRequest | Owner-directed deletion of one channel. |
| ChannelQuery | Current channel names and optional field selection; empty selections mean all. |
| ChannelUpdate | An observed record; local publications fill missing source lineage automatically. |
| ChannelUpdates | Observed channel records, including repeated timestamped samples. |
| ChannelQueryResult | Matching current channel records returned by a synchronous query. |
| ChannelSnapshot | Complete shared selection; an empty selection clears the receiver’s mirror. |
| EventType | The six supported ARGUS presentation and workflow types. |
| eventTypeName | Return the lowercase wire name for an event type. |
| eventTypeFromName | Parse a supported lowercase event type or throw on invalid input. |
| ArgusEvent | ARGUS event identity, presentation, ownership, channel references, and details. |
| ArgusQuery | ARGUS event selection by identity, status, type, owner, time range, limit, and additional filters. |
| ArgusQueryResult | ARGUS events returned by a peer, with result and total counts. |
| ArgusAction | Action on an ARGUS event. |
| ArgusActionResult | Event identity and result fields returned by an ARGUS action handler. |
| LogEntry | Text output from one process stream. |
| LogQuery | Selects one node, process session, and stream, with optional sequence, text, channel, level, and UTC nanosecond time filters. |
| LogStream | Identifies one originating node, process session, and named log source. |
| ArgusBoardSnapshot | Complete current event board. |
| ChannelHandlers | Install before Peer.start. |
| ArgusHandlers | Owner-side event commands and incoming event/complete-board telemetry. |
| LogHandlers | Supported log-history commands and incoming batches of entries. |
| EngineRequest | Typed synchronous requests carried by the shared Engine contract. |
| EngineTelemetry | Typed best-effort observations and complete snapshots. |
| ARGUS_UPDATE_EVENT_STATUS_OPERATION | Engine operation name for owner-directed ARGUS actions. |
| ARGUS_RESPOND_TO_PROMPT_OPERATION | Engine operation name for owner-directed ARGUS actions. |
| ARGUS_RELEASE_HOLD_OPERATION | Engine operation name for owner-directed ARGUS actions. |
| ARGUS_DELETE_EVENT_OPERATION | Engine operation name for owner-directed ARGUS actions. |
| version | TEMPEST compatibility version supplied by the SDK. |
| fields | Encode supplied channel fields without inventing omitted values. |
| operation | Map a typed request to its TEMPEST operation name. |
| arguments | Map a typed request to its argument object. |
| request | Validate and parse a TEMPEST operation argument object. |
| result | Map a typed result to its TEMPEST response object. |
| channelResult | Parse a channel snapshot response. |
| argusResult | Parse an ARGUS query response. |
| actionResult | Parse an ARGUS action response. |
| topic | Map typed telemetry to its TEMPEST topic. |
| payload | Map typed telemetry to its application object. |
| telemetry | Parse a known topic and its application object. |
| EngineProtocol | Typed application contract over Peer. |