peers

Documentation

Index

• type PeerStats
  • func (p *PeerStats) MarshalLogObject(enc zapcore.ObjectEncoder) error
• type Peers
  • func New() *Peers
  • func (p *Peers) Add(id peer.ID, protocols func() []protocol.ID) bool
  • func (p *Peers) Contains(id peer.ID) bool
  • func (p *Peers) Delete(id peer.ID)
  • func (p *Peers) OnFailure(id peer.ID, size int, latency time.Duration)
  • func (p *Peers) OnLatency(id peer.ID, size int, latency time.Duration)
  • func (p *Peers) SelectBest(n int) []peer.ID
  • func (p *Peers) SelectBestFrom(peers []peer.ID) peer.ID
  • func (p *Peers) SelectBestWithProtocols(n int, protocols []protocol.ID) []peer.ID
  • func (p *Peers) Stats() Stats
  • func (p *Peers) Total() int
• type Stats
  • func (s *Stats) MarshalLogObject(enc zapcore.ObjectEncoder) error

Types

type PeerStats

type PeerStats struct {
	ID       peer.ID
	Success  int
	Failures int
	Latency  time.Duration
}

func (*PeerStats) MarshalLogObject

func (p *PeerStats) MarshalLogObject(enc zapcore.ObjectEncoder) error

type Peers

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

func New

func New() *Peers

func (*Peers) Add

func (p *Peers) Add(id peer.ID, protocols func() []protocol.ID) bool

func (*Peers) Contains

func (p *Peers) Contains(id peer.ID) bool

func (*Peers) Delete

func (p *Peers) Delete(id peer.ID)

func (*Peers) OnFailure

func (p *Peers) OnFailure(id peer.ID, size int, latency time.Duration)

func (*Peers) OnLatency

func (p *Peers) OnLatency(id peer.ID, size int, latency time.Duration)

OnLatency updates average peer and global latency.

func (*Peers) SelectBest

func (p *Peers) SelectBest(n int) []peer.ID

SelectBest selects at most n peers sorted by responsiveness and latency.

SelectBest parametrized by N because sync protocol relies on receiving data from redundant connections to guarantee that it will get complete data set. If it doesn't get complete data set it will have to fallback into hash resolution, which is generally more expensive.

func (*Peers) SelectBestFrom

func (p *Peers) SelectBestFrom(peers []peer.ID) peer.ID

SelectBest peer with preferences.

func (*Peers) SelectBestWithProtocols

func (p *Peers) SelectBestWithProtocols(n int, protocols []protocol.ID) []peer.ID

SelectBestWithProtocols is similar to SelectBest but filters peers by supported protocols. If protocols is empty, it returns the best peers regardless of the protocol. If protocols is not empty, it returns the best peers that support at least one of the protocols.

func (*Peers) Stats

func (p *Peers) Stats() Stats

func (*Peers) Total

func (p *Peers) Total() int

type Stats

type Stats struct {
	Total                int
	GlobalAverageLatency time.Duration
	BestPeers            []PeerStats
}

func (*Stats) MarshalLogObject

func (s *Stats) MarshalLogObject(enc zapcore.ObjectEncoder) error