nl ::織り::プロファイル:: DataManagement_Legacy :: DMClient
#include <src/lib/profiles/data-management/Legacy/DMClient.h>
アプリケーション固有の WDM クライアントの抽象基本クラス。
概要
DMClientは、標準のWDMクライアントです。実装には、オプションでサブスクリプション/通知が含まれます。これは、DMのミックスですProtocolEngineの途切れがクランク回し処理するクラス、および完全に抽象ClientDataManagerのサブスクリプションに関連する方法のいくつかは、より高い層がそれらを心配する必要がないように実装して、クラス。
サブスクリプション関連のタスクのためのハンドラは、主に上に薄いアダプタとして機能ClientNotifierのオブジェクト。サブクラスの実装者は、サブスクリプションマネージャーのクランクを回すために、関連するスーパークラスのメソッドを呼び出すように注意する必要があります。
DMClientの要求方法は、一般に2人の署名、明示的な宛先ノードIDを有するものと指定された宛先を有する他を持っています。いずれの場合も、パブリッシャーにメッセージを送信する機能は、クライアント内の既存のバインディングに依存しますが、最初のケースでは、宛先IDは、複数のバインドされた宛先から選択することを目的としています。バインディングテーブルのアイテムがデフォルトとして選択されています。これは、たとえば、クライアントが単一の発行元にのみバインドされる場合に役立ちます。
継承
継承元:nl :: Weave :: Profiles :: DataManagement_Legacy :: ProtocolEngine
nl::Weave::Profiles::DataManagement_Legacy::ClientDataManager
コンストラクタとデストラクタ | |
---|---|
DMClient (void) 以下のためのデフォルトコンストラクタDMClientのオブジェクト。 | |
~DMClient (void) デストラクタDMClientのオブジェクト。 |
ViewRequest (const uint64_t & aDestinationId, ReferencedTLVData & aPathList, uint16_t aTxnId, uint32_t aTimeout) | virtual WEAVE_ERROR 公開されたデータの表示を要求します。 |
ViewRequest ( ReferencedTLVData & aPathList, uint16_t aTxnId, uint32_t aTimeout) | virtual WEAVE_ERROR デフォルトのパブリッシャーのデータの表示を要求します。 |
UpdateRequest (const uint64_t & aDestinationId, ReferencedTLVData & aDataList, uint16_t aTxnId, uint32_t aTimeout) | virtual WEAVE_ERROR 公開されたデータの更新をリクエストします。 |
UpdateRequest ( ReferencedTLVData & aDataList, uint16_t aTxnId, uint32_t aTimeout) | virtual WEAVE_ERROR デフォルトのパブリッシャーのデータの更新をリクエストします。 |
保護された属性 | |
---|---|
mUpdatePool [kUpdatePoolSize] | |
mViewPool [kViewPoolSize] |
公の行事 | |
---|---|
CancelTransactionRequest (uint16_t aTxnId, WEAVE_ERROR aError) | 実行中のトランザクションのキャンセルをリクエストします。 |
Clear (void) | virtual void 関連付けられた内部状態クリアDMClientのオブジェクト。 |
Finalize (void) | virtual void オペレーティングシャットダウンDMClientを。 |
IncompleteIndication ( Binding *aBinding, StatusReport & aReport) | virtual void クライアントが使用しているバインディングの「不完全」を処理します。 |
保護された機能 | |
---|---|
NewUpdate (void) | Update * |
NewView (void) | View * |
ViewRequest
virtual WEAVE_ERROR ViewRequest( const uint64_t & aDestinationId, ReferencedTLVData & aPathList, uint16_t aTxnId, uint32_t aTimeout )
公開されたデータの表示を要求します。
指定されたリモートパブリッシャーに存在し、管理されているデータのビューを要求します。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメーター |
| ||||||||
戻り値 |
| ||||||||
戻り値 | それ以外の場合は、 WEAVE_ERRORトランザクションを初期化するか、起動に失敗したことを反映しています。 |
ViewRequest
virtual WEAVE_ERROR ViewRequest( ReferencedTLVData & aPathList, uint16_t aTxnId, uint32_t aTimeout )
デフォルトのパブリッシャーのデータの表示を要求します。
「デフォルト」の発行元、つまりクライアントのバインディングテーブルの最初の(または唯一の)発行元に存在し、管理されているデータのビューを要求します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメーター |
| ||||||
戻り値 |
| ||||||
戻り値 | それ以外の場合は、 WEAVE_ERRORトランザクションを初期化するか、起動に失敗したことを反映しています。 |
UpdateRequest
virtual WEAVE_ERROR UpdateRequest( const uint64_t & aDestinationId, ReferencedTLVData & aDataList, uint16_t aTxnId, uint32_t aTimeout )
公開されたデータの更新をリクエストします。
リモートパブリッシャーに管理下のデータを更新するように要求します。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメーター |
| ||||||||
戻り値 | WEAVE_NO_ERROR成功したかにWEAVE_ERROR_NO_MEMORY更新トランザクションの場合は割り当てられませんでした。そうでない場合、戻りWEAVE_ERROR更新失敗を反映します。 |
UpdateRequest
virtual WEAVE_ERROR UpdateRequest( ReferencedTLVData & aDataList, uint16_t aTxnId, uint32_t aTimeout )
デフォルトのパブリッシャーのデータの更新をリクエストします。
リモートパブリッシャーに管理下のデータを更新するように要求します。このバージョンは、クライアントのデフォルトのバインディングのターゲットであるパブリッシャーにリクエストを送信します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメーター |
| ||||||
戻り値 | WEAVE_NO_ERROR成功したかにWEAVE_ERROR_NO_MEMORY更新トランザクションの場合は割り当てられませんでした。そうでない場合、戻りWEAVE_ERROR更新失敗を反映します。 |
保護された属性
mUpdatePool
Update mUpdatePool[kUpdatePoolSize]
mViewPool
View mViewPool[kViewPoolSize]
公の行事
CancelTransactionRequest
WEAVE_ERROR CancelTransactionRequest( uint16_t aTxnId, WEAVE_ERROR aError )
実行中のトランザクションのキャンセルをリクエストします。
このメソッドはネットワークトラフィックを生成しませんが、指定されたトランザクションに割り当てられたリソースを解放するだけです。
詳細 | |||||
---|---|---|---|---|---|
パラメーター |
| ||||
戻り値 | WEAVE_NO_ERROR成功したかにWEAVE_ERRORトランザクションを取り消すに失敗したことを反映しています。 |
晴れ
virtual void Clear( void )
関連付けられた内部状態クリアDMClientのオブジェクト。
特に、このメソッドはすべてのクライアントトランザクションプールをクリアします。使用されているクライアントの場合はファイナライズ() 、それはまた、サブスクリプションをキャンセルし、トランザクションと結合テーブルをクリーンアップするため、方法が好ましいです。
参照:Finalize()
DMClient
DMClient( void )
ファイナライズ
virtual void Finalize( void )
IncompleteIndication
virtual void IncompleteIndication( Binding *aBinding, StatusReport & aReport )
クライアントが使用しているバインディングの「不完全」を処理します。
バインディングに関連する接続が閉じられた場合など、バインディングが予期せず失敗した場合、このメソッドが呼び出されます。
詳細 | |||||
---|---|---|---|---|---|
パラメーター |
|
〜DMClient
virtual ~DMClient( void )
デストラクタDMClientのオブジェクト。
すべての内部状態をクリアし、必要に応じて保留中のサブスクリプションをキャンセルします。
保護された機能
新しいアップデート
Update * NewUpdate( void )
NewView
View * NewView( void )