client

Documentation

Index

• Variables
• func New(baseURL string, opts ...Option) (*client, error)
• type HTTPError
  • func (e *HTTPError) Error() string
• type Option
  • func WithHTTPClient(h httpClient) Option
  • func WithIdentity(identity crypto.PrivKey) Option
  • func WithProviderInfo(peerID peer.ID, addrs []multiaddr.Multiaddr) Option
  • func WithStreamResultsRequired() Option
  • func WithUserAgent(ua string) Option
• type ResponseBodyLimitedTransport
  • func (r *ResponseBodyLimitedTransport) RoundTrip(req *http.Request) (*http.Response, error)

Variables

var (
	ViewLatency = &view.View{
		Measure:     measureLatency,
		Aggregation: distMS,
		TagKeys:     []tag.Key{keyOperation, keyHost, keyStatusCode, keyError},
	}
	ViewLength = &view.View{
		Measure:     measureLength,
		Aggregation: distLength,
		TagKeys:     []tag.Key{keyOperation, keyHost},
	}

	OpenCensusViews = []*view.View{
		ViewLatency,
		ViewLength,
	}
)

var ImportPath = importPath()

ImportPath is the canonical import path that allows us to identify official client builds vs modified forks, and use that info in User-Agent header.

Functions

func New

func New(baseURL string, opts ...Option) (*client, error)

New creates a content routing API client. The Provider and identity parameters are option. If they are nil, the client.ProvideBitswap method will not function.

Types

type HTTPError

type HTTPError struct {
	StatusCode int
	Body       string
}

func (*HTTPError) Error

func (e *HTTPError) Error() string

type Option

type Option func(*client)

func WithHTTPClient

func WithHTTPClient(h httpClient) Option

func WithIdentity

func WithIdentity(identity crypto.PrivKey) Option

func WithProviderInfo

func WithProviderInfo(peerID peer.ID, addrs []multiaddr.Multiaddr) Option

func WithStreamResultsRequired

func WithStreamResultsRequired() Option

func WithUserAgent

func WithUserAgent(ua string) Option

type ResponseBodyLimitedTransport

type ResponseBodyLimitedTransport struct {
	http.RoundTripper
	LimitBytes int64
	UserAgent  string
}

func (*ResponseBodyLimitedTransport) RoundTrip

func (r *ResponseBodyLimitedTransport) RoundTrip(req *http.Request) (*http.Response, error)