gateway

package

Go to main page

Versions in this module

v0

v0.24.3

Dec 2, 2024

Changes in this version

+ const DefaultGetBlockTimeout

+ var ErrFetcherUnexpectedEOF = fmt.Errorf("failed to fetch IPLD data")

+ func InlineDNSLink(fqdn string) (dnsLabel string, err error)

+ func NewCacheBlockStore(size int, reg prometheus.Registerer) (blockstore.Blockstore, error)

+ func NewRemoteBlockstore(gatewayURL []string, httpClient *http.Client) (blockstore.Blockstore, error)

+ func NewRemoteValueStore(gatewayURL []string, httpClient *http.Client) (routing.ValueStore, error)

+ func UninlineDNSLink(dnsLabel string) (fqdn string)

+ type BackendOption func(options *backendOptions) error

+ func WithGetBlockTimeout(dur time.Duration) BackendOption

+ func WithPrometheusRegistry(reg prometheus.Registerer) BackendOption

+ func WithResolver(r resolver.Resolver) BackendOption

type BlocksBackend

+ func NewRemoteBlocksBackend(gatewayURL []string, httpClient *http.Client, opts ...BackendOption) (*BlocksBackend, error)

+ func (bb *BlocksBackend) WrapContextForRequest(ctx context.Context) context.Context

+ type CarBackend struct

+ func NewCarBackend(f CarFetcher, opts ...BackendOption) (*CarBackend, error)

+ func NewRemoteCarBackend(gatewayURL []string, httpClient *http.Client, opts ...BackendOption) (*CarBackend, error)

+ func (api *CarBackend) Get(ctx context.Context, path path.ImmutablePath, byteRanges ...ByteRange) (ContentPathMetadata, *GetResponse, error)

+ func (api *CarBackend) GetAll(ctx context.Context, path path.ImmutablePath) (ContentPathMetadata, files.Node, error)

+ func (api *CarBackend) GetBlock(ctx context.Context, p path.ImmutablePath) (ContentPathMetadata, files.File, error)

+ func (api *CarBackend) GetCAR(ctx context.Context, p path.ImmutablePath, params CarParams) (ContentPathMetadata, io.ReadCloser, error)

+ func (api *CarBackend) Head(ctx context.Context, p path.ImmutablePath) (ContentPathMetadata, *HeadResponse, error)

+ func (api *CarBackend) IsCached(ctx context.Context, path path.Path) bool

+ func (api *CarBackend) ResolvePath(ctx context.Context, p path.ImmutablePath) (ContentPathMetadata, error)

+ func (bb *CarBackend) GetDNSLinkRecord(ctx context.Context, hostname string) (path.Path, error)

+ func (bb *CarBackend) GetIPNSRecord(ctx context.Context, c cid.Cid) ([]byte, error)

+ func (bb *CarBackend) ResolveMutable(ctx context.Context, p path.Path) (path.ImmutablePath, time.Duration, time.Time, error)

+ type CarBackendMetrics struct

+ type CarFetcher interface

+ Fetch func(ctx context.Context, path path.ImmutablePath, params CarParams, ...) error

+ func NewRemoteCarFetcher(gatewayURL []string, httpClient *http.Client) (CarFetcher, error)

+ func NewRetryCarFetcher(inner CarFetcher, allowedRetries int) (CarFetcher, error)

type CarParams

+ Duplicates DuplicateBlocksPolicy

+ Order DagOrder

+ type CarResource struct

+ Params CarParams

+ Path path.ImmutablePath

type Config

+ DisableHTMLErrors bool

type ContentPathMetadata

+ LastSegmentRemainder []string

+ ModTime time.Time

+ type DagOrder string

+ const DagOrderDFS

+ const DagOrderUnknown

+ const DagOrderUnspecified

+ type DataCallback func(p path.ImmutablePath, reader io.Reader) error

+ type DuplicateBlocksPolicy uint8

+ const DuplicateBlocksExcluded

