api

package

v1.0.0-rc2.11 Latest Latest Go to latest Published: Jun 17, 2021 License: BSD-3-Clause Imports: 59 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/mark2021blue/bee

Links

Open Source Insights

Documentation ¶

Overview ¶

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

Index ¶

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

Constants ¶

View Source

const (
	SwarmPinHeader            = "Swarm-Pin"
	SwarmTagHeader            = "Swarm-Tag"
	SwarmEncryptHeader        = "Swarm-Encrypt"
	SwarmIndexDocumentHeader  = "Swarm-Index-Document"
	SwarmErrorDocumentHeader  = "Swarm-Error-Document"
	SwarmFeedIndexHeader      = "Swarm-Feed-Index"
	SwarmFeedIndexNextHeader  = "Swarm-Feed-Index-Next"
	SwarmCollectionHeader     = "Swarm-Collection"
	SwarmPostageBatchIdHeader = "Swarm-Postage-Batch-Id"
)

View Source

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

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type FileInfo ¶

type FileInfo struct {
	Path        string
	Name        string
	ContentType string
	Size        int64
	Reader      io.Reader
}

type Options ¶

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

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.Traverser, pinning pinning.Interface, feedFactory feeds.Factory, post postage.Service, postageContract postagecontract.Interface, steward steward.Reuploader, signer crypto.Signer, logger logging.Logger, tracer *tracing.Tracer, o Options) Service

New will create a and initialize a new API service.

type UpgradedResponseWriter ¶

type UpgradedResponseWriter interface {
	http.ResponseWriter
	http.Pusher
	http.Hijacker
	http.Flusher
	// staticcheck SA1019 CloseNotifier interface is required by gorilla compress handler
	// nolint:staticcheck
	http.CloseNotifier // skipcq: SCC-SA1019
}

UpgradedResponseWriter adds more functionality on top of ResponseWriter

Source Files ¶

View all Source files

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