https://github.com/hashicorp/mdns

Simple mDNS client/server library in Golang
https://github.com/hashicorp/mdns

Last synced: 3 days ago
JSON representation

Simple mDNS client/server library in Golang

• Host: GitHub
• URL: https://github.com/hashicorp/mdns
• Owner: hashicorp
• License: mit
• Created: 2014-01-29T19:39:18.000Z (almost 11 years ago)
• Default Branch: main
• Last Pushed: 2024-10-01T13:58:24.000Z (2 months ago)
• Last Synced: 2024-10-29T09:42:52.099Z (about 1 month ago)
• Language: Go
• Size: 78.1 KB
• Stars: 1,183
• Watchers: 270
• Forks: 209
• Open Issues: 39
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-go - mdns - Simple mDNS (Multicast DNS) client/server library in Golang. (Networking / Transliteration)
• zero-alloc-awesome-go - mdns - Simple mDNS (Multicast DNS) client/server library in Golang. (Networking / Transliteration)
• awesome-repositories - hashicorp/mdns - Simple mDNS client/server library in Golang (Go)
• awesome-go - mdns - Simple mDNS (Multicast DNS) client/server library in Golang. Stars:`1.2K`. (Networking / Transliteration)
• awesome-go - mdns - Simple mDNS client/server library in Golang - ★ 453 (Networking)
• awesome-go-extra - mdns - 01-29T19:39:18Z|2022-01-03T18:31:30Z| (Networking / Uncategorized)
• awesome-go-zh - mdns

README

        
# mdns

[![Build Status](https://github.com/hashicorp/mdns/workflows/ci/badge.svg)](https://github.com/hashicorp/mdns/actions)

Simple mDNS client/server library in Golang. mDNS or Multicast DNS can be

used to discover services on the local network without the use of an authoritative

DNS server. This enables peer-to-peer discovery. It is important to note that many

networks restrict the use of multicasting, which prevents mDNS from functioning.

Notably, multicast cannot be used in any sort of cloud, or shared infrastructure

environment. However it works well in most office, home, or private infrastructure

environments.

Using the library is very simple, here is an example of publishing a service entry:

```go

// Setup our service export

host, _ := os.Hostname()

info := []string{"My awesome service"}

service, _ := mdns.NewMDNSService(host, "_foobar._tcp", "", "", 8000, nil, info)

// Create the mDNS server, defer shutdown

server, _ := mdns.NewServer(&mdns.Config{Zone: service})

defer server.Shutdown()

```

Doing a lookup for service providers is also very simple:

```go

// Make a channel for results and start listening

entriesCh := make(chan *mdns.ServiceEntry, 4)

go func() {

    for entry := range entriesCh {

        fmt.Printf("Got new entry: %v\n", entry)

    }

}()

// Start the lookup

mdns.Lookup("_foobar._tcp", entriesCh)

close(entriesCh)

```