types

Documentation

Index

• Constants
• Variables
• func Identifier(event RetrievalEvent) string
• func QueryResponseFromReader(r io.Reader) (*retrievalmarket.QueryResponse, error)
• func QueryToWriter(q *retrievalmarket.Query, w io.Writer) error
• func RegisterRetrievalIDToContext(parentCtx context.Context, id RetrievalID) context.Context
• type CandidateFinder
• type CandidateRetrieval
• type CandidateRetrievalCall
• type CandidateRetriever
• type CandidateSplitter
• type CoordinationKind
• type EventCode
• type FIL
  • func (f FIL) String() string
  • func (f FIL) Unitless() string
• type FindCandidatesResult
• type Phase
• type RetrievalCandidate
  • func NewRetrievalCandidate(pid peer.ID, rootCid cid.Cid, protocols ...metadata.Protocol) RetrievalCandidate
• type RetrievalCoordinator
• type RetrievalEvent
• type RetrievalEventSubscriber
• type RetrievalID
  • func NewRetrievalID() (RetrievalID, error)
  • func RetrievalIDFromContext(ctx context.Context) (RetrievalID, error)
  • func (id RetrievalID) MarshalText() ([]byte, error)
  • func (id RetrievalID) String() string
  • func (id *RetrievalID) UnmarshalText(data []byte) error
• type RetrievalRequest
• type RetrievalResult
• type RetrievalSplitter
• type RetrievalStats
• type Retriever

Constants

const (
	RaceCoordination       = "race"
	SequentialCoordination = "sequential"
)

const BitswapIndentifier = "Bitswap"

const FilecoinPrecision = uint64(1_000_000_000_000_000_000)

Variables

var ErrIncorrectContextValue = errors.New("context key does not point to a valid retrieval id")

ErrIncorrectContextValue indicates a value for the retrieval id context key that wasn't a retrieval id

var ErrMissingContextKey = errors.New("context key for retrieval is missing")

ErrMissingContextKey indicates no retrieval context key was present for a given context

Functions

func Identifier

func Identifier(event RetrievalEvent) string

func QueryResponseFromReader

func QueryResponseFromReader(r io.Reader) (*retrievalmarket.QueryResponse, error)

QueryResponseFromReader reads a QueryResponse object in dag-cbor form from a stream

func QueryToWriter

func QueryToWriter(q *retrievalmarket.Query, w io.Writer) error

QueryToWriter writes a Query object in dag-cbor form to a stream

func RegisterRetrievalIDToContext

func RegisterRetrievalIDToContext(parentCtx context.Context, id RetrievalID) context.Context

Types

type CandidateFinder

type CandidateFinder interface {
	FindCandidates(ctx context.Context, request RetrievalRequest, events func(RetrievalEvent)) ([]RetrievalCandidate, error)
}

type CandidateRetrieval

type CandidateRetrieval interface {
	RetrieveFromCandidates([]RetrievalCandidate) (*RetrievalStats, error)
}

type CandidateRetrievalCall

type CandidateRetrievalCall struct {
	Candidates         []RetrievalCandidate
	CandidateRetrieval CandidateRetrieval
}

type CandidateRetriever

type CandidateRetriever interface {
	Retrieve(ctx context.Context, request RetrievalRequest, events func(RetrievalEvent)) CandidateRetrieval
}

type CandidateSplitter

type CandidateSplitter interface {
	SplitRetrieval(ctx context.Context, request RetrievalRequest, events func(RetrievalEvent)) RetrievalSplitter
}

type CoordinationKind

type CoordinationKind string

type EventCode

type EventCode string

const (
	CandidatesFoundCode    EventCode = "candidates-found"
	CandidatesFilteredCode EventCode = "candidates-filtered"
	StartedCode            EventCode = "started"
	ConnectedCode          EventCode = "connected"
	QueryAskedCode         EventCode = "query-asked"
	QueryAskedFilteredCode EventCode = "query-asked-filtered"
	ProposedCode           EventCode = "proposed"
	AcceptedCode           EventCode = "accepted"
	FirstByteCode          EventCode = "first-byte-received"
	FailedCode             EventCode = "failure"
	SuccessCode            EventCode = "success"
)

