SatCat5
satcat5::ip::Route Struct Reference

Detailed Description

A single entry in the static routing table.

SatCat5 routing-table concepts.

Definition at line 57 of file ip_table.h.

#include <ip_table.h>

Collaboration diagram for satcat5::ip::Route:
[legend]

Public Member Functions

 Route (const Route &t)=default
 
Routeoperator= (const Route &t)=default
 
bool has_dstmac () const
 Does this route have a known next-hop MAC address?
 
bool has_gateway () const
 Does this route have a known next-hop IPv4 address?
 
bool is_deliverable () const
 Does this route have a valid next-hop address of any kind?
 
bool is_multicast () const
 Is the next-hop address a multicast address?
 
bool is_proxy_arp () const
 Is proxy-ARP enabled for this route? More...
 
bool is_unicast () const
 Is the next-hop address an ordinary unicast address?
 
void log_to (satcat5::log::LogBuffer &wr) const
 Format a one-line log entry containing all route parameters.
 

Public Attributes

satcat5::ip::Subnet subnet
 Subnet address + mask.
 
satcat5::ip::Addr gateway
 Next-hop IPv4 address.
 
satcat5::eth::MacAddr dstmac
 Next-hop MAC address.
 
u8 port
 Next-hop port number.
 
u8 flags
 Additional flags.
 

Static Public Attributes

static constexpr u8 FLAG_PROXY_ARP = 0x01
 Enable proxy-ARP for this route? If proxy-ARP is enabled, then the router should respond to ARP queries for this subnet with the specified next-hop MAC address. More...
 
static constexpr u8 FLAG_MAC_FIXED = 0x02
 Fixed MAC-address for this route? If this flag is set, then the user specified the MAC address. More...
 

Member Function Documentation

◆ is_proxy_arp()

bool satcat5::ip::Route::is_proxy_arp ( ) const
inline

Is proxy-ARP enabled for this route?

See also
FLAG_PROXY_ARP.

Definition at line 94 of file ip_table.h.

Member Data Documentation

◆ FLAG_MAC_FIXED

constexpr u8 satcat5::ip::Route::FLAG_MAC_FIXED = 0x02
staticconstexpr

Fixed MAC-address for this route? If this flag is set, then the user specified the MAC address.

Otherwise, the MAC address is derived from an ARP query.

Definition at line 74 of file ip_table.h.

◆ FLAG_PROXY_ARP

constexpr u8 satcat5::ip::Route::FLAG_PROXY_ARP = 0x01
staticconstexpr

Enable proxy-ARP for this route? If proxy-ARP is enabled, then the router should respond to ARP queries for this subnet with the specified next-hop MAC address.

Useful for network bridges and one-way links.

Definition at line 69 of file ip_table.h.


The documentation for this struct was generated from the following files: