Library API

Welcome to the developer reference to Exhale Companion. The code being documented here is largely meaningless and was only created to test various corner cases e.g. nested namespaces and the like.

Note

The text you are currently reading was fed to exhale_args using the afterTitleDescription key. Full reStructuredText syntax can be used.

Tip

Sphinx / Exhale support unicode! You’re conf.py already has it’s encoding declared as # -*- coding: utf-8 -*- by default. If you want to pass Unicode strings into Exhale, simply prefix them with a u e.g. u"👽😱💥" (of course you would actually do this because you are writing with åçćëñtß or non-English 寫作 😉).

Class Hierarchy

• Namespace _detail

  • Struct CharEncoding

  • Template Struct MbufElementHelper

  • Template Struct MbufElementHelper< Elem, MbufType::Pkt >

  • Template Struct MbufElementHelper< Elem, MbufType::Raw >

• Namespace fmt

  • Template Struct formatter< DNSParseError >

  • Template Struct formatter< fmt_helpers::fmt_count >

• Namespace fmt_helpers

  • Struct fmt_count

• Namespace glz

  • Template Struct meta< AAAARdata >

  • Template Struct meta< ARdata >

  • Template Struct meta< CNAMERdata >

  • Template Struct meta< DNAMERdata >

  • Template Struct meta< DNSPacket >

  • Template Struct meta< DNSPacket::Data >

  • Template Struct meta< DnsQType >

  • Template Struct meta< DnsRCode >

  • Template Struct meta< EtherAddr >

  • Template Struct meta< in6_addr >

  • Template Struct meta< In6Addr >

  • Template Struct meta< in_addr >

  • Template Struct meta< InAddr >

  • Template Struct meta< MXRdata >

  • Template Struct meta< NSRdata >

  • Template Struct meta< PTRRdata >

  • Template Struct meta< ResourceRecord >

  • Template Struct meta< SOARdata >

  • Template Struct meta< struct CAARdata >

  • Template Struct meta< struct TXTRdata >

• Namespace net_info

  • Struct RouteInfo

• Namespace std

  • Template Struct hash< FixedName< N > >

• Struct AAAARdata

• Struct ARdata

• Struct ArpPacket

• Struct CAARdata

• Struct CNAMERdata

• Struct DNAMERdata

• Struct DnsHeader

• Struct DNSPacket

  • Struct DNSPacket::Data

• Struct DNSPacketDistr

• Struct DnsQuestion

• Struct DomainInputInfo

• Struct EALGuard

• Struct EthDevConf

• Struct EtherAddr

• Struct EthernetConfig

• Template Struct FixedName

  • Struct FixedName::glaze

• Template Struct GenericPacket

• Struct In6Addr

• Struct InAddr

• Struct IpData

• Struct Ipv4Header

• Template Struct IsPowerOfTwoStatic

• Struct MXRdata

• Template Struct Node

• Struct NSRdata

• Struct OPTRdata

• Struct PerCoreCounters

• Struct PTRRdata

• Struct QuestionInfo

• Struct RData

• Struct Request

• Struct RequestContainer

• Struct ResourceRecord

• Template Struct RTEMbuf

• Struct SOARdata

  • Struct SOARdata::IntervalSettings

• Struct Stats

• Struct TcpIpv4Header

• Struct TcpIpv6Header

• Struct TXTRdata

• Struct UdpIpv4Header

• Struct UdpIpv6Header

• Struct UserConfig

• Struct WorkerContext

• Struct WorkerParams

• Class Arp

• Class DNSHelpers

• Class DNSPacketConstructor

• Template Class EthRxTx

• Class InputReader

• Template Class IntrusiveList

  • Template Struct IntrusiveList::BaseIterator

• Template Class RteAllocator

• Template Class RTEMbufArray

  • Template Struct RTEMbufArray::BaseIterator

• Template Class RTEMbufElement

• Template Class RTEMempool

• Template Class RTEPktMbuf

• Template Class RTERing

• Class ThreadManager

  • Template Struct ThreadManager::LCoreParams

• Enum DNSParseError

• Enum DnsQType

• Enum DnsRCode

• Enum GetBufferResult

• Enum L3Type

• Enum L4Type

• Enum MbufType

• Enum ReadDomainResult

File Hierarchy

• Directory include

  • File arp.h

  • File dns_construct_helpers.h

  • File dns_json_defs.h

  • File dns_packet.h

  • File dns_packet_constructor.h

  • File dns_struct_defs.h

  • File eth_rxtx.h

  • File eth_rxtx_opts.h

  • File input_reader.h

  • File net_info.h

  • File scanner_config.h

  • File thread_manager.h

  • File worker.h

• Directory src

  • File arp.cpp

  • File dns_packet.cpp

  • File eth_rxtx.cpp

  • File input_reader.cpp

  • File main.cpp

  • File net_info.cpp

  • File worker.cpp

