Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

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

この名前空間には、廃止されようとしているWeave Data Management(WDM)プロファイルのWeave内のすべてのインターフェイスが含まれます。

概要

列挙

@103 {
kStatus_CancelSuccess = 0x0001,
kStatus_InvalidPath = 0x0013,
kStatus_UnknownTopic = 0x0014,
kStatus_IllegalReadRequest = 0x0015,
kStatus_IllegalWriteRequest = 0x0016,
kStatus_InvalidVersion = 0x0017,
kStatus_UnsupportedSubscriptionMode = 0x0018
}
列挙型
@166 {
kViewPoolSize = WEAVE_CONFIG_WDM_VIEW_POOL_SIZE,
kSubscribePoolSize = WEAVE_CONFIG_WDM_SUBSCRIBE_POOL_SIZE,
kCancelSubscriptionPoolSize = WEAVE_CONFIG_WDM_CANCEL_SUBSCRIPTION_POOL_SIZE,
kUpdatePoolSize = WEAVE_CONFIG_WDM_UPDATE_POOL_SIZE,
kNotifyPoolSize = WEAVE_CONFIG_WDM_NOTIFY_POOL_SIZE,
kTransactionTableSize = WEAVE_CONFIG_WDM_TRANSACTION_TABLE_SIZE,
kBindingTableSize = WEAVE_CONFIG_WDM_BINDING_TABLE_SIZE,
kNotifierTableSize = WEAVE_CONFIG_WDM_NOTIFIER_TABLE_SIZE,
kSubscriptionMgrTableSize = WEAVE_CONFIG_WDM_SUBSCRIPTION_MGR_TABLE_SIZE
}
列挙型
WDMプールとテーブルのサイズ。
@167 {
kMsgType_ViewRequest = 0x10,
kMsgType_ViewResponse = 0x11,
kMsgType_SubscribeRequest = 0x12,
kMsgType_SubscribeResponse = 0x13,
kMsgType_CancelSubscriptionRequest = 0x14,
kMsgType_UpdateRequest = 0x15,
kMsgType_NotifyRequest = 0x16,
kMsgType_ViewRequest_Deprecated = 0x00,
kMsgType_ViewResponse_Deprecated = 0x01,
kMsgType_SubscribeRequest_Deprecated = 0x02,
kMsgType_SubscribeResponse_Deprecated = 0x03,
kMsgType_CancelSubscriptionRequest_Deprecated = 0x04,
kMsgType_UpdateRequest_Deprecated = 0x05,
kMsgType_NotifyRequest_Deprecated = 0x06
}
列挙型
WDMプロファイルメッセージタイプ。
@168 {
kTransactionIdNotSpecified = 0,
kResponseTimeoutNotSpecified = 0,
kVersionNotSpecified = 0xFFFFFFFFFFFFFFFFULL,
kInstanceIdNotSpecified = 0,
kDefaultBindingTableIndex = 0,
kWeaveTLVTagLen = 8,
kWeaveTLVControlByteLen = 1
}
列挙型
その他のWDM固有の定数。
@169 {
kStatus_CancelSuccess = 0x0001,
kStatus_InvalidPath = 0x0013,
kStatus_UnknownTopic = 0x0014,
kStatus_IllegalReadRequest = 0x0015,
kStatus_IllegalWriteRequest = 0x0016,
kStatus_InvalidVersion = 0x0017,
kStatus_UnsupportedSubscriptionMode = 0x0018
}
列挙型
WDM固有のステータスコード。
@170 {
kTag_WDMPathList = 100,
kTag_WDMPathProfile = 101,
kTag_WDMPathProfileId = 1,
kTag_WDMPathProfileInstance = 2,
kTag_WDMPathProfileId_Deprecated = 102,
kTag_WDMPathProfileInstance_Deprecated = 103,
kTag_WDMPathArrayIndexSelector = 104,
kTag_WDMPathArrayValueSelector = 105,
kTag_WDMDataList = 200,
kTag_WDMDataListElementPath = 3,
kTag_WDMDataListElementVersion = 4,
kTag_WDMDataListElementData = 5,
kTag_WDMDataListElementPath_Deprecated = 201,
kTag_WDMDataListElementVersion_Deprecated = 202,
kTag_WDMDataListElementData_Deprecated = 203
}
列挙型
データ管理プロトコルタグ。
@171 {
kTopicIdPublisherSpecificMask = 0xFFFF000000000000ULL,
kTopicIdNotSpecified = 0x0000000000000000ULL,
kAnyTopicId = 0xFFFFFFFFFFFFFFFFULL
}
列挙型
識別されたトピックID。
WeaveTransportOption {
kTransport_TCP = 1,
kTransport_WRMP = 2,
kTransport_UDP = 3
}
列挙型
WDMトランスポートオプション。

Typedef

TopicIdentifier typedef
uint64_t
トピック識別子。

関数

