peerinfo

Documentation

Index

• func DoOnce(ctx context.Context, tcpNode host.Host, peerID peer.ID) (*pbv1.PeerInfo, time.Duration, bool, error)
• func Protocols() []protocol.ID
• type PeerInfo
  • func New(tcpNode host.Host, peers []peer.ID, version string, lockHash []byte, ...) *PeerInfo
  • func NewForT(_ *testing.T, tcpNode host.Host, peers []peer.ID, version string, ...) *PeerInfo
  • func (p *PeerInfo) Run(ctx context.Context)

Functions

func DoOnce

func DoOnce(ctx context.Context, tcpNode host.Host, peerID peer.ID) (*pbv1.PeerInfo, time.Duration, bool, error)

DoOnce returns the peer info and RTT and true of the given peer, or false if the peer doesn't support the protocol, or an error.

func Protocols

func Protocols() []protocol.ID

Protocols returns the supported protocols of this package in order of precedence.

Types

type PeerInfo

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

func New

func New(tcpNode host.Host, peers []peer.ID, version string, lockHash []byte, gitHash string,
	sendFunc p2p.SendReceiveFunc,
) *PeerInfo

New returns a new peer info protocol instance.

func NewForT

func NewForT(_ *testing.T, tcpNode host.Host, peers []peer.ID, version string, lockHash []byte, gitHash string,
	sendFunc p2p.SendReceiveFunc, registerHandler p2p.RegisterHandlerFunc,
	tickerProvider tickerProvider, nowFunc nowFunc, metricSubmitter metricSubmitter,
) *PeerInfo

NewForT returns a new peer info protocol instance for testing only.

func (*PeerInfo) Run

func (p *PeerInfo) Run(ctx context.Context)

Run runs the peer info protocol until the context is cancelled.