• Directory utils

  • File counters.h

  • File dns_format.h

  • File dpdk_wrappers.h

  • File encode_dns_char_string.h

  • File expected_helpers.h

  • File fixed_name.hpp

  • File fmt_helpers.h

  • File intrusive_list.h

  • File network_types.h

  • File parse_helpers.h

  • File request.h

Below the hierarchies comes the full API listing.

1. The text you are currently reading is provided by afterHierarchyDescription.

2. The Title of the next section just below this normally defaults to Full API, but the title was changed by providing an argument to fullApiSubSectionTitle.

3. You can control the number of bullet points for each linked item on the remainder of the page using fullToctreeMaxDepth.

Custom Full API SubSection Title

Namespaces

• Namespace @12

• Namespace @17

• Namespace @30

• Namespace @4

• Namespace _detail
  • Classes
  • Functions
  • Variables

• Namespace fmt
  • Classes

• Namespace fmt_helpers
  • Classes

• Namespace glz
  • Classes

• Namespace net_info
  • Classes
  • Functions

• Namespace std
  • Classes

Classes and Structs

• Struct CharEncoding
  • Struct Documentation
    • CharEncoding
      • CharEncoding::operator std::string_view()
      • CharEncoding::encoded
      • CharEncoding::len

• Template Struct MbufElementHelper
  • Inheritance Relationships
    • Derived Types
  • Template Parameter Order
  • Struct Documentation
    • MbufElementHelper

• Template Struct MbufElementHelper< Elem, MbufType::Pkt >
  • Template Parameter Order
  • Struct Documentation
    • MbufElementHelper
      • MbufElementHelper::MbufElementHelper()
      • MbufElementHelper::MbufElementHelper()
      • MbufElementHelper::ptr_

• Template Struct MbufElementHelper< Elem, MbufType::Raw >
  • Template Parameter Order
  • Struct Documentation
    • MbufElementHelper
      • MbufElementHelper::MbufElementHelper()
      • MbufElementHelper::MbufElementHelper()
      • MbufElementHelper::ptr_
      • MbufElementHelper::mempool_

• Struct AAAARdata
  • Struct Documentation
    • AAAARdata
      • AAAARdata::ipv6_addr

• Struct ARdata
  • Struct Documentation
    • ARdata
      • ARdata::ipv4_addr

• Struct ArpPacket
  • Struct Documentation
    • ArpPacket
      • ArpPacket::ether_hdr
      • ArpPacket::arp_hdr

• Struct CAARdata
  • Struct Documentation
    • CAARdata
      • CAARdata::flags
      • CAARdata::tag
      • CAARdata::value

• Struct CNAMERdata
  • Struct Documentation
    • CNAMERdata
      • CNAMERdata::cname

• Struct DNAMERdata
  • Struct Documentation
    • DNAMERdata
      • DNAMERdata::dname

• Struct DnsHeader
  • Struct Documentation
    • DnsHeader
      • DnsHeader::id
      • DnsHeader::rd
      • DnsHeader::tc
      • DnsHeader::aa
      • DnsHeader::opcode
      • DnsHeader::qr
      • DnsHeader::rcode
      • DnsHeader::cd
      • DnsHeader::ad
      • DnsHeader::z
      • DnsHeader::ra
      • DnsHeader::q_count
      • DnsHeader::ans_count
      • DnsHeader::auth_count
      • DnsHeader::add_count

• Struct DNSPacket
  • Nested Relationships
    • Nested Types
  • Struct Documentation
    • DNSPacket
      • DNSPacket::GetWorkerId()
      • DNSPacket::GetBufferLoc()
      • DNSPacket::ip_data
      • DNSPacket::dns_id
      • DNSPacket::question
      • DNSPacket::q_type
      • DNSPacket::r_code
      • DNSPacket::rec_capped
      • DNSPacket::data
      • DNSPacket::init()
      • DNSPacket::Data
        • DNSPacket::Data::ans
        • DNSPacket::Data::auth
        • DNSPacket::Data::add

• Struct DNSPacket::Data
  • Nested Relationships
  • Struct Documentation
    • Data
      • Data::ans
      • Data::auth
      • Data::add

• Struct DNSPacketDistr
  • Struct Documentation
    • DNSPacketDistr
      • DNSPacketDistr::dns_packet
      • DNSPacketDistr::raw_packet

• Struct DnsQuestion
  • Struct Documentation
    • DnsQuestion
      • DnsQuestion::name
      • DnsQuestion::q_type

• Struct DomainInputInfo
  • Struct Documentation
    • DomainInputInfo
      • DomainInputInfo::buf
      • DomainInputInfo::len

• Struct EALGuard
  • Struct Documentation
    • EALGuard
      • EALGuard::~EALGuard()
      • EALGuard::EALGuard()
      • EALGuard::operator=()
      • EALGuard::EALGuard()
      • EALGuard::operator=()
      • EALGuard::init()

