pinner

Documentation

Index

• Constants
• Variables
• func GetPin(param GetPinParam) (*types.IpfsPinStatusResponse, error)
• func PinCidAndRequestMakeDeal(param PinCidParam) (*types.IpfsPinStatusResponse, *operation.PinningOperation, error)
• type EstuaryPinManager
  • func NewEstuaryPinManager(pinfunc PinFunc, scf PinStatusFunc, opts *PinManagerOpts, ...) *EstuaryPinManager
  • func (pm *EstuaryPinManager) RunPinningRetryWorker(ctx context.Context, db *gorm.DB, cfg *config.Estuary)
• type GetPinParam
• type PinCidParam
• type PinFunc
• type PinManager
  • func NewShuttlePinManager(pinfunc PinFunc, scf PinStatusFunc, opts *PinManagerOpts) *PinManager
  • func (pm *PinManager) Add(op *operation.PinningOperation)
  • func (pm *PinManager) PinQueueSize() int
  • func (pm *PinManager) Run(workers int)
• type PinManagerOpts
• type PinStatusFunc
• type PinningHelperError
• type PinningOperationData
• type ShuttleManager

Constants

const (
	ColDir string = "dir"
)

Variables

var DefaultOpts = &PinManagerOpts{
	MaxActivePerUser: 15,
	QueueDataDir:     "/tmp/",
}

Functions

func GetPin

func GetPin(param GetPinParam) (*types.IpfsPinStatusResponse, error)

GetPinStatus returns the status of a pin operation

func PinCidAndRequestMakeDeal

func PinCidAndRequestMakeDeal(param PinCidParam) (*types.IpfsPinStatusResponse, *operation.PinningOperation, error)

PinCidAndQueue adds a cid to the pin queue, and pins it if possible

Types

type EstuaryPinManager

type EstuaryPinManager struct {
	*PinManager
	// contains filtered or unexported fields
}

func NewEstuaryPinManager

func NewEstuaryPinManager(pinfunc PinFunc, scf PinStatusFunc, opts *PinManagerOpts, cm *contentmgr.ContentManager, shuttleMgr shuttle.IManager) *EstuaryPinManager

func (*EstuaryPinManager) RunPinningRetryWorker

func (pm *EstuaryPinManager) RunPinningRetryWorker(ctx context.Context, db *gorm.DB, cfg *config.Estuary)

RunPinningRetryWorker re-attempt pinning contents that have not yet been pinned after a period of time

type GetPinParam

type GetPinParam struct {
	Ctx      echo.Context
	CM       *contentmgr.ContentManager
	Db       *gorm.DB
	User     *util.User
	CidToGet string
}

type PinCidParam

type PinCidParam struct {
	Ctx              echo.Context
	CM               *contentmgr.ContentManager
	Db               *gorm.DB
	User             *util.User
	CidToPin         types.IpfsPin
	Overwrite        bool
	IgnoreDuplicates bool
	MakeDeal         bool `default:"true"`
}

type PinFunc

type PinFunc func(context.Context, *operation.PinningOperation, progress.PinProgressCB) error

type PinManager

type PinManager struct {
	RunPinFunc       PinFunc
	StatusChangeFunc PinStatusFunc

	QueueDataDir string
	// contains filtered or unexported fields
}

func NewShuttlePinManager

func NewShuttlePinManager(pinfunc PinFunc, scf PinStatusFunc, opts *PinManagerOpts) *PinManager

func (*PinManager) Add

func (pm *PinManager) Add(op *operation.PinningOperation)

func (*PinManager) PinQueueSize

func (pm *PinManager) PinQueueSize() int

func (*PinManager) Run

func (pm *PinManager) Run(workers int)

type PinManagerOpts

type PinManagerOpts struct {
	MaxActivePerUser int
	QueueDataDir     string
}

type PinStatusFunc

type PinStatusFunc func(contID uint64, location string, status types.PinningStatus) error

type PinningHelperError

type PinningHelperError struct {
	Reason  string
	Details string
	// contains filtered or unexported fields
}

type PinningOperationData

type PinningOperationData struct {
	ContId uint64
}

type ShuttleManager

type ShuttleManager struct {
	*PinManager
}