mdns

Documentation

Index

• Constants
• Variables
• func NewDiscovery(c <-chan message, e chan<- event) (*discovery, error)
• func NewListener(domain, iface string, c chan<- message) (*listener, error)
• func NewService(zone string) *service
• func NewServiceDatabase() *servicedb
• func NewTokenizer(src string) *tokenizer
• func Quote(src string) string
• func ReadServiceDatabase(v string) (*servicedb, error)
• func Unquote(src string) (string, error)
• type Config
• type EventType
  • func (v EventType) FlagString() string
  • func (f EventType) String() string
• type Server
  • func New(cfg Config) (*Server, error)
  • func (this Server) Changed(v *service) bool
  • func (this Server) Delete(v *service)
  • func (this *Server) EnumerateInstances(ctx context.Context, services ...string) ([]Service, error)
  • func (this *Server) EnumerateServices(ctx context.Context) ([]string, error)
  • func (this Server) Exists(v *service) *service
  • func (this Server) Get(name string) *service
  • func (this Server) Instances() []*service
  • func (this Server) Lookup(service string) ServiceDescription
  • func (this *Server) LookupServiceDescription(v string) ServiceDescription
  • func (this Server) Query(ctx context.Context, msg *dns.Msg, iface int) error
  • func (this Server) Read(v string) error
  • func (this *Server) Run(ctx context.Context) error
  • func (this Server) Send(msg *dns.Msg, ifIndex int) error
  • func (this Server) Set(v *service)
  • func (this *Server) String() string
• type ServiceDescription
• type ServiceEvent

Constants

const (
	ServicesQuery = "_services._dns-sd._udp"
	DefaultTTL    = 60 * 5 // In seconds (5 mins)

)

const (
	DefaultServiceDatabase = "https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xml"
)

const (
	EOF rune = -(iota + 1)
)

Variables

var (
	MULTICAST_ADDR_IPV4 = &net.UDPAddr{IP: net.ParseIP("224.0.0.251"), Port: 5353}
	MULTICAST_ADDR_IPV6 = &net.UDPAddr{IP: net.ParseIP("ff02::fb"), Port: 5353}
)

var (
	ErrParseError = errors.New("Parse Error")
)

Functions

func NewDiscovery

func NewDiscovery(c <-chan message, e chan<- event) (*discovery, error)

func NewListener

func NewListener(domain, iface string, c chan<- message) (*listener, error)

func NewService

func NewService(zone string) *service

func NewServiceDatabase

func NewServiceDatabase() *servicedb

func NewTokenizer

func NewTokenizer(src string) *tokenizer

func Quote

func Quote(src string) string

func ReadServiceDatabase

func ReadServiceDatabase(v string) (*servicedb, error)

func Unquote

func Unquote(src string) (string, error)

Unquote returns a bare string without quoted characters. The following Coversions happen: \\ \n \f \t \r Happen as normal \xFF returns a byte from hex \123 returns a byte from decimal \0123 returns a bype from octal

Types

type Config

type Config struct {
	Interface       string   `yaml:"interface"`
	Domain          string   `yaml:"domain"`
	TTL             int      `yaml:"ttl"`
	ServiceDatabase []string `yaml:"services"`
}

type EventType

type EventType int

const (
	EVENT_TYPE_ADDED EventType = (1 << iota)
	EVENT_TYPE_REMOVED
	EVENT_TYPE_EXPIRED
	EVENT_TYPE_CHANGED
	EVENT_TYPE_SERVICE
	EVENT_TYPE_NONE EventType = 0
	EVENT_TYPE_MIN            = EVENT_TYPE_ADDED
	EVENT_TYPE_MAX            = EVENT_TYPE_SERVICE
)

func (EventType) FlagString

func (v EventType) FlagString() string

func (EventType) String

func (f EventType) String() string

type Server

type Server struct {
	C chan Event // Channel for emitting events
	// contains filtered or unexported fields
}

func New

func New(cfg Config) (*Server, error)

func (Server) Changed

func (this Server) Changed(v *service) bool

Check if service has changed, returns false if service does not yet exist

func (Server) Delete

func (this Server) Delete(v *service)

Delete a service

func (*Server) EnumerateInstances

func (this *Server) EnumerateInstances(ctx context.Context, services ...string) ([]Service, error)

func (*Server) EnumerateServices

func (this *Server) EnumerateServices(ctx context.Context) ([]string, error)

func (Server) Exists

func (this Server) Exists(v *service) *service

Check if service already exists

func (Server) Get

func (this Server) Get(name string) *service

Get returns a service by name, or nil if service not found

func (Server) Instances

func (this Server) Instances() []*service

Instances returns service instances

func (Server) Lookup

func (this Server) Lookup(service string) ServiceDescription

Lookup a record

func (*Server) LookupServiceDescription

func (this *Server) LookupServiceDescription(v string) ServiceDescription

Return a service description for the given service name

func (Server) Query

func (this Server) Query(ctx context.Context, msg *dns.Msg, iface int) error

Query by sending multiple messages to interfaces

func (Server) Read

func (this Server) Read(v string) error

Read records into database

func (*Server) Run

func (this *Server) Run(ctx context.Context) error

func (Server) Send

func (this Server) Send(msg *dns.Msg, ifIndex int) error

Send a single DNS message to a particular interface or all interfaces if 0

func (Server) Set

func (this Server) Set(v *service)

Set a service and update expiration

func (*Server) String

func (this *Server) String() string

type ServiceDescription

type ServiceDescription interface {
	Name() string
	Service() string
	Protocol() string
	Description() string
	Note() string
}

type ServiceEvent

type ServiceEvent interface {
	Event
	Type() EventType
	Service() Service
}