discovery

package

v1.4.0-alpha.0 Latest Latest Go to latest Published: Feb 2, 2024 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	ProtocolID = protocolPrefix + "/kad/1.0.0"
)

This section is empty.

This section is empty.

type Discovery struct {
	// contains filtered or unexported fields
}

func New(h DiscoveryHost, opts ...Opt) (*Discovery, error)

func (d *Discovery) FindPeer(ctx context.Context, p peer.ID) (peer.AddrInfo, error)

func (d *Discovery) Start() error

func (d *Discovery) Stop()

type DiscoveryHost interface {
	host.Host
	NeedPeerDiscovery() bool
	HaveRelay() bool
}

type Opt func(*Discovery)

func AdvertiseForPeerDiscovery() Opt

func DisableDHT() Opt

func EnableRoutingDiscovery() Opt

func Private() Opt

func WithAdvertiseDelay(value time.Duration) Opt

func WithAdvertiseInterval(value time.Duration) Opt

func WithAdvertiseRetryDelay(value time.Duration) Opt

func WithBackup(backup []peer.AddrInfo) Opt

func WithBootnodes(bootnodes []peer.AddrInfo) Opt

func WithBootstrapDuration(bootstrapDuration time.Duration) Opt

func WithDir(path string) Opt

func WithFindPeersRetryDelay(value time.Duration) Opt

func WithHighPeers(peers int) Opt

func WithLogger(logger *zap.Logger) Opt

func WithMinPeers(minPeers int) Opt

func WithMode(mode dht.ModeOpt) Opt

func WithPeriod(period time.Duration) Opt

func WithRelayCandidateChannel(relayCh chan<- peer.AddrInfo) Opt

func WithTimeout(timeout time.Duration) Opt