status

Documentation

Index

• type Service
  • func NewService(logger log.Logger, streamer p2p.Streamer, topologyIter topology.PeerIterator, ...) *Service
  • func (s *Service) Protocol() p2p.ProtocolSpec
  • func (s *Service) Snapshots(ctx context.Context, connectedPeers bool) ([]*Snapshot, error)
• type Snapshot

Types

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,
	topologyIter topology.PeerIterator,
	reserve depthmonitor.ReserveReporter,
	sync depthmonitor.SyncReporter,
	radius postage.RadiusReporter,
) *Service

NewService creates a new status service.

func (*Service) Protocol

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

Protocol returns the protocol specification.

func (*Service) Snapshots

func (s *Service) Snapshots(ctx context.Context, connectedPeers bool) ([]*Snapshot, error)

Snapshots returns the current status snapshot of this node or connected peers.

type Snapshot

type Snapshot struct {
	Peer          swarm.Address
	Proximity     uint8
	ReserveSize   uint64
	PullsyncRate  float64
	StorageRadius uint8

	RequestFailed bool // Indicates whether there was an error while requesting the snapshot.
}

Snapshot is the current snapshot of the system.