Categorygithub.com/hashicorp/mdns
modulepackage
1.0.6
Repository: https://github.com/hashicorp/mdns.git
Documentation: pkg.go.dev

# README

mdns

Build Status

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:

// 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:

// 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)

# Functions

DefaultParams is used to return a default set of QueryParam's.
Lookup is the same as Query, however it uses all the default parameters.
NewMDNSService returns a new instance of MDNSService.
NewServer is used to create a new mDNS server from a config.
Query looks up a given service, in a domain, waiting at most for a timeout before finishing the query.
QueryContext looks up a given service, in a domain, waiting at most for a timeout before finishing the query.

# Structs

Config is used to configure the mDNS server.
MDNSService is used to export a named service by implementing a Zone.
QueryParam is used to customize how a Lookup is performed.
mDNS server is used to listen for mDNS queries and respond if we have a matching local record.
ServiceEntry is returned after we query for a service.

# Interfaces

Zone is the interface used to integrate with the server and to serve records dynamically.