client

Documentation

Index

• Constants
• type Config
• type RetrievalClient
  • func NewClient(ctx context.Context, datastore datastore.Batching, host host.Host, ...) (*RetrievalClient, error)
  • func NewClientWithConfig(ctx context.Context, cfg *Config) (*RetrievalClient, error)
  • func (rc *RetrievalClient) AwaitReady() error
  • func (rc *RetrievalClient) Connect(ctx context.Context, peerAddr peer.AddrInfo) error
  • func (rc *RetrievalClient) RetrieveFromPeer(ctx context.Context, linkSystem ipld.LinkSystem, peerID peer.ID, ...) (*types.RetrievalStats, error)

Constants

const RetrievalQueryProtocol = "/fil/retrieval/qry/1.0.0"

Types

type Config

type Config struct {
	ChannelMonitorConfig dtchannelmonitor.Config
	Datastore            datastore.Batching
	GraphsyncOpts        []graphsync.Option
	Host                 host.Host
	RetrievalConfigurer  datatransfer.TransportConfigurer
}

type RetrievalClient

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

func NewClient

func NewClient(ctx context.Context, datastore datastore.Batching, host host.Host, opts ...func(*Config)) (*RetrievalClient, error)

Creates a new RetrievalClient

func NewClientWithConfig

func NewClientWithConfig(ctx context.Context, cfg *Config) (*RetrievalClient, error)

Creates a new RetrievalClient with the given Config

func (*RetrievalClient) AwaitReady

func (rc *RetrievalClient) AwaitReady() error

func (*RetrievalClient) Connect

func (rc *RetrievalClient) Connect(ctx context.Context, peerAddr peer.AddrInfo) error

func (*RetrievalClient) RetrieveFromPeer

func (rc *RetrievalClient) RetrieveFromPeer(
	ctx context.Context,
	linkSystem ipld.LinkSystem,
	peerID peer.ID,
	proposal *retrievaltypes.DealProposal,
	sel ipld.Node,
	maxBlocks uint64,
	eventsCallback datatransfer.Subscriber,
	gracefulShutdownRequested <-chan struct{},
) (*types.RetrievalStats, error)