router

type Event struct {
	// Type defines type of event
	Type EventType
	// Route is table rout
	Route Route
}

type EventType int

type LookupPolicy int

type Option func(*Options)

type Options struct {
	// ID is router id
	ID string
	// Address is router address
	Address string
	// Advertise is the address advertised to the network
	Advertise string
	// Registry is the local registry
	Registry registry.Registry
	// Networkis the network registry
	Network registry.Registry
	// Table is routing table
	Table Table
}

type Query interface {
	// Options returns query options
	Options() QueryOptions
}

type QueryOption func(*QueryOptions)

type QueryOptions struct {
	// Destination is destination address
	Destination string
	// Network is network address
	Network string
	// Router is gateway address
	Router Router
	// Metric is route metric
	Metric int
	// Policy is query lookup policy
	Policy LookupPolicy
}

type Route struct {
	// Destination is destination address
	Destination string
	// Router is the network router
	Router Router
	// Network is micro network address
	Network string
	// Metric is the route cost metric
	Metric int
	// Policy defines route policy
	Policy RoutePolicy
}

type RoutePolicy int

type Router interface {
	// Init initializes the router with options
	Init(...Option) error
	// Options returns the router options
	Options() Options
	// ID returns the id of the router
	ID() string
	// Table returns the routing table
	Table() Table
	// Address returns the router adddress
	Address() string
	// Network returns the network address of the router
	Network() string
	// Advertise starts advertising the routes to the network
	Advertise() error
	// Stop stops the router
	Stop() error
	// String returns debug info
	String() string
}

type Table interface {
	// Init initializes the router with options
	Init(...TableOption) error
	// Options returns the router options
	Options() TableOptions
	// Add adds new route to the routing table
	Add(Route) error
	// Delete deletes existing route from the routing table
	Delete(Route) error
	// Update updates route in the routing table
	Update(Route) error
	// List returns the list of all routes in the table
	List() ([]Route, error)
	// Lookup looks up routes in the routing table and returns them
	Lookup(Query) ([]Route, error)
	// Watch returns a watcher which allows to track updates to the routing table
	Watch(opts ...WatchOption) (Watcher, error)
	// Size returns the size of the routing table
	Size() int
	// String prints the routing table
	String() string
}

type TableOption func(*TableOptions)

type TableOptions struct{}

type WatchOption func(*WatchOptions)

type WatchOptions struct {
	// Specify destination address to watch
	Destination string
	// Specify network to watch
	Network string
}

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()
}