router

Documentation

Overview

Package router provides a network routing control plane

Index

• Variables
• type Event
• type EventType
  • func (t EventType) String() string
• type LookupOption
  • func LookupAddress(a string) LookupOption
  • func LookupGateway(g string) LookupOption
  • func LookupLink(link string) LookupOption
  • func LookupNetwork(n string) LookupOption
  • func LookupRouter(r string) LookupOption
• type LookupOptions
  • func NewLookup(opts ...LookupOption) LookupOptions
• type Option
  • func Address(a string) Option
  • func Cache() Option
  • func Gateway(g string) Option
  • func Id(id string) Option
  • func Network(n string) Option
  • func Registry(r registry.Registry) Option
• type Options
  • func DefaultOptions() Options
• type ReadOption
  • func ReadService(s string) ReadOption
• type ReadOptions
• type Route
  • func Filter(routes []Route, opts LookupOptions) []Route
  • func (r *Route) Hash() uint64
• type Router
• type StatusCode
• type Table
• type WatchOption
  • func WatchService(s string) WatchOption
• type WatchOptions
• type Watcher

Variables

var (
	// DefaultLink is default network link
	DefaultLink = "local"
	// DefaultLocalMetric is default route cost for a local route
	DefaultMetric int64 = 1
	// DefaultNetwork is default micro network
	DefaultNetwork = "micro"
	// ErrRouteNotFound is returned when no route was found in the routing table
	ErrRouteNotFound = errors.New("route not found")
	// ErrDuplicateRoute is returned when the route already exists
	ErrDuplicateRoute = errors.New("duplicate route")
)

var (
	// ErrWatcherStopped is returned when routing table watcher has been stopped
	ErrWatcherStopped = errors.New("watcher stopped")
)

Types

type Event

type Event struct {
	// Unique id of the event
	Id string
	// Type defines type of event
	Type EventType
	// Timestamp is event timestamp
	Timestamp time.Time
	// Route is table route
	Route Route
}

Event is returned by a call to Next on the watcher.

type EventType

type EventType int

EventType defines routing table event

const (
	// Create is emitted when a new route has been created
	Create EventType = iota
	// Delete is emitted when an existing route has been deleted
	Delete
	// Update is emitted when an existing route has been updated
	Update
)

func (EventType) String

func (t EventType) String() string

String returns human readable event type

type LookupOption

type LookupOption func(*LookupOptions)

LookupOption sets routing table query options

func LookupAddress

func LookupAddress(a string) LookupOption

LookupAddress sets service to query

func LookupGateway

func LookupGateway(g string) LookupOption

LookupGateway sets gateway address to query

func LookupLink

func LookupLink(link string) LookupOption

LookupLink sets the link to query

func LookupNetwork

func LookupNetwork(n string) LookupOption

LookupNetwork sets network name to query

func LookupRouter

func LookupRouter(r string) LookupOption

LookupRouter sets router id to query

type LookupOptions

type LookupOptions struct {
	// Address of the service
	Address string
	// Gateway is route gateway
	Gateway string
	// Network is network address
	Network string
	// Router is router id
	Router string
	// Link to query
	Link string
}

LookupOptions are routing table query options TODO replace with Filter(Route) bool

func NewLookup

func NewLookup(opts ...LookupOption) LookupOptions

NewLookup creates new query and returns it

type Option

type Option func(*Options)

Option used by the router

func Address

func Address(a string) Option

Address sets router service address

func Cache

func Cache() Option

Cache the routes

func Gateway

func Gateway(g string) Option

Gateway sets network gateway

func Id

func Id(id string) Option

Id sets Router Id

func Network

func Network(n string) Option

Network sets router network

func Registry

func Registry(r registry.Registry) Option

Registry sets the local registry

type Options

type Options struct {
	// Id is router id
	Id string
	// Address is router address
	Address string
	// Gateway is network gateway
	Gateway string
	// Network is network address
	Network string
	// Registry is the local registry
	Registry registry.Registry
	// Context for additional options
	Context context.Context
	// Cache routes
	Cache bool
}

Options are router options

func DefaultOptions

func DefaultOptions() Options

DefaultOptions returns router default options

type ReadOption

type ReadOption func(o *ReadOptions)

func ReadService

func ReadService(s string) ReadOption

ReadService sets the service to read from the table

type ReadOptions

type ReadOptions struct {
	Service string
}

type Route

type Route struct {
	// Service is destination service name
	Service string
	// Address is service node address
	Address string
	// Gateway is route gateway
	Gateway string
	// Network is network address
	Network string
	// Router is router id
	Router string
	// Link is network link
	Link string
	// Metric is the route cost metric
	Metric int64
	// Metadata for the route
	Metadata map[string]string
}

Route is a network route

func Filter

func Filter(routes []Route, opts LookupOptions) []Route

filterRoutes finds all the routes for given network and router and returns them

func (*Route) Hash

func (r *Route) Hash() uint64

Hash returns route hash sum.

type Router

type Router interface {
	// Init initializes the router with options
	Init(...Option) error
	// Options returns the router options
	Options() Options
	// The routing table
	Table() Table
	// Lookup queries routes in the routing table
	Lookup(service string, opts ...LookupOption) ([]Route, error)
	// Watch returns a watcher which tracks updates to the routing table
	Watch(opts ...WatchOption) (Watcher, error)
	// Close the router
	Close() error
	// Returns the router implementation
	String() string
}

Router is an interface for a routing control plane

type StatusCode

type StatusCode int

StatusCode defines router status

const (
	// Running means the router is up and running
	Running StatusCode = iota
	// Stopped means the router has been stopped
	Stopped
	// Error means the router has encountered error
	Error
)

type Table

type Table interface {
	// Create new route in the routing table
	Create(Route) error
	// Delete existing route from the routing table
	Delete(Route) error
	// Update route in the routing table
	Update(Route) error
	// Read is for querying the table
	Read(...ReadOption) ([]Route, error)
}

Table is an interface for routing table

type WatchOption

type WatchOption func(*WatchOptions)

WatchOption is used to define what routes to watch in the table

func WatchService

func WatchService(s string) WatchOption

WatchService sets what service routes to watch Service is the microservice name

type WatchOptions

type WatchOptions struct {
	// Service allows to watch specific service routes
	Service string
}

WatchOptions are table watcher options TODO: expand the options to watch based on other criteria

type Watcher

type Watcher interface {
	// Next is a blocking call that returns watch result
	Next() (*Event, error)
	// Chan returns event channel
	Chan() (<-chan *Event, error)
	// Stop stops watcher
	Stop()
}

Watcher defines routing table watcher interface Watcher returns updates to the routing table