ping

Documentation

Index

• type InfoProvider
  • func (p InfoProvider) HotstuffView() uint64
  • func (p InfoProvider) SealedBlockHeight() uint64
  • func (p InfoProvider) SoftwareVersion() string
• type Service
  • func NewPingService(h host.Host, pingProtocolID protocol.ID, logger zerolog.Logger, ...) *Service
  • func (ps *Service) Ping(ctx context.Context, peerID peer.ID) (message.PingResponse, time.Duration, error)

Types

type InfoProvider

type InfoProvider struct {
	SoftwareVersionFun   func() string
	SealedBlockHeightFun func() (uint64, error)
	HotstuffViewFun      func() (uint64, error)
}

func (InfoProvider) HotstuffView

func (p InfoProvider) HotstuffView() uint64

func (InfoProvider) SealedBlockHeight

func (p InfoProvider) SealedBlockHeight() uint64

func (InfoProvider) SoftwareVersion

func (p InfoProvider) SoftwareVersion() string

type Service

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

Service handles the outbound and inbound ping requests and response

func NewPingService

func NewPingService(
	h host.Host,
	pingProtocolID protocol.ID,
	logger zerolog.Logger,
	pingProvider fnetwork.PingInfoProvider,
) *Service

func (*Service) Ping

func (ps *Service) Ping(ctx context.Context, peerID peer.ID) (message.PingResponse, time.Duration, error)

Ping sends a Ping request to the remote node and returns the response, rtt and error if any.