Broker::Settings Struct Reference

Overview

A group of settings for broker operation.

Public Member Functions
	Settings (const etcpal::Uuid &cid_in, const rdm::Uid &static_uid_in)
	Initialize a broker Settings with a CID and static UID.
	Settings (const etcpal::Uuid &cid_in, uint16_t rdm_manu_id_in)
	Initialize a broker Settings with a CID and dynamic UID (provide the manufacturer ID).
void	SetDefaultServiceInstanceName ()
	Generate a DNS service instance name based on the broker's current CID.
bool	IsValid () const
	Whether this structure contains valid settings for broker operation.

Data Fields
etcpal::Uuid	cid
	The broker's CID.
rdm::Uid	uid
	The broker's UID.
DnsAttributes	dns
	The broker's DNS attributes.
Limits	limits
	The broker's limits.
std::string	scope {E133_DEFAULT_SCOPE}
	The RDMnet scope on which this broker should operate.
uint16_t	listen_port {0}
	Whether the broker should allow the scope to be changed via RDM commands. More...
std::vector< std::string >	listen_interfaces
	A list of strings representing the system name of network interfaces to listen on. More...

Field Documentation

listen_interfaces

std::vector<std::string> listen_interfaces

A list of strings representing the system name of network interfaces to listen on.

Each string represents the system name for a network interface. On *nix systems, this is typically a short identifier ending with a number, e.g. "eth0". On Windows, it is typically a GUID.

listen_port

uint16_t listen_port {0}

Whether the broker should allow the scope to be changed via RDM commands.

Whether the broker should allow being disabled and enabled via the BROKER_STATUS RDM command. The port on which this broker should listen for incoming connections (and advertise via DNS). 0 means use an ephemeral port.

---

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

• include/rdmnet/cpp/broker.h