endpoint

Documentation

Overview

Package endpoint provides the type Endpoint, to be used with the targets.Targets interface.

Index

• func NamesFromEndpoints(endpoints []Endpoint) []string
• type Endpoint
  • func EndpointsFromNames(names []string) []Endpoint
  • func (ep *Endpoint) Key() string
  • func (ep *Endpoint) Resolve(ipVersion int, resolver Resolver) (net.IP, error)
• type Lister
• type Resolver

Functions

func NamesFromEndpoints

func NamesFromEndpoints(endpoints []Endpoint) []string

NamesFromEndpoints is convenience function to build a list of names from endpoints.

Types

type Endpoint

type Endpoint struct {
	Name        string
	Labels      map[string]string
	LastUpdated time.Time
	Port        int
	IP          net.IP
}

Endpoint represents a targets and associated parameters.

func EndpointsFromNames

func EndpointsFromNames(names []string) []Endpoint

EndpointsFromNames is convenience function to build a list of endpoints from only names. It leaves the Port field in Endpoint unset and initializes Labels field to an empty map.

func (*Endpoint) Key

func (ep *Endpoint) Key() string

Key returns a string key that uniquely identifies that endpoint. Endpoint key consists of endpoint name, port and labels.

func (*Endpoint) Resolve

func (ep *Endpoint) Resolve(ipVersion int, resolver Resolver) (net.IP, error)

Key returns a string key that uniquely identifies that endpoint. Endpoint key consists of endpoint name, port and labels.

type Lister

type Lister interface {
	// ListEndpoints returns list of endpoints (name, port tupples).
	ListEndpoints() []Endpoint
}

Lister should implement the ListEndpoints method.

type Resolver

type Resolver interface {
	// Resolve, given a target and IP Version will return the IP address for that
	// target.
	Resolve(name string, ipVer int) (net.IP, error)
}