• Struct EthDevConf
  • Struct Documentation
    • EthDevConf
      • EthDevConf::nb_tx_queues
      • EthDevConf::nb_rx_queues
      • EthDevConf::nb_tx_descrs
      • EthDevConf::nb_rx_descrs
      • EthDevConf::enable_rss

• Struct EtherAddr
  • Inheritance Relationships
    • Base Type
  • Struct Documentation
    • EtherAddr
      • EtherAddr::str()
      • EtherAddr::operator==()
      • EtherAddr::init()

• Struct EthernetConfig
  • Struct Documentation
    • EthernetConfig
      • EthernetConfig::device_name
      • EthernetConfig::dst_mac
      • EthernetConfig::src_ip
      • EthernetConfig::dst_ip

• Template Struct FixedName
  • Nested Relationships
    • Nested Types
  • Template Parameter Order
  • Struct Documentation
    • FixedName
      • FixedName::FixedName()
      • FixedName::FixedName()
      • FixedName::operator==()
      • FixedName::operator<=>()
      • FixedName::operator std::string_view()
      • FixedName::c_str()
      • FixedName::operator+()
      • FixedName::operator+=()
      • FixedName::buf
      • FixedName::len
      • FixedName::init()
      • FixedName::glaze
        • FixedName::glaze::value

• Struct FixedName::glaze
  • Nested Relationships
  • Struct Documentation
    • glaze
      • glaze::value

• Template Struct formatter< DNSParseError >
  • Inheritance Relationships
    • Base Type
  • Struct Documentation
    • formatter
      • formatter::format()

• Template Struct formatter< fmt_helpers::fmt_count >
  • Struct Documentation
    • formatter
      • formatter::parse()
      • formatter::format()

• Struct fmt_count
  • Struct Documentation
    • fmt_count
      • fmt_count::fmt_count()
      • fmt_count::count

• Template Struct GenericPacket
  • Template Parameter Order
  • Struct Documentation
    • GenericPacket
      • GenericPacket::padding

• Template Struct meta< AAAARdata >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< ARdata >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< CNAMERdata >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< DNAMERdata >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< DNSPacket >
  • Struct Documentation
    • meta
      • meta::T
      • meta::value

• Template Struct meta< DNSPacket::Data >
  • Struct Documentation
    • meta
      • meta::T
      • meta::value

• Template Struct meta< DnsQType >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< DnsRCode >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< EtherAddr >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< in6_addr >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< In6Addr >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< in_addr >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< InAddr >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< MXRdata >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< NSRdata >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< PTRRdata >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< ResourceRecord >
  • Struct Documentation
    • meta
      • meta::T
      • meta::value

• Template Struct meta< SOARdata >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< struct CAARdata >
  • Struct Documentation
    • meta
      • meta::value

• Template Struct meta< struct TXTRdata >
  • Struct Documentation
    • meta
      • meta::value

• Struct In6Addr
  • Inheritance Relationships
    • Base Type
  • Struct Documentation
    • In6Addr
      • In6Addr::str()
      • In6Addr::operator==()
      • In6Addr::init()

• Struct InAddr
  • Inheritance Relationships
    • Base Type
  • Struct Documentation
    • InAddr
      • InAddr::str()
      • InAddr::operator==()
      • InAddr::init()

• Template Struct IntrusiveList::BaseIterator
  • Nested Relationships
  • Template Parameter Order
  • Struct Documentation
    • BaseIterator
      • BaseIterator::BaseIterator()
      • BaseIterator::operator*()
      • BaseIterator::operator->()
      • BaseIterator::front()
      • BaseIterator::operator++()
      • BaseIterator::operator++()
      • BaseIterator::operator==()
      • BaseIterator::operator!=()

• Struct IpData
  • Struct Documentation
    • IpData
      • IpData::src_ip
      • IpData::dst_ip
      • IpData::src_port
      • IpData::dst_port

• Struct Ipv4Header
  • Struct Documentation
    • Ipv4Header
      • Ipv4Header::ether_hdr
      • Ipv4Header::ipv4_hdr

• Template Struct IsPowerOfTwoStatic
  • Template Parameter Order
  • Struct Documentation
    • IsPowerOfTwoStatic
      • IsPowerOfTwoStatic::res

• Struct MXRdata
  • Struct Documentation
    • MXRdata
      • MXRdata::mailserver
      • MXRdata::preference

• Struct RouteInfo
  • Struct Documentation
    • RouteInfo
      • RouteInfo::if_name
      • RouteInfo::source_addr
      • RouteInfo::gateway_addr

• Template Struct Node
  • Template Parameter Order
  • Struct Documentation
    • Node
      • Node::Node()
      • Node::GetDataRef()
      • Node::GetDataRef()
      • Node::GetDataPtr()
      • Node::GetDataPtr()
      • Node::swap()

• Struct NSRdata
  • Struct Documentation
    • NSRdata
      • NSRdata::nameserver

