Developing lightweight computation at the DSG edge

README.md 2.17 KB
Newer Older
Cameron Sparr's avatar
Cameron Sparr committed
1
# go-ping
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
[![GoDoc](https://godoc.org/github.com/sparrc/go-ping?status.svg)](https://godoc.org/github.com/sparrc/go-ping)

ICMP Ping library for Go, inspired by
[go-fastping](https://github.com/tatsushid/go-fastping)

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

```go
 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:

```go
 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.

46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
For a full ping example, see
[cmd/ping/ping.go"](https://github.com/sparrc/go-ping/blob/master/cmd/ping/ping.go)

## Installation:

```
go get github.com/sparrc/go-ping
```

To install the native Go ping executable:

```bash
go get github.com/sparrc/go-ping/...
$GOPATH/bin/ping
```
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

## 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](https://sturmflut.github.io/linux/ubuntu/2015/01/17/unprivileged-icmp-sockets-on-linux/)
and [the Go icmp library](https://godoc.org/golang.org/x/net/icmp) for more details.