ping

Documentation

Index

• Constants
• func Ping(ctx context.Context, h host.Host, p peer.ID) <-chan Result
• type PingService
  • func NewPingService(h host.Host) *PingService
  • func (ps *PingService) Ping(ctx context.Context, p peer.ID) <-chan Result
  • func (p *PingService) PingHandler(s network.Stream)
• type Result

Constants

const (
	PingSize = 32

	ID = "/ipfs/ping/1.0.0"

	ServiceName = "libp2p.ping"
)

Functions

func Ping

func Ping(ctx context.Context, h host.Host, p peer.ID) <-chan Result

Ping pings the remote peer until the context is canceled, returning a stream of RTTs or errors.

Types

type PingService

type PingService struct {
	Host host.Host
}

func NewPingService

func NewPingService(h host.Host) *PingService

func (*PingService) Ping

func (ps *PingService) Ping(ctx context.Context, p peer.ID) <-chan Result

func (*PingService) PingHandler

func (p *PingService) PingHandler(s network.Stream)

type Result

type Result struct {
	RTT   time.Duration
	Error error
}

Result is a result of a ping attempt, either an RTT or an error.