• Struct OPTRdata
  • Struct Documentation
    • OPTRdata

• Struct PerCoreCounters
  • Struct Documentation
    • PerCoreCounters
      • PerCoreCounters::apply()
      • PerCoreCounters::apply()
      • PerCoreCounters::operator+=()
      • PerCoreCounters::operator-=()
      • PerCoreCounters::operator+()
      • PerCoreCounters::operator-()
      • PerCoreCounters::operator*=()
      • PerCoreCounters::operator/=()
      • PerCoreCounters::operator*()
      • PerCoreCounters::operator/()
      • PerCoreCounters::lines_rejected
      • PerCoreCounters::sent_pkts
      • PerCoreCounters::retry
      • PerCoreCounters::max_retry
      • PerCoreCounters::rcvd_pkts
      • PerCoreCounters::parse_success
      • PerCoreCounters::parse_fail
      • PerCoreCounters::other_worker_id
      • PerCoreCounters::noerror
      • PerCoreCounters::nxdomain
      • PerCoreCounters::servfail
      • PerCoreCounters::rcode_other
      • PerCoreCounters::num_resolved

• Struct PTRRdata
  • Struct Documentation
    • PTRRdata
      • PTRRdata::ptr

• Struct QuestionInfo
  • Struct Documentation
    • QuestionInfo
      • QuestionInfo::qtype
      • QuestionInfo::qclass

• Struct RData
  • Struct Documentation
    • RData
      • RData::type
      • RData::_class
      • RData::ttl
      • RData::data_len

• Struct Request
  • Struct Documentation
    • Request
      • Request::dst_mac
      • Request::src_ip
      • Request::num_ips
      • Request::q_type
      • Request::name

• Struct RequestContainer
  • Struct Documentation
    • RequestContainer
      • RequestContainer::RequestContainer()
      • RequestContainer::ready_for_send_node
      • RequestContainer::timeout_node
      • RequestContainer::request
      • RequestContainer::time_sent
      • RequestContainer::resolver
      • RequestContainer::num_tries
      • RequestContainer::loc

• Struct ResourceRecord
  • Struct Documentation
    • ResourceRecord
      • ResourceRecord::name
      • ResourceRecord::q_type
      • ResourceRecord::ttl
      • ResourceRecord::r_data

• Template Struct RTEMbuf
  • Inheritance Relationships
    • Base Type
  • Template Parameter Order
  • Struct Documentation
    • RTEMbuf
      • RTEMbuf::data()
      • RTEMbuf::data()

• Template Struct RTEMbufArray::BaseIterator
  • Nested Relationships
  • Template Parameter Order
  • Struct Documentation
    • BaseIterator
      • BaseIterator::iterator_category
      • BaseIterator::difference_type
      • BaseIterator::value_type
      • BaseIterator::pointer
      • BaseIterator::double_pointer
      • BaseIterator::reference
      • BaseIterator::BaseIterator()
      • BaseIterator::BaseIterator()
      • BaseIterator::operator*()
      • BaseIterator::operator->()
      • BaseIterator::operator++()
      • BaseIterator::operator++()
      • BaseIterator::operator==()
      • BaseIterator::operator!=()

• Struct SOARdata
  • Nested Relationships
    • Nested Types
  • Struct Documentation
    • SOARdata
      • SOARdata::m_name
      • SOARdata::r_name
      • SOARdata::interval_settings
      • SOARdata::IntervalSettings
        • SOARdata::IntervalSettings::serial
        • SOARdata::IntervalSettings::refresh
        • SOARdata::IntervalSettings::retry
        • SOARdata::IntervalSettings::expire
        • SOARdata::IntervalSettings::minimum

• Struct SOARdata::IntervalSettings
  • Nested Relationships
  • Struct Documentation
    • IntervalSettings
      • IntervalSettings::serial
      • IntervalSettings::refresh
      • IntervalSettings::retry
      • IntervalSettings::expire
      • IntervalSettings::minimum

• Struct Stats
  • Struct Documentation
    • Stats
      • Stats::num_bad_l4_cksum
      • Stats::num_bad_ip_cksum
      • Stats::num_bad_tx_cksum
      • Stats::num_total
      • Stats::num_sent
      • Stats::num_bytes_sent

• Template Struct hash< FixedName< N > >
  • Template Parameter Order
  • Struct Documentation
    • hash
      • hash::operator()()

• Struct TcpIpv4Header
  • Struct Documentation
    • TcpIpv4Header
      • TcpIpv4Header::ether_hdr
      • TcpIpv4Header::ipv4_hdr
      • TcpIpv4Header::tcp_hdr

• Struct TcpIpv6Header
  • Struct Documentation
    • TcpIpv6Header
      • TcpIpv6Header::ether_hdr
      • TcpIpv6Header::ipv6_hdr
      • TcpIpv6Header::tcp_hdr

