pingttl

README

go-ping-ttl

Utility library for sending ICMP pings to IPv4 or IPv6 destinations with TTL control.

---

Usage

1. Create an instance of the Pinger with pingttl.New()
2. Call .Ping() with a context and the address of the host you want to ping.

Your entire application should have a single instance of Pinger. Store it globally (🤢), or preferably, inject it as a dependency!

pinger := pingttl.New()

ip, err := net.ResolveIPAddr("ip4", "google.com")
if err != nil {
    return err
}

ctx, cancel := context.WithTimeout(context.Background(), time.Second * 5)
defer cancel()

// Providing 0 as a TTL will default to a sane value (64)
res, err := pinger.Ping(ctx, ip, 0)
if err != nil {
    return err
}

log.Printf("%s", res.Duration)

Documentation

Index

• type DestinationUnreachableErr
  • func (e DestinationUnreachableErr) Error() string
• type PingResult
• type Pinger
  • func New() *Pinger
  • func (p *Pinger) Ping(ctx context.Context, dst *net.IPAddr, ttl int) (*PingResult, error)
  • func (p *Pinger) Run(ctx context.Context) error
• type Proto
• type TimeExceededErr
  • func (e TimeExceededErr) Error() string

Types

type DestinationUnreachableErr

type DestinationUnreachableErr struct {
	Peer     net.Addr
	Duration time.Duration
}

func (DestinationUnreachableErr) Error

func (e DestinationUnreachableErr) Error() string

type PingResult

type PingResult struct {
	Duration time.Duration
}

type Pinger

type Pinger struct {

	// Logf is called by the library when it wants to log a warning or error.
	// By default, this produces no output.
	Logf func(string, ...interface{})
	// contains filtered or unexported fields
}

func New

func New() *Pinger

func (*Pinger) Ping

func (p *Pinger) Ping(ctx context.Context, dst *net.IPAddr, ttl int) (*PingResult, error)

func (*Pinger) Run

func (p *Pinger) Run(ctx context.Context) error

type Proto

type Proto int

var (
	ProtoICMPv4 Proto = 1
	ProtoICMPv6 Proto = 58
)

type TimeExceededErr

type TimeExceededErr struct {
	Peer     net.Addr
	Duration time.Duration
}

func (TimeExceededErr) Error

func (e TimeExceededErr) Error() string