ICMP Ping library for Go
Go to file
2016-02-01 15:21:12 -07:00
cmd/ping First commit of go-ping library 2016-02-01 15:21:12 -07:00
LICENSE Initial commit 2016-02-01 15:06:45 -07:00
ping First commit of go-ping library 2016-02-01 15:21:12 -07:00
ping.go First commit of go-ping library 2016-02-01 15:21:12 -07:00
README.md First commit of go-ping library 2016-02-01 15:21:12 -07:00

go-ping

GoDoc

ICMP Ping library for Go, inspired by go-fastping

Here is a very simple example that sends & receives 3 packets:

 pinger, err := ping.NewPinger("www.google.com")
 if err != nil {
     panic(err)
 }
 pinger.Count = 3
 pinger.Run() // blocks until finished
 stats := pinger.Statistics() // get send/receive/rtt stats

Here is an example that emulates the unix ping command:

 pinger, err := ping.NewPinger("www.google.com")
 if err != nil {
     fmt.Printf("ERROR: %s\n", err.Error())
     return
 }
 pinger.OnRecv = func(pkt *ping.Packet) {
     fmt.Printf("%d bytes from %s: icmp_seq=%d time=%v\n",
         pkt.Nbytes, pkt.IPAddr, pkt.Seq, pkt.Rtt)
 }
 pinger.OnFinish = func(stats *ping.Statistics) {
     fmt.Printf("\n--- %s ping statistics ---\n", stats.Addr)
     fmt.Printf("%d packets transmitted, %d packets received, %v%% packet loss\n",
         stats.PacketsSent, stats.PacketsRecv, stats.PacketLoss)
     fmt.Printf("round-trip min/avg/max/stddev = %v/%v/%v/%v\n",
         stats.MinRtt, stats.AvgRtt, stats.MaxRtt, stats.StdDevRtt)
 }
 fmt.Printf("PING %s (%s):\n", pinger.Addr(), pinger.IPAddr())
 pinger.Run()

It sends ICMP packet(s) and waits for a response. If it receives a response, it calls the "receive" callback. When it's finished, it calls the "finish" callback.

For a full ping example, see "cmd/ping/ping.go".

Note on Linux Support:

This library attempts to send an "unprivileged" ping via UDP. On linux, this must be enabled by setting

sysctl net.ipv4.ping_group_range=0

If you do not wish to do this, you can set pinger.SetPrivileged(true) and run as super-user.

See this blog and the Go icmp library for more details.