Clients

Covers Engine 2.0.0

TEMPEST Peer Reference

Optional peer messaging for external applications.

C++20 targets: DARTWIC::EngineProtocolPeer adds channels, events and logs; TEMPEST::Peer supplies custom operations and telemetry over TEMPEST TCP. DARTWIC::PeerClient remains a compatibility target and C++ name.

The Engine and C++ applications use the same EngineProtocolPeer class. The Engine attaches it to its server-owned Peer, preserving existing sockets and lifecycle; standalone applications can use the supplied TCP transport or a custom Transport.

APIDescription
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.
ZmqPeerConfigDefault ZeroMQ connection and advertised endpoints.
PeerDeclarationExplicit connection contract declared before an incoming peer is constructed.
makeZmqTransportCreate the optional standalone ZeroMQ transport with four socket roles and JSON encoding.
ZmqPeerHubReuse an engine server ROUTER/PUB and own one shared SUB plus one DEALER per logical peer connection.
EngineProtocolPeerConfigNamed application identity and default link settings.
EngineProtocolPeerShared EngineProtocol + TEMPEST Peer composition used by the Engine and C++ applications.
PeerClientConfigCompatibility name for the Engine Protocol Peer configuration.
PeerClientCompatibility name for EngineProtocolPeer.