discovery

Documentation

Index

• type Backend
• type BackendConfig
• type Factory

Types

type Backend

type Backend interface {
	// Close closes the backend
	Close() error

	// Deliver returns discovered elements
	Deliver() chan string

	// Schedule starts the discovery
	Schedule()
}

Backend interface must be implemented for a discovery protocol

type BackendConfig

type BackendConfig struct {
	// Logger to be used by the backend
	Logger hclog.Logger

	// Enode is the identification of the node
	Enode *enode.Enode

	// Private key of the node to encrypt/decrypt messages
	Key *ecdsa.PrivateKey

	// Specific configuration parameters for the backend
	Config map[string]interface{}
}

BackendConfig contains configuration parameters

type Factory

type Factory func(context.Context, *BackendConfig) (Backend, error)

Factory is the factory function to create a discovery backend