• Template Struct ThreadManager::LCoreParams
  • Nested Relationships
  • Template Parameter Order
  • Struct Documentation
    • LCoreParams
      • LCoreParams::LCoreParams()
      • LCoreParams::f
      • LCoreParams::m_args
      • LCoreParams::start_thread
      • LCoreParams::_stop_source

• Struct TXTRdata
  • Struct Documentation
    • TXTRdata
      • TXTRdata::txt

• Struct UdpIpv4Header
  • Struct Documentation
    • UdpIpv4Header
      • UdpIpv4Header::ether_hdr
      • UdpIpv4Header::ipv4_hdr
      • UdpIpv4Header::udp_hdr

• Struct UdpIpv6Header
  • Struct Documentation
    • UdpIpv6Header
      • UdpIpv6Header::ether_hdr
      • UdpIpv6Header::ipv6_hdr
      • UdpIpv6Header::udp_hdr

• Struct UserConfig
  • Struct Documentation
    • UserConfig
      • UserConfig::headless
      • UserConfig::cores
      • UserConfig::rate
      • UserConfig::num_concurrent
      • UserConfig::timeout_ms
      • UserConfig::num_retries
      • UserConfig::gateway_ip
      • UserConfig::static_ip
      • UserConfig::gateway_mac
      • UserConfig::device_name
      • UserConfig::input_file
      • UserConfig::xdp_path
      • UserConfig::resolvers
      • UserConfig::rcode_filters
      • UserConfig::prefix
      • UserConfig::postfix
      • UserConfig::log_path
      • UserConfig::output_path
      • UserConfig::output_raw
      • UserConfig::no_huge
      • UserConfig::debug
      • UserConfig::skip_queue_count_check
      • UserConfig::q_type

• Struct WorkerContext
  • Struct Documentation
    • WorkerContext
      • WorkerContext::worker_id
      • WorkerContext::queue_id
      • WorkerContext::resolver_count
      • WorkerContext::ready_for_send_list
      • WorkerContext::timeout_list
      • WorkerContext::request_containers
      • WorkerContext::available_container_stack
      • WorkerContext::pkt_distributors
      • WorkerContext::init()

• Struct WorkerParams
  • Struct Documentation
    • WorkerParams
      • WorkerParams::num_workers
      • WorkerParams::num_containers
      • WorkerParams::rate_lim_pps
      • WorkerParams::timeout_ms
      • WorkerParams::max_retries
      • WorkerParams::counters
      • WorkerParams::resolvers
      • WorkerParams::rcode_filters
      • WorkerParams::workers_finished
      • WorkerParams::domains_finished
      • WorkerParams::ring
      • WorkerParams::rxtx_if
      • WorkerParams::raw_mempool
      • WorkerParams::pkt_mempool
      • WorkerParams::request_mempool
      • WorkerParams::output_raw
      • WorkerParams::dns_mempool
      • WorkerParams::distribution_rings

• Class Arp
  • Class Documentation
    • Arp
      • Arp::Error
        • Arp::Error::ARP_OK
        • Arp::Error::INVALID_MESSAGE
        • Arp::Error::UNKNOWN_PROTOCOL
        • Arp::Error::UNKNOWN_OP
        • Arp::Error::PACKET_CONSTRUCTION
        • Arp::Error::IO_ERROR
        • Arp::Error::NO_RESPONSE
      • Arp::Arp()
      • Arp::ReceivePacket()
      • Arp::RequestAddr()
      • Arp::GetEtherAddr()
      • Arp::InsertAddr()
      • Arp::EraseAddr()
      • Arp::ErrorToString()

• Class DNSHelpers
  • Class Documentation
    • DNSHelpers
      • DNSHelpers::ChangetoDnsNameFormat()

• Class DNSPacketConstructor
  • Class Documentation
    • DNSPacketConstructor
      • DNSPacketConstructor::ConstructIpv4DNSPacket()
      • DNSPacketConstructor::ConstructIpv6DNSPacket()
      • DNSPacketConstructor::GetMinIpv4PacketSize()
      • DNSPacketConstructor::GetMinIpv6PacketSize()

• Template Class EthRxTx
  • Template Parameter Order
  • Class Documentation
    • EthRxTx
      • EthRxTx::EthRxTx()
      • EthRxTx::operator=()
      • EthRxTx::operator=()
      • EthRxTx::EthRxTx()
      • EthRxTx::~EthRxTx()
      • EthRxTx::SendPackets()
      • EthRxTx::SendPacket()
      • EthRxTx::RcvPackets()
      • EthRxTx::PreparePackets()
      • EthRxTx::GetMacAddr()
      • EthRxTx::GenerateDNSFlow()
      • EthRxTx::PrintStats()
      • EthRxTx::GetPortId()
      • EthRxTx::init()
      • EthRxTx::PreparePktCksums()

• Class InputReader
  • Class Documentation
    • InputReader
      • InputReader::InputReader()
      • InputReader::InputReader()
      • InputReader::GetDomain()
      • InputReader::~InputReader()

