pinner

Documentation

Index

• Constants
• Variables
• type EstuaryPinManager
  • func (pm *EstuaryPinManager) GetPin(param GetPinParam) (*IpfsPinStatusResponse, error)
  • func (pm *EstuaryPinManager) PinCid(eCtx echo.Context, param PinCidParam) (*IpfsPinStatusResponse, error)
  • func (m *EstuaryPinManager) PinContent(ctx context.Context, user uint, obj cid.Cid, filename string, ...) (*IpfsPinStatusResponse, error)
  • func (m *EstuaryPinManager) PinDelegatesForContent(cont util.Content) []string
  • func (m *EstuaryPinManager) PinStatus(cont util.Content, origins []*peer.AddrInfo) (*IpfsPinStatusResponse, error)
• type GetPinParam
• type IEstuaryPinManager
  • func NewEstuaryPinManager(ctx context.Context, opts *PinManagerOpts, cm content.IManager, ...) IEstuaryPinManager
• type IPinManager
• type IpfsListPinStatusResponse
• type IpfsPin
• type IpfsPinStatusResponse
• 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 PinningOperationData
• type ShuttleManager

Constants

const (
	ColDir string = "dir"
)

Variables

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

Types

type EstuaryPinManager

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

func (*EstuaryPinManager) GetPin

func (pm *EstuaryPinManager) GetPin(param GetPinParam) (*IpfsPinStatusResponse, error)

GetPinStatus returns the status of a pin operation

func (*EstuaryPinManager) PinCid

func (pm *EstuaryPinManager) PinCid(eCtx echo.Context, param PinCidParam) (*IpfsPinStatusResponse, error)

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

func (*EstuaryPinManager) PinContent

func (m *EstuaryPinManager) PinContent(ctx context.Context, user uint, obj cid.Cid, filename string, cols []*collections.CollectionRef, origins []*peer.AddrInfo, replaceID uint, meta map[string]interface{}, replication int, makeDeal bool) (*IpfsPinStatusResponse, error)

func (*EstuaryPinManager) PinDelegatesForContent

func (m *EstuaryPinManager) PinDelegatesForContent(cont util.Content) []string

func (*EstuaryPinManager) PinStatus

func (m *EstuaryPinManager) PinStatus(cont util.Content, origins []*peer.AddrInfo) (*IpfsPinStatusResponse, error)

type GetPinParam

type GetPinParam struct {
	User     *util.User
	CidToGet string
}

type IEstuaryPinManager

type IEstuaryPinManager interface {
	IPinManager
	PinContent(ctx context.Context, user uint, obj cid.Cid, filename string, cols []*collections.CollectionRef, origins []*peer.AddrInfo, replaceID uint, meta map[string]interface{}, replication int, makeDeal bool) (*IpfsPinStatusResponse, error)
	PinCid(eCtx echo.Context, param PinCidParam) (*IpfsPinStatusResponse, error)
	PinDelegatesForContent(cont util.Content) []string
	PinStatus(cont util.Content, origins []*peer.AddrInfo) (*IpfsPinStatusResponse, error)
	GetPin(param GetPinParam) (*IpfsPinStatusResponse, error)
}

func NewEstuaryPinManager

func NewEstuaryPinManager(
	ctx context.Context,
	opts *PinManagerOpts,
	cm content.IManager,
	cfg *config.Estuary,
	shuttleMgr shuttle.IManager,
	db *gorm.DB,
	nd *node.Node,
	log *zap.SugaredLogger,
) IEstuaryPinManager

type IPinManager

type IPinManager interface {
	PinQueueSize() int
	Run(workers int)
}

type IpfsListPinStatusResponse

type IpfsListPinStatusResponse struct {
	Count   int                      `json:"count"`
	Results []*IpfsPinStatusResponse `json:"results"`
}

type IpfsPin

type IpfsPin struct {
	CID     string                 `json:"cid"`
	Name    string                 `json:"name"`
	Origins []string               `json:"origins"`
	Meta    map[string]interface{} `json:"meta"`
}

type IpfsPinStatusResponse

type IpfsPinStatusResponse struct {
	RequestID string                 `json:"requestid"`
	Status    status.PinningStatus   `json:"status"`
	Created   time.Time              `json:"created"`
	Delegates []string               `json:"delegates"`
	Info      map[string]interface{} `json:"info"`
	Pin       IpfsPin                `json:"pin"`
	Content   util.Content           `json:"content"`
}

type PinCidParam

type PinCidParam struct {
	User             *util.User
	CidToPin         IpfsPin
	Overwrite        bool
	IgnoreDuplicates bool
	Replication      int
	MakeDeal         bool `default:"true"`
}

type PinFunc

type PinFunc func(context.Context, *operation.PinningOperation) 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, log *zap.SugaredLogger) *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 status.PinningStatus) error

type PinningOperationData

type PinningOperationData struct {
	ContId uint64
}

type ShuttleManager

type ShuttleManager struct {
	*PinManager
}