+ const DuplicateBlocksIncluded

+ const DuplicateBlocksUnspecified

+ func NewDuplicateBlocksPolicy(dupsValue string) (DuplicateBlocksPolicy, error)

+ func (d DuplicateBlocksPolicy) Bool() bool

+ func (d DuplicateBlocksPolicy) String() string

+ type ErrInvalidResponse struct

+ Message string

+ func (e ErrInvalidResponse) Error() string

+ type ErrPartialResponse struct

+ StillNeed []CarResource

+ func (epr ErrPartialResponse) Error() string

type GetResponse

+ func NewGetResponseFromReader(file io.ReadCloser, fullFileSize int64) *GetResponse

+ func NewGetResponseFromSymlink(symlink *files.Symlink, size int64) *GetResponse

+ func (r *GetResponse) Close() error

+ type HeadResponse struct

+ func NewHeadResponseForDirectory(dagSize int64) *HeadResponse

+ func NewHeadResponseForFile(startingBytes io.ReadCloser, size int64) *HeadResponse

+ func NewHeadResponseForSymlink(symlinkSize int64) *HeadResponse

+ func (r *HeadResponse) Close() error

+ type Headers struct

+ func NewHeaders(headers map[string][]string) *Headers

+ func (h *Headers) ApplyCors() *Headers

+ func (h *Headers) Wrap(next http.Handler) http.Handler

type RequestContextKey

+ const OriginalPathKey

+ type WithContextHint interface

+ WrapContextForRequest func(context.Context) context.Context

v0.10.7

Jul 17, 2023

v0.10.6

Jul 17, 2023

v0.10.5

Jul 15, 2023

v0.10.4

Jul 15, 2023

Changes in this version

+ var ErrBadGateway = NewErrorStatusCodeFromStatus(http.StatusBadGateway)

+ var ErrGatewayTimeout = NewErrorStatusCodeFromStatus(http.StatusGatewayTimeout)

+ var ErrInternalServerError = NewErrorStatusCodeFromStatus(http.StatusInternalServerError)

+ var ErrServiceUnavailable = NewErrorStatusCodeFromStatus(http.StatusServiceUnavailable)

+ var ErrTooManyRequests = NewErrorStatusCodeFromStatus(http.StatusTooManyRequests)

+ func AddAccessControlHeaders(headers map[string][]string)

+ func NewDNSResolver(resolvers map[string]string, dohOpts ...doh.Option) (*madns.Resolver, error)

+ func NewHandler(c Config, backend IPFSBackend) http.Handler

+ func NewHostnameHandler(c Config, backend IPFSBackend, next http.Handler) http.HandlerFunc

+ type BlocksBackend struct

+ func NewBlocksBackend(blockService blockservice.BlockService, opts ...BlocksBackendOption) (*BlocksBackend, error)

+ func (bb *BlocksBackend) Get(ctx context.Context, path ImmutablePath, ranges ...ByteRange) (ContentPathMetadata, *GetResponse, error)

+ func (bb *BlocksBackend) GetAll(ctx context.Context, path ImmutablePath) (ContentPathMetadata, files.Node, error)

+ func (bb *BlocksBackend) GetBlock(ctx context.Context, path ImmutablePath) (ContentPathMetadata, files.File, error)

+ func (bb *BlocksBackend) GetCAR(ctx context.Context, p ImmutablePath, params CarParams) (ContentPathMetadata, io.ReadCloser, error)

+ func (bb *BlocksBackend) GetDNSLinkRecord(ctx context.Context, hostname string) (ifacepath.Path, error)

+ func (bb *BlocksBackend) GetIPNSRecord(ctx context.Context, c cid.Cid) ([]byte, error)

+ func (bb *BlocksBackend) Head(ctx context.Context, path ImmutablePath) (ContentPathMetadata, files.Node, error)

+ func (bb *BlocksBackend) IsCached(ctx context.Context, p ifacepath.Path) bool

