Files
Igor Sirotin c3768ff3fc refactor: address review on the Node facades
Move the Messaging API back out of pkg/kernel: ffi.Handle becomes a
defined type in the internal package, so kernel can hand the context to
pkg/messaging through kernel.Handle without the kernel layer knowing the
tier exists, and without the type being nameable outside this module.

Split Discovery into DiscV5, PeerExchange and DNSDiscovery, group the
node's identity and health under Debug(), and give every facade a pointer
receiver. Drop the node name, the per-operation logging that duplicates
what the library already writes, and GetFreePortIfNeeded — port 0 already
means "let the OS pick".

Heavy kernel tests now mark themselves with requiresNode and skip under
-short, so the gate runs `go test -short ./...` instead of naming tests
in a regexp.
2026-08-25 00:46:13 +01:00

56 lines
1.9 KiB
Go

// Package messaging is the high-level, idiomatic Go binding for the
// logos-delivery Messaging API: an opinionated layer over the kernel protocols
// that owns reliability, re-subscriptions, store-based catch-up and the
// messaging event surface.
//
// It mirrors the Nim MessagingClient, which drives a node rather than wrapping
// one: a MessagingClient owns a kernel.Node, and the messaging operations are
// methods on it rather than free functions over a context handle:
//
// client, err := messaging.New(messaging.Config{
// Mode: messaging.ModeCore,
// Preset: messaging.PresetLogosDev,
// })
// if err != nil {
// return err
// }
// defer client.Close()
//
// go func() {
// for ev := range client.Events() {
// switch e := ev.(type) {
// case messaging.MessageReceivedEvent:
// log.Printf("received %q", e.Message.Payload)
// case messaging.MessagePropagatedEvent:
// log.Printf("%s propagated", e.RequestID)
// }
// }
// }()
//
// if err := client.Start(); err != nil {
// return err
// }
// if err := client.Subscribe(topic); err != nil {
// return err
// }
// requestID, err := client.Send(ctx, topic, []byte("hello"), false)
//
// Send returns once the message is accepted, not once it is delivered.
// Delivery is reported asynchronously on Events(), correlated by RequestID:
// MessagePropagatedEvent when the message reaches neighbouring nodes,
// MessageSentEvent when store-based validation confirms it, and
// MessageErrorEvent when it fails.
//
// Events() never blocks the library: an event is dropped if the channel is
// full, so consume it from a dedicated goroutine for the client's lifetime.
//
// The kernel protocols run against the same node, reached through Node. There
// is no second node and no handle to pass around:
//
// node := client.Node()
// resp, err := node.Store().Query(ctx, request, peerInfo)
// peers, err := node.Peers().Connected()
//
// Closing either the client or its node closes both.
package messaging