mirror of
https://github.com/logos-messaging/sds-go-bindings.git
synced 2026-07-24 00:43:17 +00:00
a5a47f8e6e
nim-sds built on nim-ffi 0.2.0 exports a new C ABI (snake_case symbols,
CBOR-marshalled requests/responses, named event-listener registry),
which the old PascalCase callback-based bindings could not link against
(undefined reference to SdsWrapOutgoingMessage / SdsUnwrapReceivedMessage).
Rewrite the cgo layer to the new ABI while keeping the Go-facing API
identical so consumers (status-go reliability layer) need no changes:
- sds_schema.go: CBOR structs matching nim-sds library/libsds.nim. The
.ffi. macro wraps each proc's non-ctx params in a generated request
object keyed by the param name, so requests are nested ({req:{...}});
no-extra-param procs take {_placeholder: uint8}.
- sds.go: snake_case wrappers; callback copies the callback-scoped CBOR
buffer before returning to avoid a use-after-free.
- sds_common.go: event path decodes the CBOR {eventType, payload}
envelope instead of JSON.
- NewReliabilityManager passes an empty participantId (plain SDS, SDS-R
repair disabled) to preserve pre-nim-ffi behavior.
Validated: full binding test suite (incl. event callbacks) passes
against a libsds built from nim-ffi 0.2.0.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
97 lines
2.8 KiB
Go
97 lines
2.8 KiB
Go
package sds
|
|
|
|
// CBOR wire types for the nim-ffi (v0.2.0+) libsds C API. Requests, responses
|
|
// and events are CBOR-marshalled; the field names below must match the Nim
|
|
// structs in nim-sds `library/libsds.nim` exactly (cbor_serialization encodes
|
|
// objects as definite-length maps keyed by the field name).
|
|
//
|
|
// The nim-ffi `.ffi.`/`.ffiCtor.` macros wrap each proc's non-context params in
|
|
// a generated request object whose field name is the Nim parameter name. So a
|
|
// proc `sdsWrapOutgoingMessage(rm, req: SdsWrapRequest)` decodes a request of
|
|
// shape `{ req: { ... } }` — i.e. the payload is nested under the param name.
|
|
// Procs with no extra params get a single `_placeholder: uint8` field.
|
|
|
|
// --- Inner payload structs (the documented logical payloads) ----------------
|
|
|
|
type sdsConfig struct {
|
|
ParticipantID string `cbor:"participantId"`
|
|
}
|
|
|
|
type sdsWrapRequest struct {
|
|
Message []byte `cbor:"message"`
|
|
MessageID string `cbor:"messageId"`
|
|
ChannelID string `cbor:"channelId"`
|
|
}
|
|
|
|
type sdsUnwrapRequest struct {
|
|
Message []byte `cbor:"message"`
|
|
}
|
|
|
|
type sdsMarkDependenciesRequest struct {
|
|
MessageIDs []string `cbor:"messageIds"`
|
|
ChannelID string `cbor:"channelId"`
|
|
}
|
|
|
|
type sdsMissingDep struct {
|
|
MessageID string `cbor:"messageId"`
|
|
RetrievalHint []byte `cbor:"retrievalHint"`
|
|
}
|
|
|
|
// --- Request envelopes (nested under the Nim param name) ---------------------
|
|
|
|
type sdsCreateReq struct {
|
|
Config sdsConfig `cbor:"config"`
|
|
}
|
|
|
|
type sdsWrapReq struct {
|
|
Req sdsWrapRequest `cbor:"req"`
|
|
}
|
|
|
|
type sdsUnwrapReq struct {
|
|
Req sdsUnwrapRequest `cbor:"req"`
|
|
}
|
|
|
|
type sdsMarkDependenciesReq struct {
|
|
Req sdsMarkDependenciesRequest `cbor:"req"`
|
|
}
|
|
|
|
// sdsEmptyReq is the request for procs with no extra params (reset,
|
|
// startPeriodicTasks); the macro generates a single `_placeholder` field.
|
|
type sdsEmptyReq struct {
|
|
Placeholder uint8 `cbor:"_placeholder"`
|
|
}
|
|
|
|
// --- Response payloads ------------------------------------------------------
|
|
|
|
type sdsWrapResponse struct {
|
|
Message []byte `cbor:"message"`
|
|
}
|
|
|
|
type sdsUnwrapResponse struct {
|
|
Message []byte `cbor:"message"`
|
|
ChannelID string `cbor:"channelId"`
|
|
MissingDeps []sdsMissingDep `cbor:"missingDeps"`
|
|
}
|
|
|
|
// --- Event envelope + payloads ----------------------------------------------
|
|
|
|
// Event wire names emitted by libsds.
|
|
const (
|
|
eventMessageReady = "message_ready"
|
|
eventMessageSent = "message_sent"
|
|
eventMissingDependencies = "missing_dependencies"
|
|
eventPeriodicSync = "periodic_sync"
|
|
eventRepairReady = "repair_ready"
|
|
)
|
|
|
|
type sdsMessageEventPayload struct {
|
|
MessageID string `cbor:"messageId"`
|
|
ChannelID string `cbor:"channelId"`
|
|
}
|
|
|
|
type sdsMissingDependenciesPayload struct {
|
|
MessageID string `cbor:"messageId"`
|
|
ChannelID string `cbor:"channelId"`
|
|
MissingDeps []sdsMissingDep `cbor:"missingDeps"`
|
|
}
|