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

APIDescription
DARTWIC_SHARE_PROTOCOL_VERSIONWire protocol version used by Share Hello and JSON frames.
ARGUS_UPDATE_EVENT_STATUS_OPERATIONOperation name for changing an ARGUS event status.
ARGUS_RESPOND_TO_PROMPT_OPERATIONOperation name for responding to an ARGUS prompt.
ARGUS_RELEASE_HOLD_OPERATIONOperation name for releasing an ARGUS hold.
ARGUS_DELETE_EVENT_OPERATIONOperation name for deleting an ARGUS event.
ValueJSON-compatible value preserving signed and unsigned integers, floating-point numbers, strings, arrays, objects, booleans, and null.
ChannelSampleOne channel value with its RAPID timestamp in nanoseconds.
ChannelUpsertChannel field write or telemetry update, including optional snapshot data and owner/session/revision lineage.
ChannelRemoveChannel deletion identified by owner and channel, with optional session/revision lineage.
ChannelBulkUpsertBatch of timestamped samples for one channel.
ChannelQueryChannel keys and requested fields for a synchronous peer snapshot query.
ChannelSnapshotOne channel returned by a query, with its data and owner/session/revision lineage.
ChannelQueryResultChannel snapshots returned by a peer query handler.
FixedGenerationWriteOne field write within a fixed-generation telemetry batch.
FixedGenerationTelemetryWrites belonging to one source generation, with a source timestamp and relay route.
ChannelTelemetryOne-way channel upsert, removal, or bulk update.
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.
ArgusEventTelemetryOne-way ARGUS event creation, update, or removal, with ownership and relay route.
RequestTyped request variants accepted by a Share transport.
SuccessSuccessful acknowledgement for a command, with optional result fields.
UnsupportedResponse indicating that a requested operation has no supported handler.
RemoteErrorRemote failure response carrying a message and machine-readable code.
ResponseTyped successful and error responses returned by a Share transport.
TelemetryOne-way channel, fixed-generation, or ARGUS telemetry payload.
CapabilitiesPeer support for channel commands, queries, telemetry, and ARGUS actions, queries, and telemetry.
HelloShare handshake carrying node identity, session identity, protocol version, and capabilities.
GoodbyeGraceful session termination notice and reason.
SessionIdentityNode and session identity carried by a control frame.
ControlHandshake, capability, shutdown, and identity control payloads.
ShareErrorBase exception for Share validation, connection, timeout, transport, and remote-operation failures.
ValidationErrorException for invalid node names, channel names, transport configuration, or request values.
DisconnectedErrorException when an operation needs a ready Share session but the session is unavailable.
RequestTimeoutErrorException when a request or handshake does not complete within its timeout.
TransportErrorException reporting a transport-level failure.
RemoteOperationErrorException for an unsupported operation, remote error, or unexpected response type.
TransportStatePhysical connection lifecycle reported by the transport.
ShareTransportPtrShared ownership of a custom or built-in Share transport.
ShareProtocolConfigLocal node identity and synchronous request timeout.
ChannelHandlersApplication handlers for incoming channel commands, queries, and telemetry.
ArgusHandlersApplication handlers for incoming ARGUS queries, actions, and telemetry.
DARTWICShareProtocolTransport-agnostic developer facade for the DARTWIC Share protocol.
normalizeArgusChannelReferenceForViewerQualify a local channel reference with its owner, or remove a qualifier matching the viewer.
normalizeArgusEventForViewerSet event ownership and normalize its channel references for the receiving viewer.
normalizeArgusQueryForTargetNormalize the string channel filter from the querying source to the target node.