• Template Class IntrusiveList
  • Nested Relationships
    • Nested Types
  • Template Parameter Order
  • Class Documentation
    • IntrusiveList
      • IntrusiveList::Iterator
      • IntrusiveList::ConstIterator
      • IntrusiveList::IntrusiveList()
      • IntrusiveList::IntrusiveList()
      • IntrusiveList::operator=()
      • IntrusiveList::IntrusiveList()
      • IntrusiveList::operator=()
      • IntrusiveList::push_back()
      • IntrusiveList::delete_elem()
      • IntrusiveList::in_list()
      • IntrusiveList::size()
      • IntrusiveList::begin()
      • IntrusiveList::end()
      • IntrusiveList::begin()
      • IntrusiveList::end()
      • IntrusiveList::erase()
      • IntrusiveList::swap()
      • IntrusiveList::BaseIterator
        • IntrusiveList::BaseIterator::BaseIterator()
        • IntrusiveList::BaseIterator::operator*()
        • IntrusiveList::BaseIterator::operator->()
        • IntrusiveList::BaseIterator::front()
        • IntrusiveList::BaseIterator::operator++()
        • IntrusiveList::BaseIterator::operator++()
        • IntrusiveList::BaseIterator::operator==()
        • IntrusiveList::BaseIterator::operator!=()

• Template Class RteAllocator
  • Template Parameter Order
  • Class Documentation
    • RteAllocator
      • RteAllocator::value_type
      • RteAllocator::RteAllocator()
      • RteAllocator::allocate()
      • RteAllocator::deallocate()

• Template Class RTEMbufArray
  • Nested Relationships
    • Nested Types
  • Template Parameter Order
  • Class Documentation
    • RTEMbufArray
      • RTEMbufArray::value_type
      • RTEMbufArray::owning_value_type
      • RTEMbufArray::pointer
      • RTEMbufArray::const_pointer
      • RTEMbufArray::double_pointer
      • RTEMbufArray::reference
      • RTEMbufArray::const_reference
      • RTEMbufArray::Iterator
      • RTEMbufArray::ConstIterator
      • RTEMbufArray::RTEMbufArray()
      • RTEMbufArray::~RTEMbufArray()
      • RTEMbufArray::release()
      • RTEMbufArray::RTEMbufArray()
      • RTEMbufArray::operator=()
      • RTEMbufArray::RTEMbufArray()
      • RTEMbufArray::operator=()
      • RTEMbufArray::insert()
      • RTEMbufArray::split()
      • RTEMbufArray::FromSpan()
      • RTEMbufArray::size()
      • RTEMbufArray::free_cnt()
      • RTEMbufArray::capacity()
      • RTEMbufArray::data()
      • RTEMbufArray::operator[]()
      • RTEMbufArray::operator[]()
      • RTEMbufArray::get_data()
      • RTEMbufArray::get_data()
      • RTEMbufArray::begin()
      • RTEMbufArray::end()
      • RTEMbufArray::begin()
      • RTEMbufArray::end()
      • RTEMbufArray::front()
      • RTEMbufArray::back()
      • RTEMbufArray::front()
      • RTEMbufArray::back()
      • RTEMbufArray::pop()
      • RTEMbufArray::push()
      • RTEMbufArray::init()
      • RTEMbufArray::init()
      • RTEMbufArray::init()
      • RTEMbufArray::BaseIterator
        • RTEMbufArray::BaseIterator::iterator_category
        • RTEMbufArray::BaseIterator::difference_type
        • RTEMbufArray::BaseIterator::value_type
        • RTEMbufArray::BaseIterator::pointer
        • RTEMbufArray::BaseIterator::double_pointer
        • RTEMbufArray::BaseIterator::reference
        • RTEMbufArray::BaseIterator::BaseIterator()
        • RTEMbufArray::BaseIterator::BaseIterator()
        • RTEMbufArray::BaseIterator::operator*()
        • RTEMbufArray::BaseIterator::operator->()
        • RTEMbufArray::BaseIterator::operator++()
        • RTEMbufArray::BaseIterator::operator++()
        • RTEMbufArray::BaseIterator::operator==()
        • RTEMbufArray::BaseIterator::operator!=()

• Template Class RTEMbufElement
  • Inheritance Relationships
    • Base Type
  • Template Parameter Order
  • Class Documentation
    • RTEMbufElement
      • RTEMbufElement::value_type
      • RTEMbufElement::pointer
      • RTEMbufElement::double_pointer
      • RTEMbufElement::reference
      • RTEMbufElement::const_reference
      • RTEMbufElement::~RTEMbufElement()
      • RTEMbufElement::RTEMbufElement()
      • RTEMbufElement::operator=()
      • RTEMbufElement::RTEMbufElement()
      • RTEMbufElement::operator=()
      • RTEMbufElement::operator bool()
      • RTEMbufElement::release()
      • RTEMbufElement::get()
      • RTEMbufElement::get()
      • RTEMbufElement::get_data()
      • RTEMbufElement::get_data()
      • RTEMbufElement::init()
      • RTEMbufElement::init()

