Plugins
Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0
Share JSON Codec Reference
Encode and decode Share frames with nlohmann JSON; supply your own framing and delivery.
APIs
| API | Description |
|---|---|
| toJson | Convert a Share Value to a JSON value. |
| fromJson | Convert a JSON value to the corresponding Share Value variant. |
| argusEventToJson | Encode ARGUS event fields as a JSON object. |
| argusEventFromJson | Read ARGUS event fields from a JSON object. |
| argusQueryToJson | Encode ARGUS query filters as a JSON object. |
| argusQueryFromJson | Read ARGUS query filters from a JSON object. |
| encodeRequest | Encode a versioned request frame with the caller-supplied correlation ID. |
| decodeRequest | Decode a supported version-4 request frame. |
| encodeResponse | Encode a response using the original request type and correlation ID. |
| decodeResponse | Decode a supported version-4 response frame. |
| encodeTelemetry | Encode a one-way telemetry frame without request correlation. |
| decodeTelemetry | Decode supported channel, fixed-generation, or ARGUS telemetry. |
| encodeControl | Encode a Hello, capabilities, Goodbye, or session identity control frame. |
| decodeControl | Decode a supported control frame. |
| delivery | Read the frame delivery discriminator; returns an empty string when the field is absent. |
| requestId | Read the frame correlation ID; returns an empty string when the field is absent. |