pinger

package

v1.5.1 Latest Latest Go to latest Published: Apr 25, 2021 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const ID = "/qlc/ping/1.0.0"

View Source

const (
	PingSize = 32
)

View Source

var ErrPingSelf = errors.New("cannot ping self")

ErrPingSelf is returned if the pinger is instructed to ping itself.

func FromUint32(v uint32) []byte

FromUint32 decodes uint32.

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.

type PingService struct {
	Host host.Host
}

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 Pinger struct {
	*PingService
	// contains filtered or unexported fields
}

Pinger wraps a libp2p ping service. It exists to serve more helpful error messages in the case a node is pinging itself.

func NewPinger(h host.Host) *Pinger

NewPinger creates a filecoin pinger provided with a pingService and a PID.

func (p *Pinger) Ping(ctx context.Context, pid peer.ID) (<-chan Result, error)

Ping connects to other nodes on the network to test connections. The Pinger will error if the caller Pings the Pinger's self id.

type Result struct {
	RTT     time.Duration
	Version string
	Error   error
}

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