prf::net::cfg namespace

Namespaces

namespace validators

Classes

struct DefaultRoutePolicy
Parsed default-route policy from routing config.
struct EthConfigSectionDefinition
Typed schema definition for Ethernet-style IPv4 sections such as et1.
struct PppConfigSectionDefinition
Typed schema definition for PPP sections such as ppp1.
struct RoutingConfigSectionDefinition
Typed schema definition for routing section such as routing1.
struct UsbConfigSectionDefinition
Typed schema definition for USB Ethernet-style IPv4 sections such as us0.

Enums

enum class Ipv4ConfigMode: uint8_t { Disabled = 0u, Static, Dhcp, FromPool }
Supported IPv4 configuration modes for host-side interfaces such as Ethernet.

Typedefs

using EthConfigSection = prf::config::TypedConfigSection<EthConfigSectionDefinition>
Typed Ethernet config facade.
using PppConfigSection = prf::config::TypedConfigSection<PppConfigSectionDefinition>
Typed PPP config facade.
using RoutingConfigSection = prf::config::TypedConfigSection<RoutingConfigSectionDefinition>
Typed routing config facade.
using UsbConfigSection = prf::config::TypedConfigSection<UsbConfigSectionDefinition>
Typed USB config facade.

Functions

auto default_default_interface() -> std::string
Default routing policy for current single-radio profile.
auto default_eth_parp_match() -> std::string
auto default_eth_parp_mode() -> std::string
auto default_ipv4_mode() -> std::string
Default IPv4 mode for future host-side interfaces.
auto default_parp_match() -> std::string
auto default_parp_mode() -> std::string
auto default_usb_ipv4_mode() -> std::string
auto effective_default_route_policy(const RoutingConfigSection& section) -> DefaultRoutePolicy
Parses stored routing selector into runtime policy.
auto effective_ipv4_mode(const EthConfigSection& section) -> Ipv4ConfigMode
Converts stored mode string to compact enum used by runtime code.
auto effective_ipv4_mode(const UsbConfigSection& section) -> Ipv4ConfigMode
Converts stored USB mode string to compact enum used by runtime code.
auto effective_ppp_address_mode(const PppConfigSection& section) -> Ipv4ConfigMode
auto make_eth_section_schema(const std::string& section_name) -> prf::config::SectionSchema
auto make_ppp_section_schema(const std::string& section_name) -> prf::config::SectionSchema
auto make_routing_section_schema(const std::string& section_name) -> prf::config::SectionSchema
auto make_usb_section_schema(const std::string& section_name) -> prf::config::SectionSchema
auto parse_mac_address(const std::string& text, std::array<uint8_t, 6>*const out_mac) -> bool
Parses textual MAC address (aa:bb:cc:dd:ee:ff) into 6 bytes.

Enum documentation

enum class prf::net::cfg::Ipv4ConfigMode: uint8_t
#include <net/interface_config.hpp>

Supported IPv4 configuration modes for host-side interfaces such as Ethernet.

Typedef documentation

using prf::net::cfg::EthConfigSection = prf::config::TypedConfigSection<EthConfigSectionDefinition>
#include <net/interface_config.hpp>

Typed Ethernet config facade.

Function documentation

std::string prf::net::cfg::default_default_interface()
#include <net/routing_config.hpp>

Default routing policy for current single-radio profile.

std::string prf::net::cfg::default_eth_parp_match()
#include <net/interface_config.hpp>

std::string prf::net::cfg::default_eth_parp_mode()
#include <net/interface_config.hpp>

std::string prf::net::cfg::default_ipv4_mode()
#include <net/interface_config.hpp>

Default IPv4 mode for future host-side interfaces.

std::string prf::net::cfg::default_parp_match()
#include <net/interface_config.hpp>

std::string prf::net::cfg::default_parp_mode()
#include <net/interface_config.hpp>

std::string prf::net::cfg::default_usb_ipv4_mode()
#include <net/interface_config.hpp>

DefaultRoutePolicy prf::net::cfg::effective_default_route_policy(const RoutingConfigSection& section)
#include <net/routing_config.hpp>

Parses stored routing selector into runtime policy.

Ipv4ConfigMode prf::net::cfg::effective_ipv4_mode(const EthConfigSection& section)
#include <net/interface_config.hpp>

Converts stored mode string to compact enum used by runtime code.

Ipv4ConfigMode prf::net::cfg::effective_ipv4_mode(const UsbConfigSection& section)
#include <net/interface_config.hpp>

Converts stored USB mode string to compact enum used by runtime code.

prf::config::SectionSchema prf::net::cfg::make_eth_section_schema(const std::string& section_name)
#include <net/interface_config.hpp>

prf::config::SectionSchema prf::net::cfg::make_ppp_section_schema(const std::string& section_name)
#include <net/interface_config.hpp>

prf::config::SectionSchema prf::net::cfg::make_routing_section_schema(const std::string& section_name)
#include <net/routing_config.hpp>

prf::config::SectionSchema prf::net::cfg::make_usb_section_schema(const std::string& section_name)
#include <net/interface_config.hpp>

bool prf::net::cfg::parse_mac_address(const std::string& text, std::array<uint8_t, 6>*const out_mac)
#include <net/interface_config.hpp>

Parses textual MAC address (aa:bb:cc:dd:ee:ff) into 6 bytes.