nl::Weave::Profiles::DataManagement_Current::UpdateEncoder::Context

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

此结构包含 EncodeRequest 方法的 I/O 参数。

摘要

构造函数和析构函数
Context()

公共属性
mBuf
PacketBuffer *
输出缓冲区。
mDataSinkCatalog
输入：traitPaths 引用的 TraitDataSinks 目录。
mExpiryTimeMicroSecond
此请求的 ExpiryTimeMicroSecond 字段的值。
mInProgressUpdateList
要编码的 TraitPath 列表。
mItemInProgress
size_t
输入：要从中开始编码的 mInProgressUpdateList 项的索引。
mMaxPayloadSize
uint32_t
要写入的字节数上限。
mNextDictionaryElementPathHandle
输入：如果编码从正在恢复的字典开始，则此字段包含要编码的下一个字典项的属性路径。
mNumDataElementsAddedToPayload
size_t
输出：载荷中编码的项数。
mUpdateRequestIndex
uint32_t
此请求的 UpdateRequestIndex 字段的值。

公共属性

mBuf

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

输出缓冲区。

如果失败，则不会更新 PacketBuffer 的数据长度，但不会保留缓冲区内容。

mDataSinkCatalog

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

输入：traitPaths 引用的 TraitDataSinks 目录。

mExpiryTimeMicroSecond

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

此请求的 ExpiryTimeMicroSecond 字段的值。

仅当该值不是 0 时，它才会进行编码

mInProgressUpdateList

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

要编码的 TraitPath 列表。

mItemInProgress

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

输入：要从中开始编码的 mInProgressUpdateList 项的索引。

输出：返回时，如果有效负载可容纳整个路径列表，则此字段等于 mInProgressUpdateList->GetPathStoreSize()。否则为要启动下一个载荷的项的索引。

mMaxPayloadSize

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

要写入的字节数上限。

mNextDictionaryElementPathHandle

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

输入：如果编码从正在恢复的字典开始，则此字段包含要编码的下一个字典项的属性路径。

否则，此字段应为 kNullPropertyPathHandle。输出：如果最后编码的 DataElement 是字典，并且并非所有项都能放入有效负载，则此字段会存储下一个有效负载的起始项的属性路径句柄。

mNumDataElementsAddedToPayload

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

输出：载荷中编码的项数。

mUpdateRequestIndex

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

此请求的 UpdateRequestIndex 字段的值。

公共函数

上下文

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