Plugins
Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0
Share Protocol Reference
Typed channel and ARGUS APIs, payloads, readiness, errors, and session controls.
APIs
| API | Description |
|---|---|
| DARTWIC_SHARE_PROTOCOL_VERSION | Wire protocol version used by Share Hello and JSON frames. |
| ARGUS_UPDATE_EVENT_STATUS_OPERATION | Operation name for changing an ARGUS event status. |
| ARGUS_RESPOND_TO_PROMPT_OPERATION | Operation name for responding to an ARGUS prompt. |
| ARGUS_RELEASE_HOLD_OPERATION | Operation name for releasing an ARGUS hold. |
| ARGUS_DELETE_EVENT_OPERATION | Operation name for deleting an ARGUS event. |
| Value | JSON-compatible value preserving signed and unsigned integers, floating-point numbers, strings, arrays, objects, booleans, and null. |
| ChannelSample | One channel value with its RAPID timestamp in nanoseconds. |
| ChannelUpsert | Channel field write or telemetry update, including optional snapshot data and owner/session/revision lineage. |
| ChannelRemove | Channel deletion identified by owner and channel, with optional session/revision lineage. |
| ChannelBulkUpsert | Batch of timestamped samples for one channel. |
| ChannelQuery | Channel keys and requested fields for a synchronous peer snapshot query. |
| ChannelSnapshot | One channel returned by a query, with its data and owner/session/revision lineage. |
| ChannelQueryResult | Channel snapshots returned by a peer query handler. |
| FixedGenerationWrite | One field write within a fixed-generation telemetry batch. |
| FixedGenerationTelemetry | Writes belonging to one source generation, with a source timestamp and relay route. |
| ChannelTelemetry | One-way channel upsert, removal, or bulk update. |
| 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. |
| ArgusEventTelemetry | One-way ARGUS event creation, update, or removal, with ownership and relay route. |
| Request | Typed request variants accepted by a Share transport. |
| Success | Successful acknowledgement for a command, with optional result fields. |
| Unsupported | Response indicating that a requested operation has no supported handler. |
| RemoteError | Remote failure response carrying a message and machine-readable code. |
| Response | Typed successful and error responses returned by a Share transport. |
| Telemetry | One-way channel, fixed-generation, or ARGUS telemetry payload. |
| Capabilities | Peer support for channel commands, queries, telemetry, and ARGUS actions, queries, and telemetry. |
| Hello | Share handshake carrying node identity, session identity, protocol version, and capabilities. |
| Goodbye | Graceful session termination notice and reason. |
| SessionIdentity | Node and session identity carried by a control frame. |
| Control | Handshake, capability, shutdown, and identity control payloads. |
| ShareError | Base exception for Share validation, connection, timeout, transport, and remote-operation failures. |
| ValidationError | Exception for invalid node names, channel names, transport configuration, or request values. |
| DisconnectedError | Exception when an operation needs a ready Share session but the session is unavailable. |
| RequestTimeoutError | Exception when a request or handshake does not complete within its timeout. |
| TransportError | Exception reporting a transport-level failure. |
| RemoteOperationError | Exception for an unsupported operation, remote error, or unexpected response type. |
| TransportState | Physical connection lifecycle reported by the transport. |
| ShareTransportPtr | Shared ownership of a custom or built-in Share transport. |
| ShareProtocolConfig | Local node identity and synchronous request timeout. |
| ChannelHandlers | Application handlers for incoming channel commands, queries, and telemetry. |
| ArgusHandlers | Application handlers for incoming ARGUS queries, actions, and telemetry. |
| DARTWICShareProtocol | Transport-agnostic developer facade for the DARTWIC Share protocol. |
| normalizeArgusChannelReferenceForViewer | Qualify a local channel reference with its owner, or remove a qualifier matching the viewer. |
| normalizeArgusEventForViewer | Set event ownership and normalize its channel references for the receiving viewer. |
| normalizeArgusQueryForTarget | Normalize the string channel filter from the querying source to the target node. |