CheckTLVType ( nl::Weave::TLV::TLVType aType,nl::Weave::TLV::TLVReader & aReader)
bool
ていることを確認TLVの要素で読み取りが予想持つTLVのタイプを。
CheckWDMTag (uint32_t aTagNum,nl::Weave::TLV::TLVReader & aReader)
bool
WDM固有のタグを確認してください。
CloseDataListElement (nl::Weave::TLV::TLVReader & aReader)
WDMデータリスト要素の読み取りを停止します。
CloseList (nl::Weave::TLV::TLVReader & aReader)
WDM パスまたはデータ リストの読み取りを停止します。
EncodeDeprecatedPath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ...)
非推奨のタグと整数のインスタンスIDを使用してWDMパスをエンコードします。
EncodeDeprecatedPath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ...)
非推奨のタグと文字列インスタンスIDを使用してWDMパスをエンコードします。
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ...)
整数のプロファイル インスタンス ID で WDM パスをエンコードします。
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint32_t aInstanceIdLen, const uint8_t *aInstanceId, uint32_t aPathLen, ...)
バイト配列インスタンスIDを使用してWDMパスをエンコードします。
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ...)
文字列インスタンスIDを使用してWDMパスをエンコードします。
EndDataListElement (nl::Weave::TLV::TLVWriter & aWriter)
データリスト要素の書き込みを終了します。
EndEncodePath (TLVWriter & aWriter, TLVType & mOuterContainer, WEAVE_ERROR mError)
EndList (nl::Weave::TLV::TLVWriter & aWriter)
パスリストまたはデータリストの作成を終了します。
EndList ( ReferencedTLVData & aList,nl::Weave::TLV::TLVWriter & aWriter)
パスリストまたはデータリストの作成を終了します。
IsPublisherSpecific (const TopicIdentifier & aTopicId)
bool
トピックIDが発行者固有であるかどうかを確認します。
OpenDataList ( ReferencedTLVData & aDataList,nl::Weave::TLV::TLVReader & aReader)
データリストの読み取りを開始します。
OpenDataListElement (nl::Weave::TLV::TLVReader & aReader,nl::Weave::TLV::TLVReader & aPathReader, uint64_t & aVersion)
データリスト要素の読み取りを開始します。
OpenPathList ( ReferencedTLVData & aPathList,nl::Weave::TLV::TLVReader & aReader)
パスリストの読み取りを開始します。
PublisherSpecificTopicId (void)
パブリッシャー固有のトピックIDを最初から生成します。
SendStatusReport ( ExchangeContext *aExchangeCtx, StatusReport & aStatus)
StartDataList (nl::Weave::TLV::TLVWriter & aWriter)
データリストの作成を開始します。
StartDataList ( ReferencedTLVData & aDataList,nl::Weave::TLV::TLVWriter & aWriter)
与えられたにデータリストを書き始めるReferencedTLVDataのオブジェクト。
StartDataListElement (nl::Weave::TLV::TLVWriter & aWriter)
データリスト要素の書き込みを開始します。
StartEncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, TLVType & mOuterContainer, TLVType & mPath)
StartPathList (nl::Weave::TLV::TLVWriter & aWriter)
パスリストの作成を開始します。
TxnResponseHandler ( ExchangeContext *anExchangeCtx, const IPPacketInfo *anAddrInfo, const WeaveMessageInfo *aMsgInfo, uint32_t aProfileId, uint8_t aMsgType, PacketBuffer *aMsg)
void
TxnTimeoutHandler ( ExchangeContext *anExchangeCtx)
void
ValidateTLVType ( nl::Weave::TLV::TLVType aType,nl::Weave::TLV::TLVReader & aReader)
ことを検証TLVの要素で読み取りが予想持つTLVのタイプを。
ValidateWDMTag (uint32_t aTagNum,nl::Weave::TLV::TLVReader & aReader)
ことを検証TLVの要素である読出しが期待WDMタグを有しています。

クラス

NL ::織り::プロファイル:: DataManagement_Legacy ::バインディング

バインディングクラスは、織りを使用して、アプリケーション・エンティティに代わって通信状態を管理します。

NL ::織り::プロファイル:: DataManagement_Legacy :: ClientDataManager

WDMクライアントに必要な確認および指示メソッド定義を含む抽象クラス。

NL ::織り::プロファイル:: DataManagement_Legacy :: ClientNotifier

WDMクライアントでサブスクリプションと通知のサポートが必要な場合に使用される補助クラス。

NL ::織り::プロファイル:: DataManagement_Legacy :: DMClient

アプリケーション固有のWDMクライアントの抽象基本クラス。

NL ::織り::プロファイル:: DataManagement_Legacy :: DMPublisher

アプリケーション固有のWDMパブリッシャーの抽象基本クラス。

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

抽象ProfileDatabase補助クラス。

NL ::織り::プロファイル:: DataManagement_Legacy :: ProtocolEngine

WDMプロトコルエンジンクラス。

NL ::織り::プロファイル:: DataManagement_Legacy :: PublisherDataManager

WDMパブリッシャーが必要とする確認および通知メソッド定義を含む抽象クラス。

列挙

@ 103

 @103
プロパティ
kStatus_CancelSuccess

このレガシー ステータス コードは、サブスクリプションが正常にキャンセルされたことを意味します。

このステータスコードは、サブスクリプションが正常にキャンセルされたことを意味します。

kStatus_IllegalReadRequest

このレガシー ステータス コードは、特定のデータ アイテムの読み取りを要求するノードに読み取り権限がないことを意味します。

このステータスコードは、特定のデータ項目の読み取りを要求しているノードに、そのためのアクセス許可がないことを意味します。

kStatus_IllegalWriteRequest

このレガシーステータスコードは、特定のデータ項目の書き込みを要求するノードにその権限がないことを意味します。

このステータスコードは、特定のデータ項目の書き込みを要求しているノードに、書き込みを行う権限がないことを意味します。

kStatus_InvalidPath

このレガシーステータスコードは、ビューまたは更新要求フレームのパスリストからのパスがレスポンダーのノード常駐スキーマと一致しなかったことを意味します。

このステータスコードは、ビューまたは更新要求フレームのパスリストからのパスがレスポンダーのノード常駐スキーマと一致しなかったことを意味します。

kStatus_InvalidVersion

このレガシーステータスコードは、更新リクエストに含まれるデータのバージョンがパブリッシャーの最新バージョンと一致しなかったため、更新を適用できなかったことを意味します。

このステータスコードは、更新リクエストに含まれるデータのバージョンが発行元の最新バージョンと一致しなかったため、更新を適用できなかったことを意味します。

