nl ::織り::プロファイル::データ管理_レガシー:: ProfileDatabase

これは抽象クラスです。

#include <src/lib/profiles/data-management/Legacy/ProfileDatabase.h>

抽象ProfileDatabase補助クラス。

概要

WDMは、プロトコルの実装をデータ管理の実装から分離し、少なくとも原則として、後者のほとんどをアプリケーション開発者に任せます。 WDMのすべての興味深い呼び出しと、プロファイル開発者が実装する必要のあるすべての抽象メソッドは、TLVでエンコードされたパスリストまたはデータリストを取得します。これは、プットプロファイルの開発者の負担をして、実際には、開発者が梱包と開梱のために同じコードの書き込みの後に開発者としてコードの重複の多くの原因となりますTLVをなどを。少し楽にするために、一種の「データ管理ツールキット」を提供しています。

この補助クラスは、必要コンクリートことを条件とするデータ格納および検索するためのサポートを提供ProfileDataのサブクラスが供給さに追加されたLookupProfileData()以下の方法を。

公共機能

LookupDataFromProfileDescriptor (nl::Weave::TLV::TLVReader & aDescReader, ProfileData **aProfileData)
検索ProfileDataのデータベース内のオブジェクトを。
LookupProfileData (nl::Weave::TLV::TLVReader & aPathReader, ProfileData **aProfileData)
検索ProfileDataのデータベース内のオブジェクトを。
LookupProfileData (uint32_t aProfileId,nl::Weave::TLV::TLVReader *aInstanceIdRdr, ProfileData **aResult)=0
virtual WEAVE_ERROR
見上げProfileDataのオブジェクトを。
Retrieve ( ReferencedTLVData & aPathList, ReferencedTLVData & aDataList)
パスリストを指定してデータリストを取得します。
Retrieve ( ReferencedTLVData & aPathList,nl::Weave::TLV::TLVWriter & aWriter)
パス リストを指定してデータ リストを書き出します。
Store ( ReferencedTLVData & aDataList)
データリストを保存します。

保護された機能

StoreInternal (nl::Weave::TLV::TLVReader & aPathReader, uint64_t aVersion,nl::Weave::TLV::TLVReader & aDataReader)

クラス

NL ::織り::プロファイル:: DataManagement_Legacy :: ProfileDatabase :: ProfileData

抽象ProfileData補助内部クラス。

公共機能

LookupDataFromProfileDescriptor

WEAVE_ERROR LookupDataFromProfileDescriptor(
  nl::Weave::TLV::TLVReader & aDescReader,
  ProfileData **aProfileData
)

検索ProfileDataのデータベース内のオブジェクトを。

このユーティリティメソッドは、検索するために使用されるProfileDataの特定のオブジェクトをProfileDatabase 。これは、コンクリートの実装により提供される検索方法に大きく依存ProfileDatabaseのサブクラス。

詳細
パラメーター
[in] aDescReader
参照のTLV 、すなわちA -読者は、WDM経路に位置TLVの最初の要素、プロファイルの説明のように、パス有します。
[out] aProfileData
ポインタを返すように意図ポインタ、 ProfileDataの関心の対象。
戻り値
WEAVE_NO_ERROR成功した場合には、そうでない場合は返すWEAVE_ERRORマッチング検索する失敗を示すProfileDataのオブジェクトを。

LookupProfileData

WEAVE_ERROR LookupProfileData(
  nl::Weave::TLV::TLVReader & aPathReader,
  ProfileData **aProfileData
)

検索ProfileDataのデータベース内のオブジェクトを。

このユーティリティメソッドは、検索するために使用されるProfileDataの特定のオブジェクトをProfileDatabase 。これは、コンクリートの実装により提供される検索方法に大きく依存ProfileDatabaseのサブクラス。

