resolver

Documentation

Index

• Constants
• Variables
• func Bootstrap(ctx context.Context, bootstrapPeers ...*peer.Peer) error
• func Lookup(ctx context.Context, opts ...LookupOption) (<-chan *peer.Peer, error)
• func WithBoostrapPeers(ps []*peer.Peer) func(*resolver)
• func WithEventbus(eb eventbus.Eventbus) func(*resolver)
• func WithExchange(x exchange.Exchange) func(*resolver)
• func WithKeychain(k keychain.Keychain) func(*resolver)
• type LookupFilter
• type LookupOption
  • func LookupByCertificateSigner(certSigner crypto.PublicKey) LookupOption
  • func LookupByContentHash(hash object.Hash) LookupOption
  • func LookupByContentType(contentType string) LookupOption
  • func LookupByOwner(keys ...crypto.PublicKey) LookupOption
  • func LookupOnlyLocal() LookupOption
• type LookupOptions
  • func ParseLookupOptions(opts ...LookupOption) *LookupOptions
  • func (l LookupOptions) Match(p *peer.Peer) bool
• type Option
• type Resolver
  • func New(ctx context.Context, opts ...Option) Resolver

Constants

const (
	ErrNoPeersToAsk = errors.Error("no peers to ask")
)

Variables

var (
	DefaultResolver = New(
		context.Background(),
		WithEventbus(eventbus.DefaultEventbus),
		WithExchange(exchange.DefaultExchange),
		WithKeychain(keychain.DefaultKeychain),
	)
)

Functions

func Bootstrap

func Bootstrap(
	ctx context.Context,
	bootstrapPeers ...*peer.Peer,
) error

func Lookup

func Lookup(
	ctx context.Context,
	opts ...LookupOption,
) (<-chan *peer.Peer, error)

func WithBoostrapPeers

func WithBoostrapPeers(ps []*peer.Peer) func(*resolver)

WithBoostrapPeers overrides the default bootstrap peers for the resolver.

func WithEventbus

func WithEventbus(eb eventbus.Eventbus) func(*resolver)

WithEventbus overrides the default eventbus for the resolver.

func WithExchange

func WithExchange(x exchange.Exchange) func(*resolver)

WithExchange overrides the default exchange for the resolver.

func WithKeychain

func WithKeychain(k keychain.Keychain) func(*resolver)

WithKeychain overrides the default keychain for the resolver.

Types

type LookupFilter

type LookupFilter func(*peer.Peer) bool

LookupOptions

type LookupOption

type LookupOption func(*LookupOptions)

LookupOptions

func LookupByCertificateSigner

func LookupByCertificateSigner(certSigner crypto.PublicKey) LookupOption

LookupByCertificateSigner matches certificate signers

func LookupByContentHash

func LookupByContentHash(hash object.Hash) LookupOption

LookupByContentHash matches content hashes

func LookupByContentType

func LookupByContentType(contentType string) LookupOption

LookupByContentType matches content hashes

func LookupByOwner

func LookupByOwner(keys ...crypto.PublicKey) LookupOption

LookupByOwner matches the peer key

func LookupOnlyLocal

func LookupOnlyLocal() LookupOption

LookupOnlyLocal forces the discoverer to only look at its cache

type LookupOptions

type LookupOptions struct {
	Local bool
	// Lookups are strings we are looking for, will be used to create a
	// bloom filter when forwarding the lookup request to providers
	Lookups []string
	// filters are the lookups equivalents for matching local peers
	Filters []LookupFilter
}

LookupOptions

func ParseLookupOptions

func ParseLookupOptions(opts ...LookupOption) *LookupOptions

func (LookupOptions) Match

func (l LookupOptions) Match(p *peer.Peer) bool

type Option

type Option func(*resolver)

Option for customizing a new resolver

type Resolver

type Resolver interface {
	Lookup(
		ctx context.Context,
		opts ...LookupOption,
	) (<-chan *peer.Peer, error)
	Bootstrap(
		ctx context.Context,
		bootstrapPeers ...*peer.Peer,
	) error
}

func New

func New(
	ctx context.Context,
	opts ...Option,
) Resolver

New returns a new resolver