Documentation
¶
Overview ¶
Package router provides a network routing control plane
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // DefaultLink is default network link DefaultLink = "local" // DefaultLocalMetric is default route cost for a local route DefaultLocalMetric int64 = 1 )
var ( // DefaultRouter is the global default router DefaultRouter Router = NewRouter() // 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 = errors.New("watcher stopped")
ErrWatcherStopped is returned when routing table watcher has been stopped
Functions ¶
This section is empty.
Types ¶
type Event ¶
type Event struct {
// Timestamp is event timestamp
Timestamp time.Time
// Id of the event
Id string
// Route is table route
Route Route
// Type defines type of event
Type EventType
}
Event is returned by a call to Next on the watcher.
type Options ¶
type Options struct {
Logger logger.Logger
Context context.Context
Register register.Register
Name string
Gateway string
Network string
Id string
Address string
Precache bool
}
Options are router options
type QueryOption ¶
type QueryOption func(*QueryOptions)
QueryOption sets routing table query options
func QueryGateway ¶
func QueryGateway(g string) QueryOption
QueryGateway sets gateway address to query
type QueryOptions ¶
type QueryOptions struct {
// Service is destination service name
Service string
// 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
}
QueryOptions are routing table query options TODO replace with Filter(Route) bool
func NewQuery ¶
func NewQuery(opts ...QueryOption) QueryOptions
NewQuery creates new query and returns it
type Route ¶
type Route struct {
// Metadata for the route
Metadata metadata.Metadata
// Service is destination service name
Service 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
// Address is service node address
Address string
// Metric is the route cost metric
Metric int64
}
Route is network route
type Router ¶
type Router interface {
Name() string
// 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(...QueryOption) ([]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
// List all routes in the table
List() ([]Route, error)
// Query routes in the routing table
Query(...QueryOption) ([]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
Source Files