Google is committed to advancing racial equity for Black communities. See how.

nl::Weave::Support::ProfileStringInfo

#include <src/lib/support/ProfileStringSupport.hpp>

Callbacks associated with the specified profile identifier for returning human-readable support strings associated with the profile.

Summary

This structure provides storage for callbacks associated with the specified profile identifier for returning human-readable support strings associated with the profile.

The structure may be registered (along with a companion context structure), looked up once registered, and deregistered (along with a companion context structure).

To optimize space in constrained applications, this structure should typically be allocated with constant, static storage qualifiers (i.e. static const).

Public attributes

mMessageNameFunct
MessageNameFunct
An optional pointer to a callback to return descriptive names associated with profile message types.
mProfileId
uint32_t
The profile identifier under which to register string callbacks.
mProfileNameFunct
ProfileNameFunct
An optional pointer to a callback to return a descriptive name associated with the profile.
mStatusReportFormatStringFunct
StatusReportFormatStringFunct
An optional pointer to a callback to return a descriptive string for profile status codes.

Public attributes

mMessageNameFunct

MessageNameFunct nl::Weave::Support::ProfileStringInfo::mMessageNameFunct

An optional pointer to a callback to return descriptive names associated with profile message types.

mProfileId

uint32_t nl::Weave::Support::ProfileStringInfo::mProfileId

The profile identifier under which to register string callbacks.

mProfileNameFunct

ProfileNameFunct nl::Weave::Support::ProfileStringInfo::mProfileNameFunct

An optional pointer to a callback to return a descriptive name associated with the profile.

mStatusReportFormatStringFunct

StatusReportFormatStringFunct nl::Weave::Support::ProfileStringInfo::mStatusReportFormatStringFunct

An optional pointer to a callback to return a descriptive string for profile status codes.