downloader

Documentation

Overview

package downloader contains a cache for downloading blocks from a renterd node. A cache optimizes the number of in-flight requests to avoid overloading the node and caches blocks to avoid redundant downloads.

Index

• type BlockDownloader
  • func NewBlockDownloader(store MetadataStore, bucket string, cacheSize, workers int, ...) (*BlockDownloader, error)
  • func (bd *BlockDownloader) Get(ctx context.Context, c cid.Cid) (blocks.Block, error)
• type MetadataStore

Types

type BlockDownloader

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

BlockDownloader is a cache for downloading blocks from a renterd node. It limits the number of in-flight requests to avoid overloading the node and caches blocks to avoid redundant downloads.

For UnixFS nodes, it also prefetches linked blocks.

func NewBlockDownloader

func NewBlockDownloader(store MetadataStore, bucket string, cacheSize, workers int, workerClient *worker.Client, log *zap.Logger) (*BlockDownloader, error)

NewBlockDownloader creates a new BlockDownloader.

func (*BlockDownloader) Get

func (bd *BlockDownloader) Get(ctx context.Context, c cid.Cid) (blocks.Block, error)

Get returns a block by CID.

type MetadataStore

type MetadataStore interface {
	BlockLocation(c cid.Cid) (bucket, key string, err error)
	BlockSiblings(c cid.Cid, max int) (siblings []cid.Cid, err error)
	BlockChildren(c cid.Cid, max int) (siblings []cid.Cid, err error)
}

A MetadataStore is a store for IPFS block metadata. It is used to optimize block downloads by prefetching linked blocks.