rdmnet::EptClientList Class Reference

Overview

A list of EPT client entries.

Not valid for use other than as a parameter to an RDMnet callback function; use EptClientList::GetClientEntries() to copy out the data.

#include <rdmnet/cpp/message_types/ept_client.h>

Public Member Functions
	EptClientList ()=delete
	Not default-constructible.
	EptClientList (const EptClientList &other)=delete
	Not copyable - use GetClientEntries() to copy out the data.
EptClientList &	operator= (const EptClientList &other)=delete
	Not copyable - use GetClientEntries() to copy out the data.
constexpr	EptClientList (const RdmnetEptClientList &c_list) noexcept
	Construct an EptClientList which references an instance of the C RdmnetEptClientList type.
std::vector< EptClientEntry >	GetClientEntries () const
	Copy out the list of client entries. More...
constexpr bool	more_coming () const noexcept
	This message contains a partial list. More...
constexpr const RdmnetEptClientEntry *	raw_entry_array () const noexcept
	Get a pointer to the raw array of client entry C structures.
constexpr size_t	raw_entry_array_size () const noexcept
	Get the size of the raw array of client entry C structures.

Member Function Documentation

GetClientEntries()

std::vector< EptClientEntry > rdmnet::EptClientList::GetClientEntries ( ) const

inline

Copy out the list of client entries.

This function copies and translates the list delivered to a callback function into C++ native types. These types use C++ heap-allocating containers to store the client entry data and sub-protocol entries.

more_coming()

constexpr bool rdmnet::EptClientList::more_coming ( ) const

constexprnoexcept

This message contains a partial list.

This can be set when the library runs out of static memory in which to store Client Entries and must deliver the partial list before continuing. The application should store the entries in the list but should not act on the list until another EptClientList is received with more_coming() == false.

---

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

• include/rdmnet/cpp/message_types/ept_client.h