gossip

Documentation

Index

• Constants
• Variables
• type ParametersDefinition

Constants

const PluginName = "Gossip"

PluginName is the name of the gossip plugin.

Variables

var ErrMessageNotFound = errors.New("message not found")

ErrMessageNotFound is returned when a message could not be found in the Tangle.

var Parameters = &ParametersDefinition{}

Parameters contains the configuration parameters of the gossip plugin.

var (
	// Plugin is the plugin instance of the gossip plugin.
	Plugin *node.Plugin
)

Types

type ParametersDefinition

type ParametersDefinition struct {
	// BindAddress defines on which address the gossip service should listen.
	BindAddress string `default:"0.0.0.0:14666" usage:"the bind address for the gossip"`

	// MissingMessageRequestRelayProbability defines the probability of missing message requests being relayed to other neighbors.
	MissingMessageRequestRelayProbability float64 `default:"0.01" usage:"the probability of missing message requests being relayed to other neighbors"`

	MessagesRateLimit        messagesLimitParameters
	MessageRequestsRateLimit messageRequestsLimitParameters
}

ParametersDefinition contains the definition of configuration parameters used by the gossip plugin.