nl:: Weave:: Profiles:: DataManagement_Current:: UpdateEncoder:: Context
#include <src/lib/profiles/data-management/Current/UpdateEncoder.h>
この構造体は、EncodeRequest メソッドの I/O 引数を保持します。
概要
コンストラクタとデストラクタ |
|
---|---|
Context()
|
パブリック属性 |
|
---|---|
mBuf
|
PacketBuffer *
出力バッファ。
|
mDataSinkCatalog
|
const TraitCatalogBase< TraitDataSink > *
入力: TraitPath が参照する 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
入力: TraitPath が参照する 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()