• Template Class RTEMempool
  • Template Parameter Order
  • Class Documentation
    • RTEMempool
      • RTEMempool::RTEMempool()
      • RTEMempool::operator=()
      • RTEMempool::RTEMempool()
      • RTEMempool::operator=()
      • RTEMempool::~RTEMempool()
      • RTEMempool::count()
      • RTEMempool::capacity()
      • RTEMempool::get()
      • RTEMempool::init()
      • RTEMempool::init()

• Template Class RTEPktMbuf
  • Template Parameter Order
  • Class Documentation
    • RTEPktMbuf

• Template Class RTERing
  • Template Parameter Order
  • Class Documentation
    • RTERing
      • RTERing::value_type
      • RTERing::owning_value_type
      • RTERing::pointer
      • RTERing::const_pointer
      • RTERing::double_pointer
      • RTERing::reference
      • RTERing::const_reference
      • RTERing::~RTERing()
      • RTERing::enqueue()
      • RTERing::enqueue_burst()
      • RTERing::dequeue()
      • RTERing::dequeue_burst()
      • RTERing::count()
      • RTERing::capacity()
      • RTERing::free_count()
      • RTERing::empty()
      • RTERing::RTERing()
      • RTERing::operator=()
      • RTERing::RTERing()
      • RTERing::operator=()
      • RTERing::init()
      • RTERing::init()

• Class ThreadManager
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • ThreadManager
      • ThreadManager::LaunchThreadResult
        • ThreadManager::LaunchThreadResult::Success
        • ThreadManager::LaunchThreadResult::MaxLCoreReached
        • ThreadManager::LaunchThreadResult::NotMainLCore
        • ThreadManager::LaunchThreadResult::RemoteLaunchFail
      • ThreadManager::ThreadManager()
      • ThreadManager::~ThreadManager()
      • ThreadManager::join()
      • ThreadManager::ThreadManager()
      • ThreadManager::ThreadManager()
      • ThreadManager::LaunchThread()
      • ThreadManager::GetTotalThreads()
      • ThreadManager::GetUnusedThreads()
      • ThreadManager::get_stop_source()
      • ThreadManager::get_stop_token()
      • ThreadManager::request_stop()

Enums

• Enum DNSParseError
  • Enum Documentation
    • DNSParseError
      • DNSParseError::PktError
      • DNSParseError::OutOfBounds
      • DNSParseError::InvalidQCount
      • DNSParseError::NameTooLong
      • DNSParseError::MaxJumpsReached
      • DNSParseError::AllocationError
      • DNSParseError::IpHdrProtoErr
      • DNSParseError::EtherHdrProtoErr
      • DNSParseError::SrcPortErr
      • DNSParseError::MalformedPacket
      • DNSParseError::TxtTooLong
      • DNSParseError::InvalidChar

• Enum DnsQType
  • Enum Documentation
    • DnsQType
      • DnsQType::A
      • DnsQType::NS
      • DnsQType::CNAME
      • DnsQType::SOA
      • DnsQType::PTR
      • DnsQType::MX
      • DnsQType::TXT
      • DnsQType::AAAA
      • DnsQType::DNAME
      • DnsQType::OPT
      • DnsQType::CAA

• Enum DnsRCode
  • Enum Documentation
    • DnsRCode
      • DnsRCode::NOERROR
      • DnsRCode::FORMERROR
      • DnsRCode::SERVFAIL
      • DnsRCode::NXDOMAIN
      • DnsRCode::NOTIMP
      • DnsRCode::REFUSED
      • DnsRCode::YXDOMAIN
      • DnsRCode::XYRRSET
      • DnsRCode::NXRRSET
      • DnsRCode::NOTAUTH
      • DnsRCode::NOTZONE
      • DnsRCode::DSOTYPENI
      • DnsRCode::BADVERS
      • DnsRCode::BADKEY
      • DnsRCode::BADTIME
      • DnsRCode::BADMODE
      • DnsRCode::BADNAM
      • DnsRCode::BADALG
      • DnsRCode::BADTRUNC
      • DnsRCode::BADCOOKIE

• Enum GetBufferResult
  • Enum Documentation
    • GetBufferResult
      • GetBufferResult::Success
      • GetBufferResult::NotAvailable

• Enum L3Type
  • Enum Documentation
    • L3Type
      • L3Type::Ipv4
      • L3Type::Ipv6

• Enum L4Type
  • Enum Documentation
    • L4Type
      • L4Type::UDP
      • L4Type::TCP

• Enum MbufType
  • Enum Documentation
    • MbufType
      • MbufType::Raw
      • MbufType::Pkt

• Enum ReadDomainResult
  • Enum Documentation
    • ReadDomainResult
      • ReadDomainResult::Success
      • ReadDomainResult::NotAvailable
      • ReadDomainResult::FileEnd
      • ReadDomainResult::NotValid

