transport

type Message interface {
	// MarshallBinary serializes the message into a byte slice.
	MarshallBinary() ([]byte, error)

	// UnmarshallBinary deserializes the message from a byte slice.
	UnmarshallBinary([]byte) error
}

type MessageMap map[string]Message

type Meta struct {
	Transport            string `json:"transport"`
	Topic                string `json:"topic"`
	MessageID            string `json:"messageID"`
	PeerID               string `json:"peerID"`
	PeerAddr             string `json:"peerAddr"`
	ReceivedFromPeerID   string `json:"receivedFromPeerID"`
	ReceivedFromPeerAddr string `json:"receivedFromPeerAddr"`
	UserAgent            string `json:"userAgent"`
}

type ReceivedMessage struct {
	// Message contains the message content. It is nil when the Error field
	// is not nil.
	Message Message

	// Author is the author of the message.
	Author []byte

	// Data contains an optional data associated with the message. A type of
	// the data is different depending on a transport implementation.
	Data any

	// Error contains an optional error returned by transport layer.
	Error error

	// Meta contains optional information about the message.
	Meta Meta
}

type Service interface {
	supervisor.Service
	Transport
}

type Transport interface {
	// Broadcast sends a message with a given topic.
	Broadcast(topic string, message Message) error

	// Messages returns a channel for incoming messages. A new channel is
	// created for each call, therefore this method should not be used in
	// loops. In case of an error, an error will be returned in the
	// ReceivedMessage structure.
	Messages(topic string) <-chan ReceivedMessage
}