# Functions
Address sets router service address.
Client to call router service.
DefaultOptions returns router default options.
Gateway sets network gateway.
Id sets Router Id.
Network sets router network.
NewQuery creates new query and returns it.
NewRouter creates new Router and returns it.
QueryGateway sets route gateway.
QueryNetwork sets route network address.
QueryService sets destination address.
Registry sets the local registry.
WatchService sets what service routes to watch Service is the microservice name.
# Constants
AdvertiseEventsTick is time interval in which the router advertises route updates.
AdvertiseFlushTick is time the yet unconsumed advertisements are flush i.e.
AdvertiseTableTick is time interval in which router advertises all routes found in routing table.
Advertising means the router is advertising.
AdvertRecover is advert recovery threshold.
AdvertSuppress is advert suppression threshold.
Announce is advertised when the router announces itself.
Create is emitted when a new route has been created.
DefaultAdvertTTL is default advertisement TTL.
Delete is emitted when an existing route has been deleted.
DeletePenalty penalises route deletion.
Error means the router has encountered error.
MaxSuppressTime defines time after which the suppressed advert is deleted.
PenaltyHalfLife is the time the advert penalty decays to half its value.
RouteUpdate advertises route updates.
Running means the router is up and running.
Stopped means the router has been stopped.
Update is emitted when an existing route has been updated.
UpdatePenalty penalises route updates.
# Variables
DefaultAddress is default router address.
DefaultLink is default network link.
DefaultLocalMetric is default route cost metric for the local network.
DefaultName is default router service name.
DefaultNetwork is default micro network.
DefaultNetworkMetric is default route cost metric for the micro network.
DefaultRouter is default network router.
ErrDuplicateRoute is returned when the route already exists.
ErrRouteNotFound is returned when no route was found in the routing table.
ErrWatcherStopped is returned when routing table watcher has been stopped.
PenaltyDecay is a coefficient which controls the speed the advert penalty decays.
# Structs
Advert contains a list of events advertised by the router to the network.
Event is returned by a call to Next on the watcher.
Options are router options.
QueryOptions are routing table query options.
Route is network route.
Status is router status.
WatchOptions are table watcher options.
# Type aliases
AdvertType is route advertisement type.
EventType defines routing table event.
Option used by the router.
QueryOption sets routing table query options.
StatusCode defines router status.
WatchOption is used to define what routes to watch in the table.