routemanager

Documentation

Index

• type DefaultManager
  • func NewManager(ctx context.Context, pubKey string, dnsRouteInterval time.Duration, ...) *DefaultManager
  • func (m *DefaultManager) EnableServerRouter(firewall firewall.Manager) error
  • func (m *DefaultManager) GetClientRoutes() map[route.HAUniqueID]*clientNetwork
  • func (m *DefaultManager) GetRouteSelector() *routeselector.RouteSelector
  • func (m *DefaultManager) Init(stateManager *statemanager.Manager) (nbnet.AddHookFunc, nbnet.RemoveHookFunc, error)
  • func (m *DefaultManager) InitialRouteRange() []string
  • func (m *DefaultManager) SetRouteChangeListener(listener listener.NetworkChangeListener)
  • func (m *DefaultManager) Stop(stateManager *statemanager.Manager)
  • func (m *DefaultManager) TriggerSelection(networks route.HAMap)
  • func (m *DefaultManager) UpdateRoutes(updateSerial uint64, newRoutes []*route.Route) (map[route.ID]*route.Route, route.HAMap, error)
• type Manager
• type MockManager
  • func (m *MockManager) EnableServerRouter(firewall firewall.Manager) error
  • func (m *MockManager) GetRouteSelector() *routeselector.RouteSelector
  • func (m *MockManager) Init(*statemanager.Manager) (net.AddHookFunc, net.RemoveHookFunc, error)
  • func (m *MockManager) InitialRouteRange() []string
  • func (m *MockManager) SetRouteChangeListener(listener listener.NetworkChangeListener)
  • func (m *MockManager) Start(ctx context.Context, iface *iface.WGIface)
  • func (m *MockManager) Stop(stateManager *statemanager.Manager)
  • func (m *MockManager) TriggerSelection(networks route.HAMap)
  • func (m *MockManager) UpdateRoutes(updateSerial uint64, newRoutes []*route.Route) (map[route.ID]*route.Route, route.HAMap, error)
• type RouteHandler

Types

type DefaultManager

type DefaultManager struct {
	// contains filtered or unexported fields
}

DefaultManager is the default instance of a route manager

func NewManager

func NewManager(
	ctx context.Context,
	pubKey string,
	dnsRouteInterval time.Duration,
	wgInterface iface.IWGIface,
	statusRecorder *peer.Status,
	relayMgr *relayClient.Manager,
	initialRoutes []*route.Route,
) *DefaultManager

func (*DefaultManager) EnableServerRouter

func (m *DefaultManager) EnableServerRouter(firewall firewall.Manager) error

func (*DefaultManager) GetClientRoutes

func (m *DefaultManager) GetClientRoutes() map[route.HAUniqueID]*clientNetwork

GetClientRoutes returns the client routes

func (*DefaultManager) GetRouteSelector

func (m *DefaultManager) GetRouteSelector() *routeselector.RouteSelector

GetRouteSelector returns the route selector

func (*DefaultManager) Init

func (m *DefaultManager) Init(stateManager *statemanager.Manager) (nbnet.AddHookFunc, nbnet.RemoveHookFunc, error)

Init sets up the routing

func (*DefaultManager) InitialRouteRange

func (m *DefaultManager) InitialRouteRange() []string

InitialRouteRange return the list of initial routes. It used by mobile systems

func (*DefaultManager) SetRouteChangeListener

func (m *DefaultManager) SetRouteChangeListener(listener listener.NetworkChangeListener)

SetRouteChangeListener set RouteListener for route change Notifier

func (*DefaultManager) Stop

func (m *DefaultManager) Stop(stateManager *statemanager.Manager)

Stop stops the manager watchers and clean firewall rules

func (*DefaultManager) TriggerSelection

func (m *DefaultManager) TriggerSelection(networks route.HAMap)

TriggerSelection triggers the selection of routes, stopping deselected watchers and starting newly selected ones

func (*DefaultManager) UpdateRoutes

func (m *DefaultManager) UpdateRoutes(updateSerial uint64, newRoutes []*route.Route) (map[route.ID]*route.Route, route.HAMap, error)

UpdateRoutes compares received routes with existing routes and removes, updates or adds them to the client and server maps

type Manager

type Manager interface {
	Init(*statemanager.Manager) (nbnet.AddHookFunc, nbnet.RemoveHookFunc, error)
	UpdateRoutes(updateSerial uint64, newRoutes []*route.Route) (map[route.ID]*route.Route, route.HAMap, error)
	TriggerSelection(route.HAMap)
	GetRouteSelector() *routeselector.RouteSelector
	SetRouteChangeListener(listener listener.NetworkChangeListener)
	InitialRouteRange() []string
	EnableServerRouter(firewall firewall.Manager) error
	Stop(stateManager *statemanager.Manager)
}

Manager is a route manager interface

type MockManager

type MockManager struct {
	UpdateRoutesFunc     func(updateSerial uint64, newRoutes []*route.Route) (map[route.ID]*route.Route, route.HAMap, error)
	TriggerSelectionFunc func(haMap route.HAMap)
	GetRouteSelectorFunc func() *routeselector.RouteSelector
	StopFunc             func(manager *statemanager.Manager)
}

MockManager is the mock instance of a route manager

func (*MockManager) EnableServerRouter

func (m *MockManager) EnableServerRouter(firewall firewall.Manager) error

func (*MockManager) GetRouteSelector

func (m *MockManager) GetRouteSelector() *routeselector.RouteSelector

GetRouteSelector mock implementation of GetRouteSelector from Manager interface

func (*MockManager) Init

func (m *MockManager) Init(*statemanager.Manager) (net.AddHookFunc, net.RemoveHookFunc, error)

func (*MockManager) InitialRouteRange

func (m *MockManager) InitialRouteRange() []string

InitialRouteRange mock implementation of InitialRouteRange from Manager interface

func (*MockManager) SetRouteChangeListener

func (m *MockManager) SetRouteChangeListener(listener listener.NetworkChangeListener)

SetRouteChangeListener mock implementation of SetRouteChangeListener from Manager interface

func (*MockManager) Start

func (m *MockManager) Start(ctx context.Context, iface *iface.WGIface)

Start mock implementation of Start from Manager interface

func (*MockManager) Stop

func (m *MockManager) Stop(stateManager *statemanager.Manager)

Stop mock implementation of Stop from Manager interface

func (*MockManager) TriggerSelection

func (m *MockManager) TriggerSelection(networks route.HAMap)

func (*MockManager) UpdateRoutes

func (m *MockManager) UpdateRoutes(updateSerial uint64, newRoutes []*route.Route) (map[route.ID]*route.Route, route.HAMap, error)

UpdateRoutes mock implementation of UpdateRoutes from Manager interface

type RouteHandler

type RouteHandler interface {
	String() string
	AddRoute(ctx context.Context) error
	RemoveRoute() error
	AddAllowedIPs(peerKey string) error
	RemoveAllowedIPs() error
}

RouteHandler defines the interface for handling routes