kStatus_UnknownTopic

このレガシーステータスコードは、キャンセル要求または通知で指定されたトピック識別子が、受信ノードに存在するサブスクリプションと一致しなかったことを意味します。

このステータスコードは、キャンセル要求または通知で指定されたトピック識別子が、受信ノードに存在するサブスクリプションと一致しなかったことを意味します。

kStatus_UnsupportedSubscriptionMode

このレガシーステータスコードは、要求されたサブスクリプションモードが受信デバイスでサポートされていないことを意味します。

このステータスコードは、要求されたサブスクリプションモードが受信デバイスでサポートされていないことを意味します。

@ 166

 @166

WDMプールとテーブルのサイズ。

WDMは、その操作に必要なさまざまなプールとテーブルを次のように定義します。

クライアントトランザクションプール:

  • kViewPoolSize
  • kSubscribePoolSize
  • kCancelSubscriptionPoolSize
  • kUpdatePoolSize

パブリッシャートランザクションプール:

  • kNotifyPoolSize

プロトコルエンジンテーブル:

  • kTransactionTableSize
  • kBindingTableSize

サブスクリプション関連のテーブル:

  • kNotifierTableSize(クライアントのみ)
  • kSubscriptionMgrTableSize (発行者のみ)

これらは設定量であること、およびプラットフォームごとの値は、関連で現れることに留意されたいWeaveConfig.h

プロパティ
kBindingTableSize

これは、WDMプロトコルエンジンのバインディングテーブルのデフォルトサイズです。

この値を介して構成されてもよいWEAVE_CONFIG_WDM_BINDING_TABLE_SIZE

kCancelSubscriptionPoolSize

これは、WDMクライアントのサブスクリプションキャンセル要求トランザクションプールのデフォルトサイズです。

この値を介して構成されてもよいWEAVE_CONFIG_WDM_CANCEL_SUBSCRIPTION_POOL_SIZE

kNotifierTableSize

これは、WDMクライアントの通知テーブルのデフォルトサイズです。

この値を介して構成されてもよいWEAVE_CONFIG_WDM_NOTIFIER_TABLE_SIZE

kNotifyPoolSize

これは、WDMパブリッシャーの通知要求トランザクションプールのデフォルトサイズです。

この値を介して構成されてもよいWEAVE_CONFIG_WDM_NOTIFY_POOL_SIZE

kSubscribePoolSize

これは、WDMクライアントのサブスクライブ要求トランザクションプールのデフォルトサイズです。

この値を介して構成されてもよいWEAVE_CONFIG_WDM_SUBSCRIBE_POOL_SIZE

kSubscriptionMgrTableSize

これは、WDMパブリッシャーのサブスクリプションテーブルのデフォルトサイズです。

この値を介して構成されてもよいWEAVE_CONFIG_WDM_SUBSCRIPTION_MGR_TABLE_SIZE

kTransactionTableSize

これは、WDMプロトコルエンジンのトランザクションテーブルのデフォルトサイズです。

この値を介して構成されてもよいWEAVE_CONFIG_WDM_TRANSACTION_TABLE_SIZE

kUpdatePoolSize

これは、WDMクライアントの更新要求トランザクションプールのデフォルトサイズです。

この値を介して構成されてもよいWEAVE_CONFIG_WDM_UPDATE_POOL_SIZE

kViewPoolSize

これは、WDMクライアントのビュー要求トランザクションプールのデフォルトサイズです。

この値を介して構成されてもよいWEAVE_CONFIG_WDM_VIEW_POOL_SIZE

@ 167

 @167

WDMプロファイルメッセージタイプ。

これらの値は、データ管理仕様で呼び出されます。

注意!! 2015年第1四半期の時点で、以前のバージョンのWDMで使用されていたメッセージタイプは非推奨になり、新しいメッセージタイプが定義されました。これは、クリーンブレークを正当化するための過去のパッキングと解析の詳細による十分なシフトを反映しています。

プロパティ
kMsgType_CancelSubscriptionRequest

サブスクリプションリクエストメッセージをキャンセルします。

kMsgType_CancelSubscriptionRequest_Deprecated

非推奨

kMsgType_NotifyRequest

リクエストメッセージを通知します。

kMsgType_NotifyRequest_Deprecated

非推奨

kMsgType_SubscribeRequest

サブスクライブ要求メッセージ。

kMsgType_SubscribeRequest_Deprecated

非推奨

kMsgType_SubscribeResponse

応答メッセージをサブスクライブします。

kMsgType_SubscribeResponse_Deprecated

非推奨

kMsgType_UpdateRequest

更新要求メッセージ。

kMsgType_UpdateRequest_Deprecated

非推奨

kMsgType_ViewRequest

リクエストメッセージを表示します。

kMsgType_ViewRequest_Deprecated

非推奨

kMsgType_ViewResponse

応答メッセージを表示します。

kMsgType_ViewResponse_Deprecated

非推奨

@ 168

 @168

その他の WDM 固有の定数。

プロパティ
kDefaultBindingTableIndex

複数のエントリを持つプロトコルエンジンバインディングテーブルのデフォルトバインディングのインデックス。

kInstanceIdNotSpecified

プロファイルインスタンスの指定が必要な呼び出しでは、「なし」を示します。

ほとんどの場合、これは、プロファイルのインスタンスが1つだけ問題のエンティティに存在することを意味します。

kResponseTimeoutNotSpecified

トランザクションを要求するメソッドで、呼び出し元がタイムアウトの指定を拒否したことを示します。

通常、これはデフォルトを使用する必要があることを意味します。

kTransactionIdNotSpecified

トランザクションIDを受け取るメソッドおよびデータ構造では、「なし」またはワイルドカード値を示します。

kVersionNotSpecified

