dtrack

Documentation

Index

• func RunDistanceTracker(ctx context.Context, include, exclude map[peer.ID]struct{}, ...) (<-chan DistanceUpdate, error)
• type AdDistance
  • func NewAdDistance(options ...Option) (*AdDistance, error)
  • func (a *AdDistance) Close() error
  • func (a *AdDistance) Get(ctx context.Context, publisher peer.AddrInfo, oldestCid, newestCid cid.Cid) (int, cid.Cid, error)
• type DistanceUpdate
• type Option
  • func WithDepthLimit(limit int64) Option
  • func WithP2pHost(p2pHost host.Host) Option
  • func WithTopic(topic string) Option

Functions

func RunDistanceTracker

func RunDistanceTracker(ctx context.Context, include, exclude map[peer.ID]struct{}, provCache *pcache.ProviderCache, updateIn, timeout time.Duration, options ...Option) (<-chan DistanceUpdate, error)

Types

type AdDistance

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

AdDistance finds the distance between advertisements on an IPNI advertisement chain.

func NewAdDistance

func NewAdDistance(options ...Option) (*AdDistance, error)

NewAdDistance creates a new advertisement chain distance finder.

func (*AdDistance) Close

func (a *AdDistance) Close() error

Close closes the internal dagsync subscriber and the libp2p host if owned by this AdDistance instance.

func (*AdDistance) Get

func (a *AdDistance) Get(ctx context.Context, publisher peer.AddrInfo, oldestCid, newestCid cid.Cid) (int, cid.Cid, error)

Get returns the number af advertisements from the newest to the oldest advertisement on an IPNI advertisement chain. If newestCid is cid.Undef, then it referrs to the current head of the chain, and the head CID is returned as the 2nd return value.

type DistanceUpdate

type DistanceUpdate struct {
	ID       peer.ID
	Distance int
	Err      error
}

type Option

type Option func(*config)

func WithDepthLimit

func WithDepthLimit(limit int64) Option

WithDepthLimit configures the advertisement chain depth limit.

func WithP2pHost

func WithP2pHost(p2pHost host.Host) Option

WithP2pHost configures the libp2p host to use for connection to the advertisement publisher.

func WithTopic

func WithTopic(topic string) Option

WithTopic configures the topic name used to get the head advertisement when using data-transfer/graphsync.