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

nl::Weave::Profiles::DataManagement_Current::LogStorageResources

#include <src/lib/profiles/data-management/Current/LoggingManagement.h>

A helper class used in initializing logging management.

Summary

The class is used to encapsulate the resources allocated by the caller and denotes resources to be used in logging events of a particular importance. Note that while resources referring to the counters are used exclusively by the particular importance level, the buffers are shared between this importance level and events that are "more" important.

Public attributes

mBuffer
void *
Buffer to be used as a storage at the particular importance level and shared with more important events.
mBufferSize
size_t
The size, in bytes, of the mBuffer.
mCounterEpoch
uint32_t
The interval used in incrementing persistent counters.
mCounterKey
nl::Weave::Platform::PersistedStorage::Key *
Name of the key naming persistent counter for events of this importance.
mCounterStorage
Application-provided storage for persistent counter for this importance level.
mImportance
Log importance level associated with the resources provided in this structure.

Public attributes

mBuffer

void * nl::Weave::Profiles::DataManagement_Current::LogStorageResources::mBuffer

Buffer to be used as a storage at the particular importance level and shared with more important events.

Must not be NULL. Must be large enough to accommodate the largest event emitted by the system.

mBufferSize

size_t nl::Weave::Profiles::DataManagement_Current::LogStorageResources::mBufferSize

The size, in bytes, of the mBuffer.

mCounterEpoch

uint32_t nl::Weave::Profiles::DataManagement_Current::LogStorageResources::mCounterEpoch

The interval used in incrementing persistent counters.

When 0, the persistent counters will not be used for this importance level.

mCounterKey

nl::Weave::Platform::PersistedStorage::Key * nl::Weave::Profiles::DataManagement_Current::LogStorageResources::mCounterKey

Name of the key naming persistent counter for events of this importance.

When NULL, the persistent counters will not be used for this importance level.

mCounterStorage

nl::Weave::PersistedCounter * nl::Weave::Profiles::DataManagement_Current::LogStorageResources::mCounterStorage

Application-provided storage for persistent counter for this importance level.

When NULL, persistent counters will not be used for this importance level.

mImportance

ImportanceType nl::Weave::Profiles::DataManagement_Current::LogStorageResources::mImportance

Log importance level associated with the resources provided in this structure.