provider

Documentation

Overview

Package provider contains abstractions for advertising DNS-SD services by manipulating DNS records.

Index

• Constants
• type Advertiser
• type Change
• type ChangeSet
  • func (cs ChangeSet) IsCreate() bool
  • func (cs ChangeSet) IsEmpty() bool
• type Provider

Constants

const Timeout = 10 * time.Second

Timeout is the timeout for all provider operations.

Types

type Advertiser

type Advertiser interface {
	// ID returns a data-structure that unique identifies this advertiser within
	// the provider that created it.
	ID() map[string]any

	// Advertise adds/updates DNS records to advertise the given service
	// instance.
	Advertise(ctx context.Context, inst dnssd.ServiceInstance) (ChangeSet, error)

	// Advertise removes/updates DNS records to stop advertising the given
	// service instance.
	Unadvertise(ctx context.Context, inst dnssd.ServiceInstance) (ChangeSet, error)
}

Advertiser is an interface for advertising DNS-SD service instances on a specific domain.

type Change

type Change int

Change is a bit-field that describes the changes made to a specific DNS record.

const (
	// NoChange indicates that no changes were made.
	NoChange Change = 0

	// Created indicates that a record of this type was created.
	Created Change = 1 << iota

	// Updated indicates that a record of this type was updated.
	Updated

	// Deleted indicates that a record of this type was deleted.
	Deleted
)

type ChangeSet

type ChangeSet struct {
	PTR Change
	SRV Change
	TXT Change
}

ChangeSet describes the changes made to DNS records.

func (ChangeSet) IsCreate

func (cs ChangeSet) IsCreate() bool

IsCreate returns true if the change set represents an entirely new instance.

func (ChangeSet) IsEmpty

func (cs ChangeSet) IsEmpty() bool

IsEmpty returns true if no changes were made.

type Provider

type Provider interface {
	// ID returns a unique identifier for the provider.
	ID() string

	// Describe returns a human-readable description of the provider.
	Describe() string

	// AdvertiserByID returns the Advertiser with the given identity structure.
	AdvertiserByID(ctx context.Context, id map[string]any) (Advertiser, error)

	// AdvertiserByDomain returns the Advertiser used to advertise services on
	// the given domain.
	//
	// ok is false if this provider does not manage the given domain.
	AdvertiserByDomain(ctx context.Context, domain string) (_ Advertiser, ok bool, _ error)
}

Provider is an interface for advertising DNS-SD service instances on domains hosted by a specific hosting provider.