pushsync

Documentation

Overview

Package pushsync provides the pushsync protocol implementation.

Index

• Variables
• type PushSync
  • func New(address swarm.Address, networkID uint64, nonce []byte, ...) *PushSync
  • func (s *PushSync) Close() error
  • func (s *PushSync) Metrics() []prometheus.Collector
  • func (s *PushSync) Protocol() p2p.ProtocolSpec
  • func (ps *PushSync) PushChunkToClosest(ctx context.Context, ch swarm.Chunk) (*Receipt, error)
• type PushSyncer
• type Receipt
• type Storer

Variables

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

Types

type PushSync

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

func New

func New(
	address swarm.Address,
	networkID uint64,
	nonce []byte,
	streamer p2p.StreamerDisconnecter,
	store Storer,
	radius func() (uint8, error),
	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
}