Documentation
¶
Overview ¶
Package gossip is a simple implementation of a gossip protocol for noise. It keeps track of a cache of messages sent/received to/from peers to avoid re-gossiping particular messages to specific peers.
Index ¶
Constants ¶
const (
DefaultPeerToSendRelay = 16
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Events ¶
type Events struct {
// OnGossipReceived is called whenever new gossip is received from the network. An error may be return to
// disconnect the sender sending you data; indicating that the gossip received is invalid.
OnRelayReceived func(sender noise.ID, data []byte) error
}
Events comprise of callbacks that may be hooked against by a user to handle inbound gossip messages/events that occur throughout the lifecycle of this gossip protocol.
type Message ¶
type Message struct {
From noise.ID
Code byte
To noise.PublicKey
Data []byte
// contains filtered or unexported fields
}
func UnmarshalMessage ¶
type Option ¶
type Option func(protocol *Protocol)
Option is a functional option that may be configured when instantiating a new instance of this gossip protocol.
func WithEvents ¶
WithEvents registers a batch of callbacks onto a single gossip protocol instance.
type Protocol ¶
type Protocol struct {
Logging bool
// contains filtered or unexported fields
}
Protocol implements a simple gossiping protocol that avoids resending messages to peers that it already believes is aware of particular messages that are being gossiped.
func New ¶
New returns a new instance of a gossip protocol with 32MB of in-memory cache instantiated.
func (*Protocol) Bind ¶
Bind registers a single message gossip.Message, and handles them by registering the (*Protocol).Handle Handler.
Source Files