+ func (bb *BlocksBackend) ResolveMutable(ctx context.Context, p ifacepath.Path) (ImmutablePath, error)

+ func (bb *BlocksBackend) ResolvePath(ctx context.Context, path ImmutablePath) (ContentPathMetadata, error)

+ type BlocksBackendOption func(options *blocksBackendOptions) error

+ func WithNameSystem(ns namesys.NameSystem) BlocksBackendOption

+ func WithValueStore(vs routing.ValueStore) BlocksBackendOption

+ type ByteRange struct

+ From uint64

+ To *int64

+ type CarParams struct

+ Range *DagByteRange

+ Scope DagScope

+ type Config struct

+ DeserializedResponses bool

+ Headers map[string][]string

+ Menu []assets.MenuItem

+ NoDNSLink bool

+ PublicGateways map[string]*PublicGateway

+ type ContentPathMetadata struct

+ ContentType string

+ LastSegment path.Resolved

+ PathSegmentRoots []cid.Cid

+ type DagByteRange struct

+ From int64

+ To *int64

+ func NewDagByteRange(rangeStr string) (DagByteRange, error)

+ type DagScope string

+ const DagScopeAll

+ const DagScopeBlock

+ const DagScopeEntity

+ type ErrorRetryAfter struct

+ Err error

+ RetryAfter time.Duration

+ func NewErrorRetryAfter(err error, retryAfter time.Duration) *ErrorRetryAfter

+ func (e *ErrorRetryAfter) Error() string

+ func (e *ErrorRetryAfter) Is(err error) bool

+ func (e *ErrorRetryAfter) RetryAfterHeader() string

+ func (e *ErrorRetryAfter) Unwrap() error

+ type ErrorStatusCode struct

+ Err error

+ StatusCode int

+ func NewErrorStatusCode(err error, statusCode int) *ErrorStatusCode

+ func NewErrorStatusCodeFromStatus(statusCode int) *ErrorStatusCode

+ func (e *ErrorStatusCode) Error() string

+ func (e *ErrorStatusCode) Is(err error) bool

+ func (e *ErrorStatusCode) Unwrap() error

+ type GetResponse struct

+ func NewGetResponseFromDirectoryListing(dagSize uint64, entries <-chan unixfs.LinkResult) *GetResponse

+ func NewGetResponseFromFile(file files.File) *GetResponse

+ type IPFSBackend interface

+ Get func(context.Context, ImmutablePath, ...ByteRange) (ContentPathMetadata, *GetResponse, error)

+ GetAll func(context.Context, ImmutablePath) (ContentPathMetadata, files.Node, error)

+ GetBlock func(context.Context, ImmutablePath) (ContentPathMetadata, files.File, error)

+ GetCAR func(context.Context, ImmutablePath, CarParams) (ContentPathMetadata, io.ReadCloser, error)

+ GetDNSLinkRecord func(context.Context, string) (path.Path, error)

+ GetIPNSRecord func(context.Context, cid.Cid) ([]byte, error)

+ Head func(context.Context, ImmutablePath) (ContentPathMetadata, files.Node, error)

+ IsCached func(context.Context, path.Path) bool

+ ResolveMutable func(context.Context, path.Path) (ImmutablePath, error)

+ ResolvePath func(context.Context, ImmutablePath) (ContentPathMetadata, error)

+ type ImmutablePath struct

+ func NewImmutablePath(p path.Path) (ImmutablePath, error)

+ func (i ImmutablePath) IsValid() error

+ func (i ImmutablePath) Mutable() bool

+ func (i ImmutablePath) Namespace() string

+ func (i ImmutablePath) String() string

+ type PublicGateway struct

+ DeserializedResponses bool

+ InlineDNSLink bool

+ NoDNSLink bool

+ Paths []string

+ UseSubdomains bool

+ type RequestContextKey string

+ const ContentPathKey

+ const DNSLinkHostnameKey

+ const GatewayHostnameKey

+ const SubdomainHostnameKey

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL