simple

Documentation

Overview

Package simple implements structures and methods to provide blocks, keep track of which blocks are provided, and to allow those blocks to be reprovided.

Index

• Variables
• type KeyChanFunc
  • func NewBlockstoreProvider(bstore blocks.Blockstore) KeyChanFunc
  • func NewPinnedProvider(onlyRoots bool, pinning Pinner, fetchConfig fetcher.Factory) KeyChanFunc
• type Option
  • func MaxWorkers(count int) Option
  • func WithTimeout(timeout time.Duration) Option
• type Pinner
• type Provider
  • func NewProvider(ctx context.Context, queue *q.Queue, contentRouting routing.ContentRouting, ...) *Provider
  • func (p *Provider) Close() error
  • func (p *Provider) Provide(root cid.Cid) error
  • func (p *Provider) Run()
• type Reprovider
  • func NewReprovider(ctx context.Context, reprovideInterval time.Duration, ...) *Reprovider
  • func (rp *Reprovider) Close() error
  • func (rp *Reprovider) Reprovide() error
  • func (rp *Reprovider) Run()
  • func (rp *Reprovider) Trigger(ctx context.Context) error

Variables

var ErrClosed = errors.New("reprovider service stopped")

ErrClosed is returned by Trigger when operating on a closed reprovider.

Deprecated: use github.com/ipfs/boxo/provider/simple.ErrClosed

Types

type KeyChanFunc

type KeyChanFunc func(context.Context) (<-chan cid.Cid, error)

KeyChanFunc is function streaming CIDs to pass to content routing

Deprecated: use github.com/ipfs/boxo/provider/simple.KeyChanFunc

func NewBlockstoreProvider

func NewBlockstoreProvider(bstore blocks.Blockstore) KeyChanFunc

NewBlockstoreProvider returns key provider using bstore.AllKeysChan

Deprecated: use github.com/ipfs/boxo/provider/simple.NewBlockstoreProvider

func NewPinnedProvider

func NewPinnedProvider(onlyRoots bool, pinning Pinner, fetchConfig fetcher.Factory) KeyChanFunc

NewPinnedProvider returns provider supplying pinned keys

Deprecated: use github.com/ipfs/boxo/provider/simple.NewPinnedProvider

type Option

type Option func(*Provider)

Option defines the functional option type that can be used to configure provider instances

Deprecated: use github.com/ipfs/boxo/provider/simple.Option

func MaxWorkers

func MaxWorkers(count int) Option

MaxWorkers is an option to set the max workers on a provider

Deprecated: use github.com/ipfs/boxo/provider/simple.MaxWorkers

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout is an option to set a timeout on a provider

Deprecated: use github.com/ipfs/boxo/provider/simple.WithTimeout

type Pinner

type Pinner interface {
	DirectKeys(ctx context.Context) ([]cid.Cid, error)
	RecursiveKeys(ctx context.Context) ([]cid.Cid, error)
}

Pinner interface defines how the simple.Reprovider wants to interact with a Pinning service

Deprecated: use github.com/ipfs/boxo/provider/simple.Pinner

type Provider

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

Provider announces blocks to the network

Deprecated: use github.com/ipfs/boxo/provider/simple.Provider

func NewProvider

func NewProvider(ctx context.Context, queue *q.Queue, contentRouting routing.ContentRouting, options ...Option) *Provider

NewProvider creates a provider that announces blocks to the network using a content router

Deprecated: use github.com/ipfs/boxo/provider/simple.NewProvider

func (*Provider) Close

func (p *Provider) Close() error

Close stops the provider

func (*Provider) Provide

func (p *Provider) Provide(root cid.Cid) error

Provide the given cid using specified strategy.

func (*Provider) Run

func (p *Provider) Run()

Run workers to handle provide requests.

type Reprovider

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

Reprovider reannounces blocks to the network

Deprecated: use github.com/ipfs/boxo/provider/simple.Reprovider

func NewReprovider

func NewReprovider(ctx context.Context, reprovideInterval time.Duration, rsys routing.ContentRouting, keyProvider KeyChanFunc) *Reprovider

NewReprovider creates new Reprovider instance.

Deprecated: use github.com/ipfs/boxo/provider/simple.NewReprovider

func (*Reprovider) Close

func (rp *Reprovider) Close() error

Close the reprovider

func (*Reprovider) Reprovide

func (rp *Reprovider) Reprovide() error

Reprovide registers all keys given by rp.keyProvider to libp2p content routing

func (*Reprovider) Run

func (rp *Reprovider) Run()

Run re-provides keys with 'tick' interval or when triggered

func (*Reprovider) Trigger

func (rp *Reprovider) Trigger(ctx context.Context) error

Trigger starts the reprovision process in rp.Run and waits for it to finish.

Returns an error if a reprovide is already in progress.