SatCat5
satcat5::eth::Header Struct Reference

Detailed Description

An Ethernet frame header.

The Ethernet frame header always constains destination MAC, source MAC, and EtherType. It may contain an optional VLAN tag. See also: https://en.wikipedia.org/wiki/Ethernet_frame

Definition at line 167 of file eth_header.h.

#include <eth_header.h>

Collaboration diagram for satcat5::eth::Header:
[legend]

Public Member Functions

 Header (const Header &t)=default
 
Headeroperator= (const Header &t)=default
 
void log_to (satcat5::log::LogBuffer &wr) const
 Human-readable report of all fields.
 
void write_to (satcat5::io::Writeable *wr) const
 Write Ethernet header to the designated stream.
 
bool read_from (satcat5::io::Readable *rd)
 Read Ethernet header from the designated stream. More...
 

Public Attributes

satcat5::eth::MacAddr dst
 Ethernet header fields.
 
satcat5::eth::MacAddr src
 Ethernet header fields.
 
satcat5::eth::MacType type
 Ethernet header fields.
 
satcat5::eth::VlanTag vtag
 Ethernet header fields.
 

Member Function Documentation

◆ read_from()

bool Header::read_from ( satcat5::io::Readable rd)

Read Ethernet header from the designated stream.

(Returns true on success, false otherwise.)

Definition at line 128 of file eth_header.cc.


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