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
- Variables
- type Config
- type MapPinTracker
- func (mpt *MapPinTracker) OpContext(ctx context.Context, c cid.Cid) context.Context
- func (mpt *MapPinTracker) Recover(ctx context.Context, c cid.Cid) (*api.PinInfo, error)
- func (mpt *MapPinTracker) RecoverAll(ctx context.Context) ([]*api.PinInfo, error)
- func (mpt *MapPinTracker) SetClient(c *rpc.Client)
- func (mpt *MapPinTracker) Shutdown(ctx context.Context) error
- func (mpt *MapPinTracker) Status(ctx context.Context, c cid.Cid) *api.PinInfo
- func (mpt *MapPinTracker) StatusAll(ctx context.Context) []*api.PinInfo
- func (mpt *MapPinTracker) Sync(ctx context.Context, c cid.Cid) (*api.PinInfo, error)
- func (mpt *MapPinTracker) SyncAll(ctx context.Context) ([]*api.PinInfo, error)
- func (mpt *MapPinTracker) Track(ctx context.Context, c *api.Pin) error
- func (mpt *MapPinTracker) Untrack(ctx context.Context, c cid.Cid) error
Constants ¶
const ( DefaultMaxPinQueueSize = 1000000 DefaultConcurrentPins = 10 )
Default values for this Config.
Variables ¶
var ( // ErrFullQueue is the error used when pin or unpin operation channel is full. ErrFullQueue = errors.New("pin/unpin operation queue is full (too many operations), increasing max_pin_queue_size would help") )
Functions ¶
This section is empty.
Types ¶
type Config ¶ added in v0.3.1
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) ApplyEnvVars ¶ added in v0.10.0
ApplyEnvVars fills in any Config fields found as environment variables.
func (*Config) ConfigKey ¶ added in v0.3.1
ConfigKey provides a human-friendly identifier for this type of Config.
func (*Config) LoadJSON ¶ added in v0.3.1
LoadJSON sets the fields of this Config to the values defined by the JSON representation of it, as generated by ToJSON.
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 correctly initialized with the given configuration.
func (*MapPinTracker) OpContext ¶ added in v0.5.0
OpContext exports the internal optracker's OpContext method. For testing purposes only.
func (*MapPinTracker) Recover ¶
Recover will re-queue a Cid in error state for the failed operation, possibly retriggering an IPFS pinning operation.
func (*MapPinTracker) RecoverAll ¶ added in v0.3.1
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(ctx context.Context) error
Shutdown finishes the services provided by the MapPinTracker and cancels any active context.
func (*MapPinTracker) StatusAll ¶
func (mpt *MapPinTracker) StatusAll(ctx context.Context) []*api.PinInfo
StatusAll returns information for all Cids tracked by this MapPinTracker.
func (*MapPinTracker) Sync ¶
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 ¶
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.
Source Files