データバージョンの指定が必要な呼び出しでは、「特定のバージョンなし」を示します。

kWeaveTLVControlByteLen

長さのTLVでエンコードWDM構造ことを支援方法において使用される制御バイト、 TLV

kWeaveTLVTagLen

完全修飾のバイト単位の標準長さのTLVでエンコードWDM構造ことを支援方法において使用されるタグ、 TLV

@ 169

 @169

WDM固有のステータスコード。

プロパティ
kStatus_CancelSuccess

このレガシー ステータス コードは、サブスクリプションが正常にキャンセルされたことを意味します。

このステータスコードは、サブスクリプションが正常にキャンセルされたことを意味します。

kStatus_IllegalReadRequest

このレガシーステータスコードは、特定のデータ項目の読み取りを要求するノードにその権限がないことを意味します。

このステータスコードは、特定のデータ項目の読み取りを要求しているノードに、そのためのアクセス許可がないことを意味します。

kStatus_IllegalWriteRequest

このレガシーステータスコードは、特定のデータ項目の書き込みを要求するノードにその権限がないことを意味します。

このステータスコードは、特定のデータ項目の書き込みを要求しているノードに、書き込みを行う権限がないことを意味します。

kStatus_InvalidPath

このレガシーステータスコードは、ビューまたは更新要求フレームのパスリストからのパスがレスポンダーのノード常駐スキーマと一致しなかったことを意味します。

このステータスコードは、ビューまたは更新要求フレームのパスリストからのパスがレスポンダーのノード常駐スキーマと一致しなかったことを意味します。

kStatus_InvalidVersion

この従来のステータス コードは、更新要求に含まれるデータのバージョンが発行元の最新バージョンと一致していないため、更新を適用できなかったことを意味します。

このステータスコードは、更新リクエストに含まれるデータのバージョンが発行元の最新バージョンと一致しなかったため、更新を適用できなかったことを意味します。

kStatus_UnknownTopic

このレガシーステータスコードは、キャンセルリクエストまたは通知で指定されたトピック識別子が、受信ノードに存在するサブスクリプションと一致しなかったことを意味します。

このステータスコードは、キャンセル要求または通知で指定されたトピック識別子が、受信ノードに存在するサブスクリプションと一致しなかったことを意味します。

kStatus_UnsupportedSubscriptionMode

このレガシーステータスコードは、要求されたサブスクリプションモードが受信デバイスでサポートされていないことを意味します。

このステータス コードは、要求されたサブスクリプション モードが受信側デバイスでサポートされていないことを意味します。

@ 170

 @170

データ管理プロトコルタグ。

データ管理プロトコルは、タグの数に使用される定義TLVのプロファイルデータの表現。

いつものように、新しいWDMと古いWDMの間には互換性の問題があります。古き良き時代には、これらのタグはすべてプロファイル固有として適用されていたため、スペースが無駄になりました。現在、可能な場合はコンテキストタグを使用していますが、必要に応じて古いタグを保持する必要があります(また、パスをエンコードするメカニズムが必要です)。

kTag_WDMDataListElementDataタグは以前のリリースでは使用されておらず、コードによって完全に無視されていたため、非推奨のバージョンを提供する必要はありません。

プロパティ
kTag_WDMDataList

要素は、パス、オプションのバージョン、およびデータ要素を含む構造のリストです。

タグタイプ:プロファイル固有の要素タイプ:配列配置:トップレベル

kTag_WDMDataListElementData

この要素は、指定されたパスが指し、指定されたバージョンを持つデータを表します。

タグタイプ:コンテキスト固有の要素タイプ:任意の処理:必須

kTag_WDMDataListElementData_Deprecated

非推奨。

タグタイプ:コンテキスト固有の要素タイプ:任意の処理:必須

kTag_WDMDataListElementPath

この要素は、データリスト要素のパスコンポーネントです。

タグの種類: コンテキスト固有の要素の種類: パスの配置: 必須

kTag_WDMDataListElementPath_Deprecated

非推奨。

タグタイプ:プロファイル固有の要素タイプ:パス処理:必須

kTag_WDMDataListElementVersion

この要素は、データリスト要素のバージョンコンポーネントです。

タグ タイプ: コンテキスト固有 エレメント タイプ: 整数 ディスポジション: 必須

kTag_WDMDataListElementVersion_Deprecated

非推奨。

タグタイプ:プロファイル固有の要素タイプ:整数配置:必須

kTag_WDMPathArrayIndexSelector

path要素はスキーマ内の配列に対応し、含まれている整数要素はその配列へのインデックスとして使用されます。

タグタイプ:プロファイル固有の要素タイプ:整数配置:オプション

kTag_WDMPathArrayValueSelector

path要素はスキーマ内の配列に対応し、カプセル化された要素はレコードセレクターとして使用されます。

タグタイプ:プロファイル固有の要素タイプ:構造配置:オプション

kTag_WDMPathList

要素がリストであるTLVのパス。

タグタイプ:プロファイル固有の要素タイプ:配列配置:トップレベル

kTag_WDMPathProfile

この要素は、パスを開始するために使用される構造であり、パス内のタグが解釈されるプロファイル情報が含まれています。

タグタイプ:プロファイル固有の要素タイプ:構造配置:必須

kTag_WDMPathProfileId

要素が始まるパスプロファイル要素のプロファイルIDの構成要素であるTLVのパス。

タグタイプ:コンテキスト固有の要素タイプ:整数配置:必須

kTag_WDMPathProfileId_Deprecated

非推奨。

タグタイプ:プロファイル固有の要素タイプ:整数配置:必須

kTag_WDMPathProfileInstance

要素は、プロファイルIDをたどることができるプロファイルインスタンスであり、 TLVのパス。

