87 lines
1.9 KiB
Go
87 lines
1.9 KiB
Go
// Package router provides a network routing control plane
|
|
package router
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/micro/go-micro/network/router/table"
|
|
)
|
|
|
|
const (
|
|
// Announce is advertised when the router announces itself
|
|
Announce AdvertType = iota
|
|
// Update advertises route updates
|
|
Update
|
|
)
|
|
|
|
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
|
|
)
|
|
|
|
// 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
|
|
// Table returns the routing table
|
|
table.Table
|
|
// Advertise advertises routes to the network
|
|
Advertise() (<-chan *Advert, error)
|
|
// Process processes incoming adverts
|
|
Process(*Advert) error
|
|
// Status returns router status
|
|
Status() Status
|
|
// Stop stops the router
|
|
Stop() error
|
|
// String returns debug info
|
|
String() string
|
|
}
|
|
|
|
// Option used by the router
|
|
type Option func(*Options)
|
|
|
|
// AdvertType is route advertisement type
|
|
type AdvertType int
|
|
|
|
// Advert contains a list of events advertised by the router to the network
|
|
type Advert struct {
|
|
// 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
|
|
// TODO: not used
|
|
TTL time.Time
|
|
// Events is a list of routing table events to advertise
|
|
Events []*table.Event
|
|
}
|
|
|
|
// StatusCode defines router status
|
|
type StatusCode int
|
|
|
|
// Status is router status
|
|
type Status struct {
|
|
// Error is router error
|
|
Error error
|
|
// Code defines router status
|
|
Code StatusCode
|
|
}
|
|
|
|
var (
|
|
// DefaultRouter is default network router
|
|
DefaultRouter = NewRouter()
|
|
)
|
|
|
|
// NewRouter creates new Router and returns it
|
|
func NewRouter(opts ...Option) Router {
|
|
return newRouter(opts...)
|
|
}
|