lassie

Documentation

Index

• type Lassie
  • func NewLassie(ctx context.Context, opts ...LassieOption) (*Lassie, error)
  • func NewLassieWithConfig(ctx context.Context, cfg *LassieConfig) (*Lassie, error)
  • func (l *Lassie) Fetch(ctx context.Context, rootCid cid.Cid, linkSystem linking.LinkSystem) (types.RetrievalID, *types.RetrievalStats, error)
  • func (l *Lassie) RegisterSubscriber(subscriber types.RetrievalEventSubscriber) func()
  • func (l *Lassie) Retrieve(ctx context.Context, request types.RetrievalRequest) (*types.RetrievalStats, error)
• type LassieConfig
• type LassieOption
  • func WithFinder(finder retriever.CandidateFinder) LassieOption
  • func WithGlobalTimeout(timeout time.Duration) LassieOption
  • func WithHost(host host.Host) LassieOption
  • func WithLibp2pOpts(libp2pOptions ...libp2p.Option) LassieOption
  • func WithProviderTimeout(timeout time.Duration) LassieOption

Types

type Lassie

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

func NewLassie

func NewLassie(ctx context.Context, opts ...LassieOption) (*Lassie, error)

func NewLassieWithConfig

func NewLassieWithConfig(ctx context.Context, cfg *LassieConfig) (*Lassie, error)

func (*Lassie) Fetch

func (l *Lassie) Fetch(ctx context.Context, rootCid cid.Cid, linkSystem linking.LinkSystem) (types.RetrievalID, *types.RetrievalStats, error)

func (*Lassie) RegisterSubscriber

func (l *Lassie) RegisterSubscriber(subscriber types.RetrievalEventSubscriber) func()

func (*Lassie) Retrieve

func (l *Lassie) Retrieve(ctx context.Context, request types.RetrievalRequest) (*types.RetrievalStats, error)

type LassieConfig

type LassieConfig struct {
	Finder          retriever.CandidateFinder
	Host            host.Host
	ProviderTimeout time.Duration
	GlobalTimeout   time.Duration
	Libp2pOptions   []libp2p.Option
}

type LassieOption

type LassieOption func(cfg *LassieConfig)

func WithFinder

func WithFinder(finder retriever.CandidateFinder) LassieOption

func WithGlobalTimeout

func WithGlobalTimeout(timeout time.Duration) LassieOption

func WithHost

func WithHost(host host.Host) LassieOption

func WithLibp2pOpts

func WithLibp2pOpts(libp2pOptions ...libp2p.Option) LassieOption

func WithProviderTimeout

func WithProviderTimeout(timeout time.Duration) LassieOption