mdns

Documentation

Overview

Package `mdns` implements a multicast DNS client and server to be used to discover and register services over local networks

Index

• Constants
• func NewWithPlugin(p Plugin) (*mdns, error)
• type EventType
  • func (t EventType) String() string
• type Message
  • func MessageFromPacket(packet []byte, sender net.Addr, iface net.Interface) (Message, error)
  • func MessageWithQuestion(question string, iface net.Interface) (Message, error)
• type Plugin
  • func WithLabel(label string) Plugin
  • func (p Plugin) Interfaces() ([]net.Interface, error)
  • func (p Plugin) Label() string
  • func (p Plugin) Name() string
  • func (p Plugin) New(_ context.Context, _ iface.Provider) (iface.Task, error)
• type Ptr
• type Srv

Constants

const (
	DefaultName  = "mdns"
	DefaultLabel = "local"
)

Functions

func NewWithPlugin

func NewWithPlugin(p Plugin) (*mdns, error)

Create a new logger task with provider of other tasks

Types

type EventType

type EventType uint

const (
	None EventType = iota
	Receive
)

func (EventType) String

func (t EventType) String() string

type Message

type Message interface {
	PTR() []Ptr             // Return PTR records
	A() []net.IP            // Return A records
	TXT() []string          // Return TXT records
	SRV() []Srv             // Return SRV records
	Bytes() ([]byte, error) // Return the packed message
	IsAnswer() bool         // Return true when the message is an answer
	IfIndex() int           // Interface to send and receive on, or nil
}

A sent or received message

func MessageFromPacket

func MessageFromPacket(packet []byte, sender net.Addr, iface net.Interface) (Message, error)

Create a message from a received packet, with a sender and the interface that the message was received on

func MessageWithQuestion

func MessageWithQuestion(question string, iface net.Interface) (Message, error)

Create a message from a question, to be sent on a specific interface or on all interfaces if the index is zero

type Plugin

type Plugin struct {
	task.Plugin
	Interface string `json:"interface,omitempty"`
}

func WithLabel

func WithLabel(label string) Plugin

func (Plugin) Interfaces

func (p Plugin) Interfaces() ([]net.Interface, error)

func (Plugin) Label

func (p Plugin) Label() string

func (Plugin) Name

func (p Plugin) Name() string

func (Plugin) New

func (p Plugin) New(_ context.Context, _ iface.Provider) (iface.Task, error)

Create a new logger task with provider of other tasks

type Ptr

type Ptr interface {
	Service() string    // Return service
	Name() string       // Return name
	TTL() time.Duration // Return time-to-live for record
}

type Srv

type Srv interface {
	Host() string     // Return host
	Port() uint16     // Return port
	Priority() uint16 // Return priority
}