README
¶
Exchange Helpers
Convenience functions that orchestrate broadcast and unicast communication patterns over a network.Router
using correlation IDs and CBOR encoding.
Notes
- Correlation IDs are namespaced with
:BROADCASTand:UNICASTinternally to avoid collisions. - Messages are strongly typed by callers and serialized/deserialized via CBOR.
- Underlying routing and quorum information come from the provided
Router.
Documentation
¶
Overview ¶
Package exchange provides convenience functions that orchestrate broadcast and unicast communication patterns over a network.Router using correlation IDs and CBOR encoding.
See README.md for details.
Index ¶
- func Broadcast[B any](rt *network.Router, correlationID string, broadcastMessageOut B) (broadcastMessagesIn network.RoundMessages[B], err error)
- func Exchange[B any, U any](rt *network.Router, correlationID string, broadcastMessageOut B, ...) (broadcastMessagesIn network.RoundMessages[B], ...)
- func Unicast[U any](rt *network.Router, correlationID string, ...) (unicastMessagesIn network.RoundMessages[U], err error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Broadcast ¶
func Broadcast[B any](rt *network.Router, correlationID string, broadcastMessageOut B) (broadcastMessagesIn network.RoundMessages[B], err error)
Broadcast performs an echo-broadcast round with the given message.
func Exchange ¶
func Exchange[B any, U any](rt *network.Router, correlationID string, broadcastMessageOut B, unicastMessagesOut network.RoundMessages[U]) (broadcastMessagesIn network.RoundMessages[B], unicastMessagesIn network.RoundMessages[U], err error)
Exchange performs a combined broadcast and unicast exchange under a shared correlation ID.
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.