status

Documentation

Index

• type Reserve
• type Service
  • func NewService(logger log.Logger, streamer p2p.Streamer, topology topologyDriver, ...) *Service
  • func (s *Service) LocalSnapshot() (*Snapshot, error)
  • func (s *Service) PeerSnapshot(ctx context.Context, peer swarm.Address) (*Snapshot, error)
  • func (s *Service) Protocol() p2p.ProtocolSpec
  • func (s *Service) SetSync(sync SyncReporter)
• type Snapshot
• type SyncReporter

Types

type Reserve

type Reserve interface {
	ReserveSize() int
	ReserveSizeWithinRadius() uint64
	StorageRadius() uint8
}

Reserve defines the reserve storage related information required.

type Service

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

Service is the status service.

func NewService

func NewService(
	logger log.Logger,
	streamer p2p.Streamer,
	topology topologyDriver,
	beeMode string,
	commitment postage.CommitmentGetter,
	reserve Reserve,
) *Service

NewService creates a new status service.

func (*Service) LocalSnapshot

func (s *Service) LocalSnapshot() (*Snapshot, error)

LocalSnapshot returns the current status snapshot of this node.

func (*Service) PeerSnapshot

func (s *Service) PeerSnapshot(ctx context.Context, peer swarm.Address) (*Snapshot, error)

PeerSnapshot sends request for status snapshot to the peer.

func (*Service) Protocol

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

Protocol returns the protocol specification.

func (*Service) SetSync

func (s *Service) SetSync(sync SyncReporter)

type Snapshot

type Snapshot pb.Snapshot

Snapshot is the current snapshot of the system.

type SyncReporter

type SyncReporter interface {
	SyncRate() float64
}

SyncReporter defines the interface to report syncing rate.