https://github.com/tatsushid/go-fastping

ICMP ping library for Go inspired by AnyEvent::FastPing Perl module
https://github.com/tatsushid/go-fastping

Last synced: 13 days ago
JSON representation

ICMP ping library for Go inspired by AnyEvent::FastPing Perl module

• Host: GitHub
• URL: https://github.com/tatsushid/go-fastping
• Owner: tatsushid
• License: mit
• Created: 2013-09-05T14:52:42.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2021-06-24T00:50:26.000Z (over 3 years ago)
• Last Synced: 2024-07-03T12:08:41.664Z (4 months ago)
• Language: Go
• Homepage:
• Size: 76.2 KB
• Stars: 571
• Watchers: 20
• Forks: 122
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
go-fastping

===========

go-fastping is a Go language ICMP ping library, inspired by the `AnyEvent::FastPing`

Perl module, for quickly sending ICMP ECHO REQUEST packets. Original Perl module

is available at http://search.cpan.org/~mlehmann/AnyEvent-FastPing-2.01/

All original functions haven't been implemented yet.

[![GoDoc](https://godoc.org/github.com/tatsushid/go-fastping?status.svg)](https://godoc.org/github.com/tatsushid/go-fastping)

## Installation

Install and update with `go get -u github.com/tatsushid/go-fastping`

## Examples

Import this package and write

```go

p := fastping.NewPinger()

ra, err := net.ResolveIPAddr("ip4:icmp", os.Args[1])

if err != nil {

	fmt.Println(err)

	os.Exit(1)

}

p.AddIPAddr(ra)

p.OnRecv = func(addr *net.IPAddr, rtt time.Duration) {

	fmt.Printf("IP Addr: %s receive, RTT: %v\n", addr.String(), rtt)

}

p.OnIdle = func() {

	fmt.Println("finish")

}

err = p.Run()

if err != nil {

	fmt.Println(err)

}

```

The example sends an ICMP packet and waits for a response. If it receives a

response, it calls the "receive" callback. After that, once MaxRTT time has

passed, it calls the "idle" callback. For more details,

refer [to the godoc][godoc], and if you need more examples,

please see "cmd/ping/ping.go".

## Caution

This package implements ICMP ping using both raw socket and UDP. If your program

uses this package in raw socket mode, it needs to be run as a root user.

## License

go-fastping is under MIT License. See the [LICENSE][license] file for details.

[godoc]: http://godoc.org/github.com/tatsushid/go-fastping

[license]: https://github.com/tatsushid/go-fastping/blob/master/LICENSE