micro/network/router/router.go

110 lines
2.6 KiB
Go
Raw Normal View History

2019-06-21 16:17:12 +01:00
// Package router provides a network routing control plane
package router
import (
"time"
)
var (
// DefaultRouter is default network router
DefaultRouter = NewRouter()
// DefaultName is default router service name
DefaultName = "go.micro.router"
)
2019-06-21 16:17:12 +01:00
// Router is an interface for a routing control plane
type Router interface {
// Init initializes the router with options
Init(...Option) error
// Options returns the router options
Options() Options
// Advertise advertises routes to the network
2019-07-04 02:06:59 +01:00
Advertise() (<-chan *Advert, error)
2019-07-10 07:45:27 +01:00
// Process processes incoming adverts
Process(*Advert) error
// Create new route in the routing table
Create(Route) error
2019-07-25 23:52:54 +01:00
// Delete existing route from the routing table
Delete(Route) error
2019-07-25 23:52:54 +01:00
// Update exiting route in the routing table
Update(Route) error
2019-07-25 23:52:54 +01:00
// List lists all routes in the routing table
List() ([]Route, error)
2019-07-25 23:52:54 +01:00
// Lookup queries routes in the routing table
Lookup(Query) ([]Route, error)
2019-07-25 23:52:54 +01:00
// Watch returns a watcher which tracks updates to the routing table
Watch(opts ...WatchOption) (Watcher, error)
// Status returns router status
Status() Status
// Stop stops the router
Stop() error
2019-07-10 07:56:52 +01:00
// Returns the router implementation
String() string
}
// Option used by the router
type Option func(*Options)
// StatusCode defines router status
type StatusCode int
const (
// Running means the router is up and running
Running StatusCode = iota
// Advertising means the router is advertising
Advertising
// Stopped means the router has been stopped
Stopped
// Error means the router has encountered error
Error
)
// Status is router status
type Status struct {
// Error is router error
Error error
// Code defines router status
Code StatusCode
}
// AdvertType is route advertisement type
type AdvertType int
const (
// Announce is advertised when the router announces itself
Announce AdvertType = iota
// RouteUpdate advertises route updates
RouteUpdate
)
// String returns human readable advertisement type
func (t AdvertType) String() string {
switch t {
case Announce:
return "announce"
case RouteUpdate:
return "update"
default:
return "unknown"
}
}
// Advert contains a list of events advertised by the router to the network
2019-07-04 02:06:59 +01:00
type Advert struct {
2019-07-10 07:45:27 +01:00
// Id is the router Id
Id string
// Type is type of advert
Type AdvertType
// Timestamp marks the time when the update is sent
Timestamp time.Time
// TTL is Advert TTL
2019-07-11 12:36:39 +01:00
TTL time.Duration
// Events is a list of routing table events to advertise
Events []*Event
}
// NewRouter creates new Router and returns it
func NewRouter(opts ...Option) Router {
return newRouter(opts...)
}