api

package

v0.0.0-...-34ee9b9 Latest Latest Go to latest Published: Jul 24, 2021 License: BSD-3-Clause Imports: 57 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/yanhuangpai/voyager

Documentation ¶

Overview ¶

Package api provides the functionality of the Voyager client-facing HTTP API.

Index ¶

Constants
type Options
type Service
- func New(tags *tags.Tags, storer storage.Storer, resolver resolver.Interface, ...) Service

Constants ¶

View Source

const (
	InfinityPinHeader           = "Infinity-Pin"
	InfinityTagHeader           = "Infinity-Tag"
	InfinityEncryptHeader       = "Infinity-Encrypt"
	InfinityIndexDocumentHeader = "Infinity-Index-Document"
	InfinityErrorDocumentHeader = "Infinity-Error-Document"
	InfinityFeedIndexHeader     = "Infinity-Feed-Index"
	InfinityFeedIndexNextHeader = "Infinity-Feed-Index-Next"
)

View Source

const (
	// TargetsRecoveryHeader defines the Header for Recovery targets in Global Pinning
	TargetsRecoveryHeader = "infinity-recovery-targets"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Options ¶

type Options struct {
	CORSAllowedOrigins []string
	GatewayMode        bool
	WsPingPeriod       time.Duration
}

type Service ¶

type Service interface {
	http.Handler
	m.Collector
	io.Closer
}

Service is the API service interface.

func New ¶

func New(tags *tags.Tags, storer storage.Storer, resolver resolver.Interface, pss pss.Interface, traversalService traversal.Service, feedFactory feeds.Factory, logger logging.Logger, tracer *tracing.Tracer, o Options) Service

New will create a and initialize a new API service.

Source Files ¶

View all Source files

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