status

Documentation

Index

• type Service
  • func NewService(logger log.Logger, streamer p2p.Streamer, topologyIter topology.PeerIterator, ...) *Service
  • func (s *Service) ConnectedPeersSnapshot(ctx context.Context) ([]*Snapshot, error)
  • func (s *Service) LocalSnapshot() *Snapshot
  • func (s *Service) Protocol() p2p.ProtocolSpec
• 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) ConnectedPeersSnapshot

func (s *Service) ConnectedPeersSnapshot(ctx context.Context) ([]*Snapshot, error)

ConnectedPeersSnapshot returns the current status snapshot of this node connected peers.

func (*Service) LocalSnapshot

func (s *Service) LocalSnapshot() *Snapshot

LocalSnapshot returns the current status snapshot of this node.

func (*Service) Protocol

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

Protocol returns the protocol specification.

type Snapshot

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

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

Snapshot is the current snapshot of the system.