ノードには特定のプロファイルの複数のインスタンスがある場合とない場合があり、1つしかない場合は、この要素を省略できることに注意してください。

タグタイプ:コンテキスト固有の要素タイプ:任意の配置:オプション

kTag_WDMPathProfileInstance_Deprecated

非推奨。

タグタイプ:プロファイル固有の要素タイプ:任意の配置:オプション

@ 171

 @171

識別されたトピックID。

関心のある3つの区別されたトピックIDがあり、3つすべてが「発行者固有」としてフォーマットされています。

プロパティ
kAnyTopicId

これはワイルドカードトピックIDとして予約されています。

kTopicIdNotSpecified

これは、無効またはワイルドカードのトピックIDを表すために予約されている特別な値です。

kTopicIdPublisherSpecificMask

これは、topciIDを作成または分解するためのマスクとして使用されます。

WeaveTransportOption

 WeaveTransportOption

WDMトランスポートオプション。

これらは、WDM の相互に排他的なトランスポート オプションです。

プロパティ
kTransport_TCP

基盤となるトランスポートはTCPです。

バインディングは、サービスマネージャーを使用するか、メッセージレイヤーを直接使用して完了することができます。

kTransport_UDP

基盤となるトランスポートはUDPのみです。

kTransport_WRMP

基盤となるトランスポートはUDPのみですが、「アプリケーションサポートレイヤー」の信頼性が強化されています。

Typedef

TopicIdentifier

uint64_t TopicIdentifier

トピック識別子。

トピック識別子は64ビットの数量であり、2つの関連する用途/セマンティクスがあります。まず第一に、それらは、「ネスト煙探知器」などのよく知られた一連のパスの従来の省略形として使用できます。この方法で使用されるトピックIDには、プロファイルIDと同様に、次のように、異なるベンダーによって自律的に選択されたトピックIDが競合しないようにするベンダーコードが含まれている必要があります。

ビット48-63ビット0〜47
ベンダーIDトピック番号
トピック識別子の2番目の使用/セマンティクスは、WDMクライアントとパブリッシャー間の動的サブスクリプションの場合に発生します。この場合、発行者は常に特定のサブスクリプションを表す一意のトピックIDを提供する必要があり、既知のトピックIDまたは任意のパスリストを使用してサブスクリプションが要求されたかどうかに関係なくこれを行います。この形式のトピック識別子は、ベンダーコードが0xFFFFであることによって区別されます。

参照:
WeaveVendorIdentifiers.hpp

関数

CheckTLVType

bool CheckTLVType(
  nl::Weave::TLV::TLVType aType,
  nl::Weave::TLV::TLVReader & aReader
)

ていることを確認TLVの要素で読み取りが予想持つTLVのタイプを。

所与チェックTLVの先頭の要素タイプに対するタイプをTLVのリーダ。

詳細
パラメーター
[in] aType
特定の要素に対してチェックされる TLVType
[in] aReader
参照TLVをチェックする要素に配置リーダー
戻り値
要素のTLVTypeとaTypeが一致する場合はtrue。
参照:
WeaveTLVTypes.h

CheckWDMTag

bool CheckWDMTag(
  uint32_t aTagNum,
  nl::Weave::TLV::TLVReader & aReader
)

WDM固有のタグを確認してください。

先頭の実際のタグに対して、データ管理/ DMConstants.h ... /から、WDM固有のタグの数を確認TLVのリーダ。

詳細
パラメーター
[in] aTagNum
具体的に照らしてチェックするタグ番号TLVの要素。
[in] aReader
参照TLVをチェックする要素を指すリーダー。
戻り値
true iff aReader.GetTag()は、指定されたタグ番号に対して予想されるタグ形式の1つに一致するタグを生成します。

CloseDataListElement

WEAVE_ERROR CloseDataListElement(
  nl::Weave::TLV::TLVReader & aReader
)

WDMデータリスト要素の読み取りを停止します。

このメソッドは、問題の要素がWDMデータリストの一部であると想定しているため、kTLVType_ArrayをExitContainer()に渡します。

詳細
パラメーター
[in,out] aReader
TLVのリーダは、WDMデータリスト要素内に配置されます。
戻り値
WEAVE_NO_ERROR成功しました。そうでない場合に返すWEAVE_ERROR容器を出ることができないことを反映します。

CloseList

WEAVE_ERROR CloseList(
  nl::Weave::TLV::TLVReader & aReader
)

WDMパスまたはデータリストの読み取りを停止します。

この方法は、問題のリストが最上位であることを前提としてTLVの要素など()ExitContainerにkTLVType_Sructureを渡します。

詳細
パラメーター
[in,out] aReader
TLVのリーダーは、WDMパスまたはデータリストに配置されます。
戻り値
WEAVE_NO_ERROR成功しました。そうでない場合に返すWEAVE_ERROR容器を出ることができないことを反映します。

EncodeDeprecatedPath

WEAVE_ERROR EncodeDeprecatedPath(
  TLVWriter & aWriter,
  const uint64_t & aTag,
  uint32_t aProfileId,
  const uint64_t & aInstanceId,
  uint32_t aPathLen,
  ...
)

非推奨のタグと整数のインスタンスIDを使用してWDMパスをエンコードします。

注:エンコード織りリリース2.0の前にサービスによって受け入れられる非推奨タグセットを使用してパス。このバージョンのメソッドは、数値のインスタンス識別子を取ります。このメソッドは、ProfileTag(kWeaveProfile_WDM、kTag_WDMPathProfile)でコンテナーを開始し、次にProfileTag(kWeaveProfile_WDM、kTag_WDMPathProfileId_Deprecated)でプロファイルIDを挿入します。次に、ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileInstance_Deprecated) でインスタンス ID を挿入します。これは、パスをエンコードするための非推奨バージョンの1つであり、新しいデザインではこの形式の使用を避ける必要があります。

