discovery

Documentation

Index

• type Discoverer
  • func NewDiscoverer() Discoverer
• type Option
  • func Local() Option
• type Options
  • func ParseOptions(opts ...Option) *Options
• type Provider
• type StringPeerPeerSyncMap
  • func NewStringPeerPeerSyncMap() *StringPeerPeerSyncMap
  • func (m *StringPeerPeerSyncMap) Delete(k string)
  • func (m *StringPeerPeerSyncMap) Get(k string) (*peer.Peer, bool)
  • func (m *StringPeerPeerSyncMap) Put(k string, v *peer.Peer)
  • func (m *StringPeerPeerSyncMap) Range(i func(k string, v *peer.Peer) bool)

Types

type Discoverer

type Discoverer interface {
	AddProvider(provider Provider) error
	Add(peer *peer.Peer)
	FindByFingerprint(
		ctx context.Context,
		fingerprint crypto.Fingerprint,
		opts ...Option,
	) ([]*peer.Peer, error)
	FindByContent(
		ctx context.Context,
		contentHash string,
		opts ...Option,
	) ([]crypto.Fingerprint, 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 crypto.Fingerprint,
		opts ...Option,
	) ([]*peer.Peer, error)
	FindByContent(
		ctx context.Context,
		contentHash string,
		opts ...Option,
	) ([]crypto.Fingerprint, error)
}

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

type StringPeerPeerSyncMap

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

StringPeerPeerSyncMap -

func NewStringPeerPeerSyncMap

func NewStringPeerPeerSyncMap() *StringPeerPeerSyncMap

NewStringPeerPeerSyncMap constructs a new SyncMap

func (*StringPeerPeerSyncMap) Delete

func (m *StringPeerPeerSyncMap) Delete(k string)

Delete -

func (*StringPeerPeerSyncMap) Get

func (m *StringPeerPeerSyncMap) Get(k string) (*peer.Peer, bool)

Get -

func (*StringPeerPeerSyncMap) Put

func (m *StringPeerPeerSyncMap) Put(k string, v *peer.Peer)

Put -

func (*StringPeerPeerSyncMap) Range

func (m *StringPeerPeerSyncMap) Range(i func(k string, v *peer.Peer) bool)

Range -