client

Documentation

Index

• type Client
  • func New(baseURL string, options ...Option) (*Client, error)
  • func (c *Client) Find(ctx context.Context, m multihash.Multihash) (*model.FindResponse, error)
  • func (c *Client) FindBatch(ctx context.Context, mhs []multihash.Multihash) (*model.FindResponse, error)
  • func (c *Client) GetProvider(ctx context.Context, providerID peer.ID) (*model.ProviderInfo, error)
  • func (c *Client) GetStats(ctx context.Context) (*model.Stats, error)
  • func (c *Client) ListProviders(ctx context.Context) ([]*model.ProviderInfo, error)
• type DHStoreAPI
• type DHashClient
  • func NewDHashClient(options ...Option) (*DHashClient, error)
  • func (c *DHashClient) Find(ctx context.Context, mh multihash.Multihash) (*model.FindResponse, error)
  • func (c *DHashClient) FindAsync(ctx context.Context, mh multihash.Multihash, ...) error
  • func (c *DHashClient) PCache() *pcache.ProviderCache
• type Interface
• type Option
  • func WithClient(c *http.Client) Option
  • func WithDHStoreAPI(dhsAPI DHStoreAPI) Option
  • func WithDHStoreURL(u string) Option
  • func WithPcachePreload(preload bool) Option
  • func WithPcacheTTL(ttl time.Duration) Option
  • func WithProvidersURL(urls ...string) Option

Types

type Client

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

Client is an http client for the indexer find API

func New

func New(baseURL string, options ...Option) (*Client, error)

New creates a new find HTTP client.

func (*Client) Find

func (c *Client) Find(ctx context.Context, m multihash.Multihash) (*model.FindResponse, error)

Find looks up content entries by multihash.

func (*Client) FindBatch

func (c *Client) FindBatch(ctx context.Context, mhs []multihash.Multihash) (*model.FindResponse, error)

FindBatch looks up content entries for a batch of multihashes

func (*Client) GetProvider

func (c *Client) GetProvider(ctx context.Context, providerID peer.ID) (*model.ProviderInfo, error)

func (*Client) GetStats

func (c *Client) GetStats(ctx context.Context) (*model.Stats, error)

func (*Client) ListProviders

func (c *Client) ListProviders(ctx context.Context) ([]*model.ProviderInfo, error)

type DHStoreAPI

type DHStoreAPI interface {
	// FindMultihash does a dh-multihash lookup and returns a
	// model.FindResponse with EncryptedMultihashResults. Returns no data and
	// no error, (nil, nil), if data not found.
	FindMultihash(context.Context, multihash.Multihash) ([]model.EncryptedMultihashResult, error)
	// FindMetadata takes a value-key-hash, does a metadata lookup, and returns
	// encrypted metadata. Returns no data and no error, (nil, nil), if
	// metadata not found
	FindMetadata(context.Context, []byte) ([]byte, error)
}

DHStoreAPI defines multihash and metadata find functions. The default implementation defines functions to do this over HTTP. A replacement implementation that implements the interface can optionally be provided when creating a DHashClient.

type DHashClient

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

DHashClient is a client that does double-hashed lookups on a dhstore. By default, it does multihash and metadata lookups over HTTP. If given a DHStoreAPI, it can do the lookups any the underlying implementation defined.

func NewDHashClient

func NewDHashClient(options ...Option) (*DHashClient, error)

NewDHashClient instantiates a new client that uses Reader Privacy API for querying data. It requires more roundtrips to fulfill one query however it also protects the user from a passive observer. dhstoreURL specifies the URL of the double hashed store that can respond to find encrypted multihash and find encrypted metadata requests.

func (*DHashClient) Find

func (c *DHashClient) Find(ctx context.Context, mh multihash.Multihash) (*model.FindResponse, error)

Find launches FindAsync in a separate go routine and assembles the result into FindResponse as if it was a synchronous invocation.

func (*DHashClient) FindAsync

func (c *DHashClient) FindAsync(ctx context.Context, mh multihash.Multihash, resChan chan<- model.ProviderResult) error

FindAsync implements double hashed lookup workflow. FindAsync returns results on resChan until there are no more results or error. When finished, resChan is closed and the error or nil is returned.

func (*DHashClient) PCache

func (c *DHashClient) PCache() *pcache.ProviderCache

type Interface

type Interface interface {
	// Find queries for provider content records for a single multihash.
	Find(context.Context, multihash.Multihash) (*model.FindResponse, error)
	// FindBatch queries for provider content records for a batch of multihashes.
	FindBatch(context.Context, []multihash.Multihash) (*model.FindResponse, error)

	// GetProvider gets information about the provider identified by peer.ID.
	GetProvider(context.Context, peer.ID) (*model.ProviderInfo, error)
	// ListPrividers gets information about all providers known to the indexer.
	ListProviders(ctx context.Context) ([]*model.ProviderInfo, error)

	// GetStats get statistics for indexer.
	GetStats(context.Context) (*model.Stats, error)
}

Interface is the interface implemented by all find clients.

type Option

type Option func(*config) error

Option is a function that sets a value in a config.

func WithClient

func WithClient(c *http.Client) Option

WithClient allows creation of the http client using an underlying network round tripper / client.

func WithDHStoreAPI

func WithDHStoreAPI(dhsAPI DHStoreAPI) Option

WithDHStoreAPI configures an interface to use for doing multihash and metadata lookups with dhstore. If this is not configured, then dhstore lookups are done using the dhstoreURL.

func WithDHStoreURL

func WithDHStoreURL(u string) Option

WithDHStoreURL specifies a URL for dhstore (/multihash and /metadata endpoints). If not specified then a WithDHStoreAPI should be used to provide access to dhstore data.

func WithPcachePreload

func WithPcachePreload(preload bool) Option

WithPcachePreload enables or disabled preloading the cache. Generally this should be enabled, even for short-lived clients needing to look up few providers.

Default is true (enabled).

func WithPcacheTTL

func WithPcacheTTL(ttl time.Duration) Option

WithPcacheTTL sets the time that provider information remains in the cache after it is not longer available from any of the original sources.

func WithProvidersURL

func WithProvidersURL(urls ...string) Option

WithProvidersURL specifies one or more URLs for retrieving provider information (/providers and /providers/<pid> endpoints). Multiple URLs may be given to specify multiple sources of provider information,