нл:: Переплетение:: Профили:: DataManagement_Current:: ОбновлениеКодер:: Контекст

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

Эта структура содержит аргументы ввода-вывода метода EncodeRequest.

Краткое содержание

Конструкторы и деструкторы

Context ()

Публичные атрибуты

mBuf
PacketBuffer *
Выходной буфер.
mDataSinkCatalog
Входные данные: каталог TraitDataSinks, на который ссылаются TraitPaths.
mExpiryTimeMicroSecond
Значение поля ExpiryTimeMicroSecond для этого запроса.
mInProgressUpdateList
Список TraitPaths для кодирования.
mItemInProgress
size_t
Входные данные: индекс элемента mInProgressUpdateList, с которого начинается кодирование.
mMaxPayloadSize
uint32_t
Максимальное количество байтов для записи.
mNextDictionaryElementPathHandle
Входные данные: если кодирование начинается с возобновления словаря, это поле содержит путь к свойству следующего элемента словаря для кодирования.
mNumDataElementsAddedToPayload
size_t
Выходные данные: количество элементов, закодированных в полезных данных.
mUpdateRequestIndex
uint32_t
Значение поля UpdateRequestIndex для этого запроса.

Публичные атрибуты

мБуф 

PacketBuffer * nl::Weave::Profiles::DataManagement_Current::UpdateEncoder::Context::mBuf

Выходной буфер.

В случае сбоя длина данных PacketBuffer не обновляется, но содержимое буфера не сохраняется.

мдатасинккаталог 

const TraitCatalogBase< TraitDataSink > * nl::Weave::Profiles::DataManagement_Current::UpdateEncoder::Context::mDataSinkCatalog

Входные данные: каталог TraitDataSinks, на который ссылаются TraitPaths.

mExpiryTimeMicroSecond 

utc_timestamp_t nl::Weave::Profiles::DataManagement_Current::UpdateEncoder::Context::mExpiryTimeMicroSecond

Значение поля ExpiryTimeMicroSecond для этого запроса.

Он кодируется только в том случае, если он отличается от 0.

минпрогрессупдателист 

TraitPathStore * nl::Weave::Profiles::DataManagement_Current::UpdateEncoder::Context::mInProgressUpdateList

Список TraitPaths для кодирования.

mItemInProgress 

size_t nl::Weave::Profiles::DataManagement_Current::UpdateEncoder::Context::mItemInProgress

Входные данные: индекс элемента mInProgressUpdateList, с которого начинается кодирование.

Вывод: если при возврате весь список путей помещается в полезные данные, это поле равно mInProgressUpdateList->GetPathStoreSize(). В противном случае — индекс элемента, с которого начинается следующая полезная нагрузка.

ммакспайлоадсизе 

uint32_t nl::Weave::Profiles::DataManagement_Current::UpdateEncoder::Context::mMaxPayloadSize

Максимальное количество байтов для записи.

mNextDictionaryElementPathHandle 

PropertyPathHandle nl::Weave::Profiles::DataManagement_Current::UpdateEncoder::Context::mNextDictionaryElementPathHandle

Входные данные: если кодирование начинается с возобновления словаря, это поле содержит путь к свойству следующего элемента словаря для кодирования.

В противном случае это поле должно быть kNullPropertyPathHandle. Вывод: если последний закодированный элемент DataElement является словарем и не все элементы помещаются в полезные данные, это поле содержит дескриптор пути к свойству элемента, с которого следует начинать следующую полезную нагрузку.

мнумдатаэлементсаддедтопайлоад 

size_t nl::Weave::Profiles::DataManagement_Current::UpdateEncoder::Context::mNumDataElementsAddedToPayload

Выходные данные: количество элементов, закодированных в полезных данных.

мобдатерекуестиндекс 

uint32_t nl::Weave::Profiles::DataManagement_Current::UpdateEncoder::Context::mUpdateRequestIndex

Значение поля UpdateRequestIndex для этого запроса.

Общественные функции

Контекст 

 nl::Weave::Profiles::DataManagement_Current::UpdateEncoder::Context::Context()