Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schollz/peerdiscovery
Pure-Go library for cross-platform local peer discovery using UDP multicast :woman: :repeat: :woman:
https://github.com/schollz/peerdiscovery
discovery-service lan-broadcasting networking peer-to-peer udp-broadcast
Last synced: about 2 months ago
JSON representation
Pure-Go library for cross-platform local peer discovery using UDP multicast :woman: :repeat: :woman:
- Host: GitHub
- URL: https://github.com/schollz/peerdiscovery
- Owner: schollz
- License: mit
- Created: 2018-04-22T23:59:37.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-07-29T19:21:15.000Z (about 2 months ago)
- Last Synced: 2024-07-30T01:18:17.876Z (about 2 months ago)
- Topics: discovery-service, lan-broadcasting, networking, peer-to-peer, udp-broadcast
- Language: Go
- Homepage:
- Size: 104 KB
- Stars: 632
- Watchers: 21
- Forks: 54
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-go - peerdiscovery - Pure Go library for cross-platform local peer discovery using UDP multicast. (Networking / Transliteration)
- zero-alloc-awesome-go - peerdiscovery - Pure Go library for cross-platform local peer discovery using UDP multicast. (Networking / Transliteration)
- awesome-go - peerdiscovery - Pure-Go library for cross-platform local peer discovery using UDP multicast - ★ 300 (Networking)
- awesome-go-extra - peerdiscovery - Go library for cross-platform local peer discovery using UDP multicast :woman: :repeat: :woman:|556|46|8|2018-04-22T23:59:37Z|2022-07-07T17:33:26Z| (Networking / Uncategorized)
- awesome-go-zh - peerdiscovery
README
# peerdiscovery
Pure-go library for cross-platform thread-safe local peer discovery using UDP multicast. I needed to use peer discovery for [croc](https://github.com/schollz/croc) and everything I tried had problems, so I made another one.
## Install
Make sure you have Go 1.5+.
```
go get -u github.com/schollz/peerdiscovery
```
## Usage
The following is a code to find the first peer on the local network and print it out.
```golang
discoveries, _ := peerdiscovery.Discover(peerdiscovery.Settings{Limit: 1})
for _, d := range discoveries {
fmt.Printf("discovered '%s'\n", d.Address)
}
```
Here's the output when running on two computers. (*Run these gifs in sync by hitting Ctl + F5*).
**Computer 1:**
**Computer 2:**
For more examples, see the scanning examples ([ipv4](https://github.com/schollz/peerdiscovery/blob/master/examples/ipv4/main.go) and [ipv6](https://github.com/schollz/peerdiscovery/blob/master/examples/ipv6/main.go)) or [the docs](https://pkg.go.dev/github.com/schollz/peerdiscovery).
## Testing
To test the peer discovery with just one host, one can launch multiple containers. The provided `Dockerfile` will run the example code.
Please make sure to enable [Docker's IPv6 support](https://docs.docker.com/v17.09/engine/userguide/networking/default_network/ipv6/) if you are using IPv6 for peer discovery.
```console
# Build the container, named peertest
$ docker build -t peertest .
# Execute the following command in multiple terminals
$ docker run -t --rm peertest
Scanning for 10 seconds to find LAN peers
100% |████████████████████████████████████████| [9s:0s]Found 1 other computers
0) '172.17.0.2' with payload 'zqrecHipCO'
```
## Contributing
Pull requests are welcome. Feel free to...
- Revise documentation
- Add new features
- Fix bugs
- Suggest improvements
## Thanks
Thanks [@geistesk](https://github.com/geistesk) for adding IPv6 support and a `Notify` func, and helping maintain! Thanks [@Kunde21](https://github.com/Kunde21) for providing a bug fix and massively refactoring the code in a much better way. Thanks [@robpre](https://github.com/robpre) for finding and fixing bugs. Thanks [@shvydky](https://github.com/shvydky) for adding dynamic payloads.
## License
MIT