discovery

Documentation

Index

• type Discovery
  • func NewDiscovery(h host.Host, d discovery.Discovery, peersLimit uint, ...) *Discovery
  • func (d *Discovery) Advertise(ctx context.Context)
  • func (d *Discovery) EnsurePeers(ctx context.Context)
  • func (d *Discovery) Peers(ctx context.Context) ([]peer.ID, error)
  • func (d *Discovery) WithOnPeersUpdate(f OnUpdatedPeers)
• type OnUpdatedPeers

Types

type Discovery

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

Discovery combines advertise and discover services and allows to store discovered nodes.

func NewDiscovery

func NewDiscovery(
	h host.Host,
	d discovery.Discovery,
	peersLimit uint,
	discInterval,
	advertiseInterval time.Duration,
) *Discovery

NewDiscovery constructs a new discovery.

func (*Discovery) Advertise

func (d *Discovery) Advertise(ctx context.Context)

Advertise is a utility function that persistently advertises a service through an Advertiser.

func (*Discovery) EnsurePeers

func (d *Discovery) EnsurePeers(ctx context.Context)

EnsurePeers ensures we always have 'peerLimit' connected peers. It starts peer discovery every 30 seconds until peer cache reaches peersLimit. Discovery is restarted if any previously connected peers disconnect.

func (*Discovery) Peers

func (d *Discovery) Peers(ctx context.Context) ([]peer.ID, error)

Peers provides a list of discovered peers in the "full" topic. If Discovery hasn't found any peers, it blocks until at least one peer is found.

func (*Discovery) WithOnPeersUpdate

func (d *Discovery) WithOnPeersUpdate(f OnUpdatedPeers)

WithOnPeersUpdate adds OnPeersUpdate callback call on every update of discovered peers list.

type OnUpdatedPeers

type OnUpdatedPeers func(peerID peer.ID, isAdded bool)