pushsync

package

v2.0.1 Latest Latest Go to latest Published: Apr 23, 2024 License: BSD-3-Clause Imports: 24 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/ethersphere/bee

Links

Open Source Insights

Documentation ¶

Overview ¶

Package pushsync provides the pushsync protocol implementation.

Index ¶

Variables
type PushSync
- func New(address swarm.Address, nonce []byte, streamer p2p.StreamerDisconnecter, ...) *PushSync
type PushSyncer
type Receipt
type Storer

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNoPush            = errors.New("could not push chunk")
	ErrOutOfDepthStoring = errors.New("storing outside of the neighborhood")
	ErrWarmup            = errors.New("node warmup time not complete")
)

Functions ¶

This section is empty.

Types ¶

type PushSync ¶

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

func New ¶

func New(
	address swarm.Address,
	nonce []byte,
	streamer p2p.StreamerDisconnecter,
	store Storer,
	topology topology.Driver,
	fullNode bool,
	unwrap func(swarm.Chunk),
	validStamp postage.ValidStampFn,
	logger log.Logger,
	accounting accounting.Interface,
	pricer pricer.Interface,
	signer crypto.Signer,
	tracer *tracing.Tracer,
	warmupTime time.Duration,
) *PushSync

func (*PushSync) Close ¶

func (s *PushSync) Close() error

func (*PushSync) Metrics ¶

func (s *PushSync) Metrics() []prometheus.Collector

func (*PushSync) Protocol ¶

func (s *PushSync) Protocol() p2p.ProtocolSpec

func (*PushSync) PushChunkToClosest ¶

func (ps *PushSync) PushChunkToClosest(ctx context.Context, ch swarm.Chunk) (*Receipt, error)

PushChunkToClosest sends chunk to the closest peer by opening a stream. It then waits for a receipt from that peer and returns error or nil based on the receiving and the validity of the receipt.

type PushSyncer ¶

type PushSyncer interface {
	PushChunkToClosest(ctx context.Context, ch swarm.Chunk) (*Receipt, error)
}

type Receipt ¶

type Receipt struct {
	Address   swarm.Address
	Signature []byte
	Nonce     []byte
}

type Storer ¶

type Storer interface {
	storage.PushReporter
	ReservePutter() storage.Putter
	IsWithinStorageRadius(swarm.Address) bool
	StorageRadius() uint8
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mock
pb

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