Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

Messaging Reference

Codec-independent values, messages, transport and peer lifecycle.

C++20 target: TEMPEST::Messaging.

APIDescription
ValueApplication values independent of encoding: null, bool, exact signed/unsigned 64-bit integers, double, string, array, or object.
ConnectionStatePeer lifecycle state; Connected means registration completed.
MessageOperations, replies and telemetry share this in-memory envelope.
TransportPathOne observed transport path.
TransportImplement start, send and stop for custom framing and I/O.
TransportPtrShared ownership of an application transport.
SerializedTelemetryTransportOptional adapter optimization for complete, replaceable telemetry snapshots.
AllowedRolesAuthorization roles permitted to invoke an operation.
ErrorBase messaging failure.
DisconnectedErrorThe connection ended before the operation completed.
TimeoutErrorThe single request deadline expired; remote completion is unknown.
QueueFullErrorA bounded request or transport queue rejected the operation.
RemoteErrorRemote operation failure with a machine-readable code.
PeerConfigExplicit peer and protocol identity, deadlines and bounded queue limits.
OperationArgumentMetadata for a callable operation.
OperationDescriptorA peer-visible command with typed argument metadata.
operationDescriptorValueEncode one descriptor as a codec-independent TEMPEST object.
TelemetryDescriptorA peer-visible telemetry topic.
telemetryDescriptorValueEncode a telemetry descriptor as a codec-independent TEMPEST object.
PeerGeneric operations and telemetry over a Transport, with no DARTWIC, JSON or socket dependency.