詳細
パラメーター
[in] aWriter
参照TLVのパスを書き出すために使用されるライター。
[in] aTag
完全修飾参照TLVのこのパスに適用されるタグ。
[in] aProfileId
パスの要素が解釈されるプロファイルID。
[in] aInstanceId
使用するプロファイルのオプションのインスタンスIDへの参照。
[in] aPathLen
最初のプロファイル指定子を超えるパス要素のリストの長さ(場合によっては0)。
[in] ...
追加のパスタグのオプションの可変長リスト。
戻り値
WEAVE_NO_ERROR成功しました。そうでない場合に返すWEAVE_ERROR与えられたパスをフォーマットすることができないことを反映します。

EncodeDeprecatedPath

WEAVE_ERROR EncodeDeprecatedPath(
  TLVWriter & aWriter,
  const uint64_t & aTag,
  uint32_t aProfileId,
  const char *aInstanceId,
  uint32_t aPathLen,
  ...
)

非推奨のタグと文字列インスタンスIDを使用してWDMパスをエンコードします。

注:エンコード非推奨タグセットを使用してパス(DMConstants.hを参照)。このバージョンのメソッドは、インスタンスID文字列を取ります。このメソッドは、ProfileTag(kWeaveProfile_WDM、kTag_WDMPathProfile)でコンテナーを開始し、次にProfileTag(kWeaveProfile_WDM、kTag_WDMPathProfileId_Deprecated)でプロファイルIDを挿入します。次に、ProfileTag(kWeaveProfile_WDM、kTag_WDMPathProfileInstance_Deprecated)を使用してインスタンスIDを挿入します。これは、パスをエンコードするための非推奨バージョンの1つであり、新しいデザインではこの形式の使用を避ける必要があります。

詳細
パラメーター
[in] aWriter
参照TLVのパスを書き出すために使用されるライター。
[in] aTag
完全修飾参照TLVのこのパスに適用されるタグ。
[in] aProfileId
パスの要素が解釈されるプロファイルID。
[in] aInstanceId
プロファイルインスタンス識別子として使用されるオプションの文字列。インスタンスIDが指定されていない場合、この引数はNULLになる可能性があります。
[in] aPathLen
初期プロファイル指定子を超えるパス要素のリストの長さ (場合によっては 0)。
[in] ...
追加のパスタグのオプションの可変長リスト。
戻り値
WEAVE_NO_ERROR成功しました。そうでない場合に返すWEAVE_ERROR与えられたパスをフォーマットすることができないことを反映します。

EncodePath

WEAVE_ERROR EncodePath(
  TLVWriter & aWriter,
  const uint64_t & aTag,
  uint32_t aProfileId,
  const uint64_t & aInstanceId,
  uint32_t aPathLen,
  ...
)

整数プロファイルインスタンスIDを使用してWDMパスをエンコードします。

注:書き込みのTLV特に、後続のパス要素の解釈を可能にするために最初に配置されたプロファイルの指定があると、データの管理に使用される種類の経路。このバージョンのメソッドは、整数のプロファイルインスタンスIDを取ります。

このメソッドは、パスをエンコードするための最新バージョンであるContextTag(kTag_WDMPathProfileInstance)を使用してインスタンスIDを挿入します。

詳細
パラメーター
[in] aWriter
参照TLVのパスを書き出すために使用されるライター。
[in] aTag
完全修飾参照TLVのこのパスに適用されるタグ。
[in] aProfileId
パスの要素が解釈されるプロファイル ID。
[in] aInstanceId
使用するプロファイルのオプションのインスタンス識別子への参照。インスタンス ID を使用しない場合、このパラメーターの値は kInstanceIdNotSpecified である必要があります。
[in] aPathLen
最初のプロファイル指定子を超えるパス要素のリストの長さ(場合によっては0)。
[in] ...
追加のパスタグのオプションの可変長リスト。
戻り値
WEAVE_NO_ERROR成功しました。そうでない場合に返すWEAVE_ERROR与えられたパスをフォーマットすることができないことを反映します。

EncodePath

WEAVE_ERROR EncodePath(
  TLVWriter & aWriter,
  const uint64_t & aTag,
  uint32_t aProfileId,
  const uint32_t aInstanceIdLen,
  const uint8_t *aInstanceId,
  uint32_t aPathLen,
  ...
)

バイト配列インスタンスIDを使用してWDMパスをエンコードします。

注:書き込みのTLV特に、後続のパス要素の解釈を可能にするために最初に配置されたプロファイルの指定があると、データの管理に使用される種類の経路。このバージョンのメソッドは、バイト配列プロファイルのインスタンスIDと長さを取ります。

このメソッドは、パスをエンコードするための最新バージョンであるContextTag(kTag_WDMPathProfileInstance)を使用してインスタンスIDを挿入します。

詳細
パラメーター
[in] aWriter
参照TLVのパスを書き出すために使用されるライター。
[in] aTag
完全修飾参照TLVのこのパスに適用されるタグ。
[in] aProfileId
パスの要素が解釈されるプロファイルID。
[in] aInstanceIdLen
インスタンスIDを構成するバイト配列の長さ。 IDがない場合、このパラメーターの値は0でなければなりません。
[in] aInstanceId
プロファイルインスタンス識別子として使用されるオプションのバイト配列。インスタンス ID が指定されていない場合、この引数は NULL である可能性があります。
[in] aPathLen
最初のプロファイル指定子を超えるパス要素のリストの長さ(場合によっては0)。
[in] ...
追加のパスタグのオプションの可変長リスト。
戻り値
WEAVE_NO_ERROR成功しました。そうでない場合に返すWEAVE_ERROR与えられたパスをフォーマットすることができないことを反映します。

