llmx::rtaco::LinkDumpTask Class Reference

Task that performs a full link dump from the kernel. More...

#include <nl_link_dump_task.hxx>

Inheritance diagram for llmx::rtaco::LinkDumpTask:

Public Member Functions
	LinkDumpTask (SocketGuard &socket_guard, std::pmr::memory_resource *pmr, uint16_t ifindex, uint32_t sequence) noexcept
	Construct a LinkDumpTask.
void	prepare_request ()
	Prepare the netlink request to dump links.
auto	process_message (const nlmsghdr &header) -> std::optional< std::expected< LinkEventList, std::error_code > >
	Process a received netlink message for link dump responses.
Public Member Functions inherited from llmx::rtaco::LinkTask< LinkDumpTask, LinkEventList >
auto	request_payload () const -> std::span< const uint8_t >
	Get the serialized payload for the link request.
Public Member Functions inherited from llmx::rtaco::RequestTask< LinkDumpTask, LinkEventList >
	RequestTask (SocketGuard &socket_guard, uint16_t ifindex, uint32_t sequence) noexcept
	Construct a RequestTask.
virtual	~RequestTask ()=default
	Virtual destructor.
auto	async_run () -> boost::asio::awaitable< std::expected< LinkEventList, std::error_code > >
	Run the request asynchronously and return the result.

Private Member Functions
auto	handle_done () -> std::expected< LinkEventList, std::error_code >
auto	handle_error (const nlmsghdr &header) -> std::expected< LinkEventList, std::error_code >
auto	dispatch_link (const nlmsghdr &header) -> std::optional< std::expected< LinkEventList, std::error_code > >

Private Attributes
LinkEventList	learned_

Additional Inherited Members
Protected Member Functions inherited from llmx::rtaco::LinkTask< LinkDumpTask, LinkEventList >
void	build_request (uint16_t msg_flags=NLM_F_REQUEST|NLM_F_DUMP, uint8_t family=AF_UNSPEC, uint16_t type=0, uint32_t flags=0, uint32_t change=0)
Protected Member Functions inherited from llmx::rtaco::RequestTask< LinkDumpTask, LinkEventList >
auto	socket () noexcept -> Socket &
auto	sequence () const noexcept -> uint32_t
auto	ifindex () const noexcept -> uint16_t
Protected Attributes inherited from llmx::rtaco::LinkTask< LinkDumpTask, LinkEventList >
LinkRequest	request_

Detailed Description

Task that performs a full link dump from the kernel.

Issues an RTM_GETLINK dump and collects LinkEvent entries as messages are received. Returns the accumulated LinkEventList on completion.

Constructor & Destructor Documentation

LinkDumpTask()

llmx::rtaco::LinkDumpTask::LinkDumpTask ( SocketGuard & socket_guard, std::pmr::memory_resource * pmr, uint16_t ifindex, uint32_t sequence )

noexcept

Construct a LinkDumpTask.

Parameters

socket_guard	Reference to the socket guard.
pmr	Memory resource used for event list allocations.
ifindex	Interface index to target (0 = all).
sequence	Netlink message sequence number.

Member Function Documentation

dispatch_link()

auto llmx::rtaco::LinkDumpTask::dispatch_link ( const nlmsghdr & header ) -> std::optional< std::expected< LinkEventList, std::error_code > >

private

handle_done()

auto llmx::rtaco::LinkDumpTask::handle_done ( ) -> std::expected< LinkEventList, std::error_code >

private

handle_error()

auto llmx::rtaco::LinkDumpTask::handle_error ( const nlmsghdr & header ) -> std::expected< LinkEventList, std::error_code >

private

prepare_request()

void llmx::rtaco::LinkDumpTask::prepare_request

(

)

Prepare the netlink request to dump links.

process_message()

auto llmx::rtaco::LinkDumpTask::process_message

(

const nlmsghdr &

header

)

-> std::optional< std::expected< LinkEventList, std::error_code > >

Process a received netlink message for link dump responses.

Parameters

header

Netlink message header.

Returns

Optional expected with LinkEventList on completion or an error.

Member Data Documentation

learned_

LinkEventList llmx::rtaco::LinkDumpTask::learned_

private

---

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

• nl_link_dump_task.hxx
• nl_link_dump_task.cxx