prf::net::pool::PoolControlCommands class final

#include <net/pool/control_commands.hpp>

Publishes pool management commands under /ip/pool/....

Available endpoints:

/ip/pool/list
/ip/pool/schema
/ip/pool/pool1/info
/ip/pool/pool1/config
/ip/pool/pool1/leases
/ip/pool/pool1/schema
/ip/pool/pool1/set

Example:

prf::net::pool::PoolControlCommands commands(pool_manager, sections);
exchange.set_commands(commands.descriptors());

Constructors, destructors, conversion operators

PoolControlCommands(Ipv4PoolManager& pool_manager, std::span<cfg::PoolConfigSection*const> pool_sections)

Creates the pool control adapter over scenario-owned pool sections.

Public functions

auto descriptors() const -> std::span<const prf::control::CommandDescriptor>

Returns command descriptors to register in the shared control registry.

Function documentation

prf::net::pool::PoolControlCommands::PoolControlCommands(Ipv4PoolManager& pool_manager, std::span<cfg::PoolConfigSection*const> pool_sections)

Creates the pool control adapter over scenario-owned pool sections.

Both the pool manager and the section pointers must stay valid for the lifetime of this adapter.