詳細
パラメーター
[in] aPathReader
参照のTLV 、すなわちA -読者は、WDM経路に位置TLVの最初の要素、プロファイルの説明のように、パス有します。
[out] aProfileData
ポインタを返すように意図ポインタ、 ProfileDataの関心の対象。
戻り値
WEAVE_NO_ERROR成功した場合には、そうでない場合は返すWEAVE_ERRORマッチング検索する失敗を示すProfileDataのオブジェクトを。

LookupProfileData

virtual WEAVE_ERROR LookupProfileData(
  uint32_t aProfileId,
  nl::Weave::TLV::TLVReader *aInstanceIdRdr,
  ProfileData **aResult
)=0

見上げProfileDataのオブジェクトを。

特定ルックアップProfileDataのプロファイルIDとして提供(任意)インスタンスID <指定されたオブジェクトをTLVのリーダ。

詳細
パラメーター
[in] aProfileId
対象のプロファイルの32ビットプロファイル番号。
[in] aInstanceIdRdr
ポインタTLVのインスタンス識別子データに位置決めリーダー。インスタンス識別子が提供されていない場合、これは NULL になります。
[out] aResult
ポインタを返すように意図ポインタ、 ProfileDataの関心の対象。
戻り値
WEAVE_NO_ERROR成功しました。それ以外の場合は返すWEAVE_ERROR見つけることができないこと反映ProfileDataのオブジェクトを。

取得

WEAVE_ERROR Retrieve(
  ReferencedTLVData & aPathList,
  ReferencedTLVData & aDataList
)

パスリストを指定してデータリストを取得します。

パスのリストを指定して、パスリスト内の各パスのデータリスト要素を含むデータリストを取得し、そのパスの終端であるデータを取得します。

詳細
パラメーター
[in] aPathList
参照ReferencedTLVDataを取得するためのデータを表す経路のTLVエンコードリストを含むオブジェクト。このパラメーターは、この関数の実行中は一定に保たれます。
[out] aDataList
参照ReferencedTLVDataの目的は、検索結果を書き込みます。データ長は、この関数が正常に実行された後にのみ調整されます。
戻り値
WEAVE_NO_ERROR成功しました。それ以外の場合は返すWEAVE_ERROR関心のデータリストを取得するために失敗したことを示すを。

取得

WEAVE_ERROR Retrieve(
  ReferencedTLVData & aPathList,
  nl::Weave::TLV::TLVWriter & aWriter
)

パスリストを指定してデータリストを書き出します。

パスのリストを指定するTLVのパスリスト内の各経路とその経路の端末であるデータのデータリスト要素を含むデータリストを書き出す、ライター。

詳細
パラメーター
[in] aPathList
参照ReferencedTLVDataとのリストを含むオブジェクトTLVを取得するためのデータを表すパス。このパラメーターは、この関数の実行中は一定に保たれます。
[in] aWriter
参照TLVのライターは、検索パスリストの書き出しに使用します。エラーが発生した場合、ライターの内部状態が回復できない可能性があります。
戻り値
WEAVE_NO_ERROR成功しました。そうしないと返すWEAVE_ERRORデータを取得したり、興味のあるデータリストを書き出すに失敗したことを示すを。

お店

WEAVE_ERROR Store(
  ReferencedTLVData & aDataList
)

データリストを保存します。

TLV符号化されたデータのリストを考えると、この方法はで提供具体的な方法、そのリストを解析し、呼び出し元のプロセスを通過しProfileDatabaseそれが属する参照されるデータを置くためにサブクラス実装を。

詳細
パラメーター
[in] aDataList
参照ReferencedTLVDataのTLV符号化された形態で、目的のデータを含むオブジェクト。
戻り値
WEAVE_NO_ERROR成功しました。それ以外の場合は返すWEAVE_ERROR関心のデータを格納するために失敗したことを示すを。

保護された機能

StoreInternal

WEAVE_ERROR StoreInternal(
  nl::Weave::TLV::TLVReader & aPathReader,
  uint64_t aVersion,
  nl::Weave::TLV::TLVReader & aDataReader
)