Functions

• Function _detail::to_decimal
  • Function Documentation
    • to_decimal()

• Function _detail::to_decimal_char
  • Function Documentation
    • to_decimal_char()

• Function AddRequestsToReadyForSend
  • Function Documentation

• Template Function AdvanceReader
  • Function Documentation

• Function ConsumeReadyForSendAndPrepare
  • Function Documentation

• Function contains_unprintable_chars_or_space
  • Function Documentation

• Template Function encode_dns_char_string
  • Function Documentation
    • encode_dns_char_string()

• Function FormatCounters
  • Function Documentation

• Function get_if_to_use
  • Function Documentation

• Function GetEthernetConfig
  • Function Documentation

• Function GetMemoryUsage
  • Function Documentation

• Function GetPortByName
  • Function Documentation

• Function GetPortMac
  • Function Documentation

• Function GetQTypeFromString
  • Function Documentation
    • GetQTypeFromString()

• Function GetQTypeMessage
  • Function Documentation
    • GetQTypeMessage()

• Function GetRCodeFromMessage
  • Function Documentation
    • GetRCodeFromMessage()

• Function GetRCodeMessage
  • Function Documentation
    • GetRCodeMessage()

• Function HandleParsedPacket
  • Function Documentation

• Function init_eal_args
  • Function Documentation

• Function InitConfigFromArgs
  • Function Documentation

• Function IsPowerOfTwo
  • Function Documentation

• Function main
  • Function Documentation

• Function net_info::get_channel_count
  • Function Documentation
    • get_channel_count()

• Function net_info::get_mac_address
  • Function Documentation
    • get_mac_address()

• Function net_info::get_route_info
  • Function Documentation
    • get_route_info()

• Function PackPacketParams
  • Function Documentation

• Function ParseDNSReturnCodes
  • Function Documentation
    • ParseDNSReturnCodes()

• Template Function ParseFixedName
  • Function Documentation

• Function ParseResolvers
  • Function Documentation
    • ParseResolvers()

• Function ParseResourceRecord
  • Function Documentation

• Function PrintOffloadFlags
  • Function Documentation

• Function ProcessTimeouts
  • Function Documentation

• Function ReadFromDNSNameFormat
  • Function Documentation

• Template Function RequestGatewayMac
  • Function Documentation

• Function RX
  • Function Documentation

• Function SigintHandler
  • Function Documentation

• Function VerifyQueues
  • Function Documentation

• Function Worker(std::stop_token, uint16_t, WorkerParams)
  • Function Documentation
    • Worker()

• Function Worker(std::stop_token, uint16_t, WorkerParams)
  • Function Documentation
    • Worker()

Variables

• Variable _detail::char_encoding_max_size
  • Variable Documentation
    • char_encoding_max_size

• Variable _detail::char_map
  • Variable Documentation
    • char_map

Defines

• Define BUFFER_SIZE
  • Define Documentation

• Define CAA_TAG_MAX_SIZE
  • Define Documentation

• Define CACHELINE_SIZE
  • Define Documentation

• Define CHARACTER_STRING_MAX_SIZE
  • Define Documentation

• Define DOMAIN_NAME_MAX_SIZE
  • Define Documentation

• Define DOMAIN_NAME_MAX_SIZE
  • Define Documentation

• Define ETHER_ADDRSTRLEN
  • Define Documentation

• Define MAX_PATTERN_NUM
  • Define Documentation

• Define RING_QUEUE_DEPTH
  • Define Documentation

• Define UNWRAP_OR_RETURN
  • Define Documentation

• Define UNWRAP_OR_RETURN_AND_LOG
  • Define Documentation

• Define UNWRAP_OR_RETURN_ERR
  • Define Documentation

• Define UNWRAP_OR_RETURN_ERR_AND_LOG
  • Define Documentation

• Define UNWRAP_OR_RETURN_RAW
  • Define Documentation

• Define UNWRAP_OR_RETURN_VAL
  • Define Documentation

• Define UNWRAP_OR_RETURN_VAL_AND_LOG
  • Define Documentation

Typedefs

• Typedef CAATag
  • Typedef Documentation
    • CAATag

• Typedef DefaultPacket
  • Typedef Documentation
    • DefaultPacket

• Typedef DnsName
  • Typedef Documentation
    • DnsName

• Typedef IpAddr
  • Typedef Documentation
    • IpAddr

• Typedef NICType
  • Typedef Documentation
    • NICType

• Typedef Rdata
  • Typedef Documentation
    • Rdata

• Typedef TxtString
  • Typedef Documentation
    • TxtString

You read all the way to the bottom?! This text is specified by giving an argument to afterBodySummary. As the docs state, this summary gets put in after a lot of information. It’s available for you to use if you want it, but from a design perspective it’s rather unlikely any of your users will even see this text.