maptracker

Documentation

Overview

Package maptracker implements a PinTracker component for IPFS Cluster. It uses a map to keep track of the state of tracked pins.

Index

• Constants
• type Config
  • func (cfg *Config) ConfigKey() string
  • func (cfg *Config) Default() error
  • func (cfg *Config) LoadJSON(raw []byte) error
  • func (cfg *Config) ToJSON() ([]byte, error)
  • func (cfg *Config) Validate() error
• type MapPinTracker
  • func NewMapPinTracker(cfg *Config, pid peer.ID, peerName string) *MapPinTracker
  • func (mpt *MapPinTracker) OpContext(c cid.Cid) context.Context
  • func (mpt *MapPinTracker) Recover(c cid.Cid) (api.PinInfo, error)
  • func (mpt *MapPinTracker) RecoverAll() ([]api.PinInfo, error)
  • func (mpt *MapPinTracker) SetClient(c *rpc.Client)
  • func (mpt *MapPinTracker) Shutdown() error
  • func (mpt *MapPinTracker) Status(c cid.Cid) api.PinInfo
  • func (mpt *MapPinTracker) StatusAll() []api.PinInfo
  • func (mpt *MapPinTracker) Sync(c cid.Cid) (api.PinInfo, error)
  • func (mpt *MapPinTracker) SyncAll() ([]api.PinInfo, error)
  • func (mpt *MapPinTracker) Track(c api.Pin) error
  • func (mpt *MapPinTracker) Untrack(c cid.Cid) error

Constants

const (
	DefaultMaxPinQueueSize = 50000
	DefaultConcurrentPins  = 10
)

Default values for this Config.

Types

type Config

type Config struct {
	config.Saver

	// If higher, they will automatically marked with an error.
	MaxPinQueueSize int
	// ConcurrentPins specifies how many pin requests can be sent to the ipfs
	// daemon in parallel. If the pinning method is "refs", it might increase
	// speed. Unpin requests are always processed one by one.
	ConcurrentPins int
}

Config allows to initialize a Monitor and customize some parameters.

func (*Config) ConfigKey

func (cfg *Config) ConfigKey() string

ConfigKey provides a human-friendly identifier for this type of Config.

func (*Config) Default

func (cfg *Config) Default() error

Default sets the fields of this Config to sensible values.

func (*Config) LoadJSON

func (cfg *Config) LoadJSON(raw []byte) error

LoadJSON sets the fields of this Config to the values defined by the JSON representation of it, as generated by ToJSON.

func (*Config) ToJSON

func (cfg *Config) ToJSON() ([]byte, error)

ToJSON generates a human-friendly JSON representation of this Config.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks that the fields of this Config have working values, at least in appearance.

type MapPinTracker

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

MapPinTracker is a PinTracker implementation which uses a Go map to store the status of the tracked Cids. This component is thread-safe.

func NewMapPinTracker

func NewMapPinTracker(cfg *Config, pid peer.ID, peerName string) *MapPinTracker

NewMapPinTracker returns a new object which has been correcly initialized with the given configuration.

func (*MapPinTracker) OpContext

func (mpt *MapPinTracker) OpContext(c cid.Cid) context.Context

OpContext exports the internal optracker's OpContext method. For testing purposes only.

func (*MapPinTracker) Recover

func (mpt *MapPinTracker) Recover(c cid.Cid) (api.PinInfo, error)

Recover will re-queue a Cid in error state for the failed operation, possibly retriggering an IPFS pinning operation.

func (*MapPinTracker) RecoverAll

func (mpt *MapPinTracker) RecoverAll() ([]api.PinInfo, error)

RecoverAll attempts to recover all items tracked by this peer.

func (*MapPinTracker) SetClient

func (mpt *MapPinTracker) SetClient(c *rpc.Client)

SetClient makes the MapPinTracker ready to perform RPC requests to other components.

func (*MapPinTracker) Shutdown

func (mpt *MapPinTracker) Shutdown() error

Shutdown finishes the services provided by the MapPinTracker and cancels any active context.

func (*MapPinTracker) Status

func (mpt *MapPinTracker) Status(c cid.Cid) api.PinInfo

Status returns information for a Cid tracked by this MapPinTracker.

func (*MapPinTracker) StatusAll

func (mpt *MapPinTracker) StatusAll() []api.PinInfo

StatusAll returns information for all Cids tracked by this MapPinTracker.

func (*MapPinTracker) Sync

func (mpt *MapPinTracker) Sync(c cid.Cid) (api.PinInfo, error)

Sync verifies that the status of a Cid matches that of the IPFS daemon. If not, it will be transitioned to PinError or UnpinError.

Sync returns the updated local status for the given Cid. Pins in error states can be recovered with Recover(). An error is returned if we are unable to contact the IPFS daemon.

func (*MapPinTracker) SyncAll

func (mpt *MapPinTracker) SyncAll() ([]api.PinInfo, error)

SyncAll verifies that the statuses of all tracked Cids match the one reported by the IPFS daemon. If not, they will be transitioned to PinError or UnpinError.

SyncAll returns the list of local status for all tracked Cids which were updated or have errors. Cids in error states can be recovered with Recover(). An error is returned if we are unable to contact the IPFS daemon.

func (*MapPinTracker) Track

func (mpt *MapPinTracker) Track(c api.Pin) error

Track tells the MapPinTracker to start managing a Cid, possibly triggering Pin operations on the IPFS daemon.

func (*MapPinTracker) Untrack

func (mpt *MapPinTracker) Untrack(c cid.Cid) error

Untrack tells the MapPinTracker to stop managing a Cid. If the Cid is pinned locally, it will be unpinned.