EncodePath

WEAVE_ERROR EncodePath(
  TLVWriter & aWriter,
  const uint64_t & aTag,
  uint32_t aProfileId,
  const char *aInstanceId,
  uint32_t aPathLen,
  ...
)

文字列インスタンスIDを使用してWDMパスをエンコードします。

注:書き込みのTLV特に、後続のパス要素の解釈を可能にするために最初に配置されたプロファイルの指定があると、データの管理に使用される種類の経路。このバージョンのメソッドは、文字列プロファイルインスタンスIDを取ります。

このメソッドは、パスをエンコードするための最新バージョンであるContextTag(kTag_WDMPathProfileInstance)を使用してインスタンスIDを挿入します。

詳細
パラメーター
[in] aWriter
参照TLVのパスを書き出すために使用されるライター。
[in] aTag
完全修飾参照TLVのこのパスに適用されるタグ。
[in] aProfileId
パスの要素が解釈されるプロファイルID。
[in] aInstanceId
プロファイルインスタンス識別子として使用されるオプションの文字列。インスタンスIDが指定されていない場合、この引数はNULLになる可能性があります。
[in] aPathLen
最初のプロファイル指定子を超えるパス要素のリストの長さ(場合によっては0)。
[in] ...
追加のパスタグのオプションの可変長リスト。
戻り値
WEAVE_NO_ERROR成功しました。そうでない場合に返すWEAVE_ERROR与えられたパスをフォーマットすることができないことを反映します。

EndDataListElement

WEAVE_ERROR EndDataListElement(
  nl::Weave::TLV::TLVWriter & aWriter
)

データリスト要素の書き込みを終了します。

書くTLVをWDMデータリスト要素の終わりのために。これは、常にリストアイテムを閉じていると想定して、kTLVType_ArrayのタイプをEndContainer()呼び出しに自動的に渡すことに注意してください。

詳細
パラメーター
[in] aWriter
参照TLVのアイテムの端を書き込むとともにライター。
戻り値
WEAVE_NO_ERROR成功しました。そうでない場合に返すWEAVE_ERROR容器を終了することができないことを反映します。

EndEncodePath

WEAVE_ERROR EndEncodePath(
  TLVWriter & aWriter,
  TLVType & mOuterContainer,
  WEAVE_ERROR mError
)

EndList

WEAVE_ERROR EndList(
  nl::Weave::TLV::TLVWriter & aWriter
)

パスリストまたはデータリストの作成を終了します。

書くTLVをWDMパスまたはデータリストの末尾のために。また、ライターを完成させます。

詳細
パラメーター
[in,out] aWriter
参照TLVのリストの最後を書き込むとライター。
戻り値
WEAVE_NO_ERROR成功しました。そうでない場合に返すWEAVE_ERROR容器を終了することができないことを反映します。

EndList

WEAVE_ERROR EndList(
  ReferencedTLVData & aList,
  nl::Weave::TLV::TLVWriter & aWriter
)

パスリストまたはデータリストの作成を終了します。

書くTLVをWDMパスまたはデータリストの末尾のために。また、ライターを完成させます。この場合、 ReferencedTLVDataされたオブジェクトTLVが書かれているが渡されたと書かれたデータの量を反映するように修正されます。

詳細
パラメーター
[in,out] aList
リストが書き込まれていたReferenceTLVDataオブジェクトへの参照。
[in] aWriter
参照TLVのリストの最後を書き込むとライター。
戻り値
WEAVE_NO_ERROR成功しました。そうでない場合に返すWEAVE_ERROR容器を終了することができないことを反映します。

IsPublisherSpecific

bool IsPublisherSpecific(
  const TopicIdentifier & aTopicId
)

トピックIDが発行者固有であるかどうかを確認します。

詳細
パラメーター
[in] aTopicId
チェックのトピック識別子
戻り値
トピックIDが発行者固有の場合はtrue、それ以外の場合はfalse

OpenDataList

WEAVE_ERROR OpenDataList(
  ReferencedTLVData & aDataList,
  nl::Weave::TLV::TLVReader & aReader
)

データリストの読み取りを開始します。

新しいリーダーとデータリストが与えられたら、リストの読み取りを開始し、プロセスで最初に検出されたタグとタイプを検証します。すべてがうまくいけば、リストコンテナが入力された後、リーダーは停止します。

詳細
パラメーター
[in] aDataList
参照として渡されたデータのリストReferencedTLVDataのオブジェクト。通常の使用例は、リストが受信後も実際にバッファ内にある場合です。
[out] aReader
参照のTLVデータのリストを読み取るために使用されるリーダー。このリーダーは、リストの最初の項目の直前を指したままになります。
戻り値
WEAVE_NO_ERROR成功しました。そうしないと返すWEAVE_ERRORデータリストを開き、および/または関連するタグや種類を検証し、障害を反映します。

OpenDataListElement

WEAVE_ERROR OpenDataListElement(
  nl::Weave::TLV::TLVReader & aReader,
  nl::Weave::TLV::TLVReader & aPathReader,
  uint64_t & aVersion
)

データリスト要素の読み取りを開始します。

データリスト要素に配置されたリーダーを前提として、要素の読み取りを開始し、プロセスで最初に検出されたタグとタイプを検証します。すべてがうまくいけば、リーダーはデータ要素データに配置され、入力/出力パスリーダーは対応するパスに配置されます。

詳細
パラメーター
[in] aReader
参照のTLVデータリスト要素に配置リーダー。
[out] aPathReader
参照のTLVデータリスト要素の経路の成分で指摘されるリーダー。
[out] aVersion
データリスト要素のバージョン(存在する場合)またはkVersionNotSpecifiedに設定される64ビット整数への参照。
戻り値
WEAVE_NO_ERROR成功または他のWEAVE_ERRORデータリスト要素を開き、読みに関連付けられています。

