discovery

Documentation

Index

• Constants
• type Client
• type Name
• type Port
• type Record
  • func (r Record) Addrs(portname string) (addrs []string)
• type Task
• type Update

Constants

const (
	// Binary is the standard port that clients interact with on services.
	Binary = "binary"

	// Wildcard may be used in the User and Service fields of Name to recieve updates
	// from multiple services.
	Wildcard = "*"
)

Types

type Client

type Client interface {
	// Lookup looks up the Record for the given Name.
	Lookup(Name) (Record, error)

	// Watch monitors service records for changes.
	// Watch will send updates for all services which match the provided query.
	// Every service that exists that matches will send an update on the channel.
	// Cluster must be a valid cluster name.
	Watch(context.Context, Name) (<-chan Update, error)
}

var DefaultClient Client = &dnsClient{}

type Name

type Name struct {
	Cluster string
	User    string
	Service string
}

type Port

type Port struct {
	Name string
	Addr string
}

type Record

type Record struct {
	Name  Name
	Tasks []Task
}

func (Record) Addrs

func (r Record) Addrs(portname string) (addrs []string)

Addrs returns the addresses corresponding to the provided address name for each of the tasks in the service

type Task

type Task struct {
	Addrs []Port
}

type Update

type Update struct {
	IsDelete bool
	Record
}