package
1.0.1-rc2
Repository: https://github.com/stack-labs/stack.git
Documentation: pkg.go.dev

# README

MDNS GoDoc

MDNS is a simple mdns client/server library by Hashicorp.

We maintain a fork with updates for PRs and issues they have not merged or addressed.

Overview

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.

Usage

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

package main

import (
	"github.com/micro/mdns"
	"os"
)

func main() {

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

package main

import (
	"fmt"
	"github.com/micro/mdns"
)

func main() {

	// Make a channel for results and start listening
	entriesCh := make(chan *mdns.ServiceEntry, 8)
	go func() {
		for entry := range entriesCh {
			fmt.Printf("Got new entry: %v\n", entry)
		}
	}()

	// Start the lookup
	err := mdns.Lookup("_foobar._tcp", entriesCh)
	if err != nil {
		fmt.Println(err)
	}

	close(entriesCh)
}

# Packages

No description provided by the author

# Functions

DefaultParams is used to return a default set of QueryParam's.
Listen listens indefinitely for multicast updates.
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.

# Structs

Config is used to configure the mDNS server.
DNSSDService is a service that complies with the DNS-SD (RFC 6762) and MDNS (RFC 6762) specs for local, multicast-DNS-based discovery.
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.