OpenPathList

WEAVE_ERROR OpenPathList(
  ReferencedTLVData & aPathList,
  nl::Weave::TLV::TLVReader & aReader
)

パスリストの読み取りを開始します。

新しいリーダーとパスリストが与えられたら、リストの読み取りを開始し、プロセスで最初に検出されたタグとタイプを検証します。すべてがうまくいけば、リストコンテナが入力された後、リーダーは停止します。

詳細
パラメーター
[in] aPathList
参照として渡されたパスリストReferencedTLVDataのオブジェクト。通常の使用例は、リストが受信後も実際にバッファ内にある場合です。
[out] aReader
参照TLVのリーダーは、パスリストを読み取るために使用されます。このリーダーは、リストの最初のパスの直前を指したままになります。
戻り値
WEAVE_NO_ERROR成功した場合に、そうでない場合、 WEAVE_ERROR障害を反映し、パスリストを開き、および/または関連するタグとタイプを検証します。

PublisherSpecificTopicId

TopicIdentifier PublisherSpecificTopicId(
  void
)

パブリッシャー固有のトピックIDを最初から生成します。

詳細
戻り値
新しいトピック識別子。

SendStatusReport

WEAVE_ERROR SendStatusReport(
  ExchangeContext *aExchangeCtx,
  StatusReport & aStatus
)

StartDataList

WEAVE_ERROR StartDataList(
  nl::Weave::TLV::TLVWriter & aWriter
)

データリストの作成を開始します。

書くTLVをUpdateRequestの第一引数としてWDMデータリストの先頭に、例えばのために()。

詳細
パラメーター
[in] aWriter
参照TLVの書き込みを開始するとライター。
戻り値
WEAVE_NO_ERROR成功しました。それ以外の場合は返すWEAVE_ERRORコンテナを起動できないことを反映し。

StartDataList

WEAVE_ERROR StartDataList(
  ReferencedTLVData & aDataList,
  nl::Weave::TLV::TLVWriter & aWriter
)

与えられたにデータリストを書き始めるReferencedTLVDataのオブジェクト。

書くTLVをWDMデータリストの先頭のために。この場合、我々は、参照するデータのリストを書いていることを前提とTLVのデータ構造。ライターは初期化されていないと見なされます。または、いずれの場合も、指定されたオブジェクトを指すように初期化されます。

詳細
パラメーター
[out] aDataList
参照ReferencedTLVDataの作家の標的となり、最終的に関心のデータが含まれているオブジェクト。
[in] aWriter
参照TLVの書き込みを開始するとライター。
戻り値
WEAVE_NO_ERROR成功しました。それ以外の場合は返すWEAVE_ERRORコンテナを起動できないことを反映し。

StartDataListElement

WEAVE_ERROR StartDataListElement(
  nl::Weave::TLV::TLVWriter & aWriter
)

データリスト要素の書き込みを開始します。

書くTLVをWDMデータリスト要素の始まりのために。

詳細
パラメーター
[in] aWriter
参照TLVの書き込みを開始するとライター。
戻り値
WEAVE_NO_ERROR成功しました。それ以外の場合は返すWEAVE_ERRORコンテナを起動できないことを反映し。

StartEncodePath

WEAVE_ERROR StartEncodePath(
  TLVWriter & aWriter,
  const uint64_t & aTag,
  uint32_t aProfileId,
  TLVType & mOuterContainer,
  TLVType & mPath
)

StartPathList

WEAVE_ERROR StartPathList(
  nl::Weave::TLV::TLVWriter & aWriter
)

パスリストの作成を開始します。

書くTLVをViewRequestの第一引数としてWDMパスリストの先頭に、例えばのために()。

詳細
パラメーター
[in] aWriter
参照TLVの書き込みを開始するとライター。
戻り値
WEAVE_NO_ERROR成功しました。それ以外の場合は返すWEAVE_ERRORコンテナを起動できないことを反映し。

TxnResponseHandler

void TxnResponseHandler(
  ExchangeContext *anExchangeCtx,
  const IPPacketInfo *anAddrInfo,
  const WeaveMessageInfo *aMsgInfo,
  uint32_t aProfileId,
  uint8_t aMsgType,
  PacketBuffer *aMsg
)

TxnTimeoutHandler

void TxnTimeoutHandler(
  ExchangeContext *anExchangeCtx
)

ValidateTLVType

WEAVE_ERROR ValidateTLVType(
  nl::Weave::TLV::TLVType aType,
  nl::Weave::TLV::TLVReader & aReader
)

ことを検証TLVの要素で読み取りが予想持つTLVのタイプを。

与えられたチェックのTLVの先頭の要素の型に対するタイプをTLVのリーダーと一致しない場合はエラーを返します。

詳細
パラメーター
[in] aType
特定の要素に対して検証されるTLVType。
[in] aReader
参照のTLV要素に位置リーダが検証されます。
戻り値
WEAVE_NO_ERRORが一致または存在する場合WEAVE_ERROR_WRONG_TLV_TYPEていない場合。
参照:
WeaveTLVTypes.h

検証WDMTag

WEAVE_ERROR ValidateWDMTag(
  uint32_t aTagNum,
  nl::Weave::TLV::TLVReader & aReader
)

ことを検証TLVの要素である読出しが期待WDMタグを有しています。

詳細
パラメーター
[in] aTagNum
予想されるWDMタグの32ビットタグ番号。
[in] aReader
TLVの要素に位置するリーダが検証されます。
戻り値
WEAVE_NO_ERROR成功しました。さもなければWEAVE_ERROR_INVALID_TLV_TAG WDMタグとして解釈する際、タグは、与えられたタグの数と一致しない場合。