discovery

Documentation

Index

• Constants
• type Discovery
  • 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
• type Opt
  • 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 WithAdvertiseIntervalSpread(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 WithConnBackoffTimings(minBackoff, maxBackoff, dialTimeout time.Duration) Opt
  • func WithDir(path string) Opt
  • func WithDiscoveryBackoff(backoff bool) Opt
  • func WithDiscoveryBackoffTimings(minBackoff, maxBackoff time.Duration) 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

Constants

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

Types

type Discovery

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

func New

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

func (*Discovery) FindPeer

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

func (*Discovery) Start

func (d *Discovery) Start() error

func (*Discovery) Stop

func (d *Discovery) Stop()

type DiscoveryHost

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

type Opt

type Opt func(*Discovery)

func AdvertiseForPeerDiscovery

func AdvertiseForPeerDiscovery() Opt

func DisableDHT

func DisableDHT() Opt

func EnableRoutingDiscovery

func EnableRoutingDiscovery() Opt

func Private

func Private() Opt

func WithAdvertiseDelay

func WithAdvertiseDelay(value time.Duration) Opt

func WithAdvertiseInterval

func WithAdvertiseInterval(value time.Duration) Opt

func WithAdvertiseIntervalSpread

func WithAdvertiseIntervalSpread(value time.Duration) Opt

func WithAdvertiseRetryDelay

func WithAdvertiseRetryDelay(value time.Duration) Opt

func WithBackup

func WithBackup(backup []peer.AddrInfo) Opt

func WithBootnodes

func WithBootnodes(bootnodes []peer.AddrInfo) Opt

func WithBootstrapDuration

func WithBootstrapDuration(bootstrapDuration time.Duration) Opt

func WithConnBackoffTimings

func WithConnBackoffTimings(minBackoff, maxBackoff, dialTimeout time.Duration) Opt

func WithDir

func WithDir(path string) Opt

func WithDiscoveryBackoff

func WithDiscoveryBackoff(backoff bool) Opt

func WithDiscoveryBackoffTimings

func WithDiscoveryBackoffTimings(minBackoff, maxBackoff time.Duration) Opt

func WithFindPeersRetryDelay

func WithFindPeersRetryDelay(value time.Duration) Opt

func WithHighPeers

func WithHighPeers(peers int) Opt

func WithLogger

func WithLogger(logger *zap.Logger) Opt

func WithMinPeers

func WithMinPeers(minPeers int) Opt

func WithMode

func WithMode(mode dht.ModeOpt) Opt

func WithPeriod

func WithPeriod(period time.Duration) Opt

func WithRelayCandidateChannel

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

func WithTimeout

func WithTimeout(timeout time.Duration) Opt