type FIL

type FIL gostatetypesbig.Int

func (FIL) String

func (f FIL) String() string

func (FIL) Unitless

func (f FIL) Unitless() string

type FindCandidatesResult

type FindCandidatesResult struct {
	Candidate RetrievalCandidate
	Err       error
}

type Phase

type Phase string

const (
	// IndexerPhase involves a candidates-found|failure
	IndexerPhase Phase = "indexer"
	// QueryPhase involves a connect, query-asked|failure
	QueryPhase Phase = "query"
	// RetrievalPhase involves the full data retrieval: connect, proposed, accepted, first-byte-received, success|failure
	RetrievalPhase Phase = "retrieval"
)

type RetrievalCandidate

type RetrievalCandidate struct {
	MinerPeer peer.AddrInfo
	RootCid   cid.Cid
	Metadata  metadata.Metadata
}

func NewRetrievalCandidate

func NewRetrievalCandidate(pid peer.ID, rootCid cid.Cid, protocols ...metadata.Protocol) RetrievalCandidate

type RetrievalCoordinator

type RetrievalCoordinator func(context.Context, []CandidateRetrievalCall) (*RetrievalStats, error)

type RetrievalEvent

type RetrievalEvent interface {
	// Time returns the time that the event occurred
	Time() time.Time
	// RetrievalId returns the unique ID for this retrieval
	RetrievalId() RetrievalID
	// Code returns the type of event this is
	Code() EventCode
	// Phase returns what phase of a retrieval this even occurred on
	Phase() Phase
	// PhaseStartTime returns the time that the phase started for this storage provider
	PhaseStartTime() time.Time
	// PayloadCid returns the CID being requested
	PayloadCid() cid.Cid
	// StorageProviderId returns the peer ID of the storage provider if this
	// retrieval was requested via peer ID
	StorageProviderId() peer.ID
	// Protocol
	Protocols() []multicodec.Code
}

type RetrievalEventSubscriber

type RetrievalEventSubscriber func(event RetrievalEvent)

RetrievalEventSubscriber is a function that receives a stream of retrieval events from all retrievals that are in progress. Various different types implement the RetrievalEvent interface and may contain additional information about the event beyond what is available on the RetrievalEvent interface.

type RetrievalID

type RetrievalID uuid.UUID

func NewRetrievalID

func NewRetrievalID() (RetrievalID, error)

func RetrievalIDFromContext

func RetrievalIDFromContext(ctx context.Context) (RetrievalID, error)

func (RetrievalID) MarshalText

func (id RetrievalID) MarshalText() ([]byte, error)

func (RetrievalID) String

func (id RetrievalID) String() string

func (*RetrievalID) UnmarshalText

func (id *RetrievalID) UnmarshalText(data []byte) error

type RetrievalRequest

type RetrievalRequest struct {
	RetrievalID RetrievalID
	Cid         cid.Cid
	LinkSystem  ipld.LinkSystem
}

RetrievalRequest is the top level parameters for a request -- this should be left unchanged as you move down a retriever tree

type RetrievalResult

type RetrievalResult struct {
	Stats *RetrievalStats
	Err   error
}

type RetrievalSplitter

type RetrievalSplitter interface {
	SplitCandidates([]RetrievalCandidate) ([][]RetrievalCandidate, error)
}

type RetrievalStats

type RetrievalStats struct {
	StorageProviderId peer.ID
	RootCid           cid.Cid
	Size              uint64
	Blocks            uint64
	Duration          time.Duration
	AverageSpeed      uint64
	TotalPayment      abi.TokenAmount
	NumPayments       int
	AskPrice          abi.TokenAmount
	TimeToFirstByte   time.Duration
}

type Retriever

type Retriever interface {
	Retrieve(ctx context.Context, request RetrievalRequest, events func(RetrievalEvent)) (*RetrievalStats, error)
}