client

Documentation

Overview

Package client provides utility functions for the mdns registry.

Index

• func Listen(entries chan<- *ServiceEntry, exit chan struct{}) error
• func Lookup(service string, entries chan<- *ServiceEntry) error
• func Query(params *QueryParam) error
• type QueryParam
  • func DefaultParams(service string) *QueryParam
• type ServiceEntry

Functions

func Listen

func Listen(entries chan<- *ServiceEntry, exit chan struct{}) error

Listen listens indefinitely for multicast updates.

func Lookup

func Lookup(service string, entries chan<- *ServiceEntry) error

Lookup is the same as Query, however it uses all the default parameters.

func Query

func Query(params *QueryParam) error

Query looks up a given service, in a domain, waiting at most for a timeout before finishing the query. The results are streamed to a channel. Sends will not block, so clients should make sure to either read or buffer.

Types

type QueryParam

type QueryParam struct {
	Service             string               // Service to lookup
	Domain              string               // Lookup domain, default "local"
	Type                uint16               // Lookup type, defaults to dns.TypePTR
	Context             context.Context      // Context
	Timeout             time.Duration        // Lookup timeout, default 1 second. Ignored if Context is provided
	Interface           *net.Interface       // Multicast interface to use
	Entries             chan<- *ServiceEntry // Entries Channel
	WantUnicastResponse bool                 // Unicast response desired, as per 5.4 in RFC
}

QueryParam is used to customize how a Lookup is performed.

func DefaultParams

func DefaultParams(service string) *QueryParam

DefaultParams is used to return a default set of QueryParam's.

type ServiceEntry

type ServiceEntry struct {
	Name       string
	Host       string
	AddrV4     net.IP
	AddrV6     net.IP
	Port       int
	Info       string
	InfoFields []string
	TTL        int
	Type       uint16
	// contains filtered or unexported fields
}

ServiceEntry is returned after we query for a service.