VintageNet.Route.Calculator (vintage_net v0.9.3) View Source
This module computes the desired routing table contents
It's used by the RouteManager to update the Linux routing tables when interfaces come online or change state. See the RouteManager docs for a discussion of how routes are configured.
The functions in this module have no side effects so that it's easier to test that routing scenarios result in correct Linux routing table configurations.
Link to this section Summary
Functions
Compute a Linux routing table configuration
Initialize state carried between calculations
Return the table indices used for routing based on source IP.
Link to this section Types
Specs
default_route() :: {:default_route, VintageNet.ifname(), :inet.ip_address(), metric(), table_index()}
Specs
entries() :: [entry()]
Specs
entry() :: rule() | default_route() | local_route()
Specs
interface_infos() :: %{ required(VintageNet.ifname()) => VintageNet.Route.InterfaceInfo.t() }
Specs
local_route() :: {:local_route, VintageNet.ifname(), :inet.ip_address(), metric(), table_index()}
Specs
metric() :: 0..32767
Specs
rule() :: {:rule, table_index(), :inet.ip_address()}
Specs
table_index() :: 0..255 | :main | :local | :default
Specs
table_indices() :: %{required(VintageNet.ifname()) => table_index()}
Link to this section Functions
Specs
compute(table_indices(), interface_infos(), [ VintageNet.Interface.Classification.prioritization() ]) :: {table_indices(), entries()}
Compute a Linux routing table configuration
The entries are ordered so that List.myers_difference/2 can be used to minimize the routing table changes.
Specs
init() :: table_indices()
Initialize state carried between calculations
Return the table indices used for routing based on source IP.