discovery

Documentation

Index

• type Discoverer
  • func NewDiscoverer() Discoverer
• type Option
  • func Local() Option
• type Options
  • func ParseOptions(opts ...Option) *Options
• type Provider

Types

type Discoverer

type Discoverer interface {
	AddProvider(provider Provider) error
	Add(v *peer.PeerInfo)
	// AddPersistent(v *peer.PeerInfo)
	FindByFingerprint(
		ctx context.Context,
		fingerprint string,
		opts ...Option,
	) ([]*peer.PeerInfo, error)
	FindByContent(
		ctx context.Context,
		contentHash string,
		opts ...Option,
	) ([]*peer.PeerInfo, error)
}

Discoverer interface

func NewDiscoverer

func NewDiscoverer() Discoverer

NewDiscoverer creates a new empty discoverer with no providers

type Option

type Option func(*Options)

Option is the type for our functional options

func Local

func Local() Option

Local forces the discoverer to only look at its cache

type Options

type Options struct {
	Local bool
}

Options is the complete options structure for the discoverer

func ParseOptions

func ParseOptions(opts ...Option) *Options

type Provider

type Provider interface {
	FindByFingerprint(
		ctx context.Context,
		fingerprint string,
		opts ...Option,
	) ([]*peer.PeerInfo, error)
	FindByContent(
		ctx context.Context,
		contentHash string,
		opts ...Option,
	) ([]*peer.PeerInfo, error)
}

Provider defines the interface for a discoverer provider, eg our DHT