Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

nl:: Weben:: Profile:: DataManagement_Legacy

Dieser Namespace enthält alle Schnittstellen in Weave für das Weave Data Management (WDM)-Profil, die bald veraltet sind.

Zusammenfassung

Aufzählungen

@103 {
kStatus_CancelSuccess = 0x0001,
kStatus_InvalidPath = 0x0013,
kStatus_UnknownTopic = 0x0014,
kStatus_IllegalReadRequest = 0x0015,
kStatus_IllegalWriteRequest = 0x0016,
kStatus_InvalidVersion = 0x0017,
kStatus_UnsupportedSubscriptionMode = 0x0018
}
aufzählen
@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
}
aufzählen
WDM-Pool- und Tischgrößen.
@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
}
aufzählen
Die Nachrichtentypen des WDM-Profils.
@168 {
kTransactionIdNotSpecified = 0,
kResponseTimeoutNotSpecified = 0,
kVersionNotSpecified = 0xFFFFFFFFFFFFFFFFULL,
kInstanceIdNotSpecified = 0,
kDefaultBindingTableIndex = 0,
kWeaveTLVTagLen = 8,
kWeaveTLVControlByteLen = 1
}
aufzählen
Verschiedene WDM-spezifische Konstanten.
@169 {
kStatus_CancelSuccess = 0x0001,
kStatus_InvalidPath = 0x0013,
kStatus_UnknownTopic = 0x0014,
kStatus_IllegalReadRequest = 0x0015,
kStatus_IllegalWriteRequest = 0x0016,
kStatus_InvalidVersion = 0x0017,
kStatus_UnsupportedSubscriptionMode = 0x0018
}
aufzählen
WDM-spezifische Statuscodes.
@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
}
aufzählen
Datenverwaltungsprotokoll-Tags.
@171 {
kTopicIdPublisherSpecificMask = 0xFFFF000000000000ULL,
kTopicIdNotSpecified = 0x0000000000000000ULL,
kAnyTopicId = 0xFFFFFFFFFFFFFFFFULL
}
aufzählen
Distinguierte Themen-IDs.
WeaveTransportOption {
kTransport_TCP = 1,
kTransport_WRMP = 2,
kTransport_UDP = 3
}
aufzählen
WDM-Transportmöglichkeiten.

Typdefinitionen

TopicIdentifier Typdef
uint64_t
Die Themenkennung.

Funktionen

CheckTLVType ( nl::Weave::TLV::TLVType aType,nl::Weave::TLV::TLVReader & aReader)
bool
Überprüfen Sie, ob eine TLV Element seiner Lese den erwarteten hat TLV - Typen.
CheckWDMTag (uint32_t aTagNum,nl::Weave::TLV::TLVReader & aReader)
bool
Überprüfen Sie ein WDM-spezifisches Tag.
CloseDataListElement (nl::Weave::TLV::TLVReader & aReader)
Beenden Sie das Lesen eines WDM-Datenlistenelements.
CloseList (nl::Weave::TLV::TLVReader & aReader)
Beenden Sie das Lesen eines WDM-Pfads oder einer Datenliste.
EncodeDeprecatedPath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ...)
Codieren Sie einen WDM-Pfad mit veralteten Tags und einer ganzzahligen Instanz-ID.
EncodeDeprecatedPath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ...)
Codieren Sie einen WDM-Pfad mit veralteten Tags und einer Zeichenfolgeninstanz-ID.
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ...)
Codieren Sie einen WDM-Pfad mit einer ganzzahligen Profilinstanz-ID.
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint32_t aInstanceIdLen, const uint8_t *aInstanceId, uint32_t aPathLen, ...)
Codieren Sie einen WDM-Pfad mit einer Byte-Array-Instanz-ID.
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ...)
Codieren Sie einen WDM-Pfad mit einer Zeichenfolgeninstanz-ID.
EndDataListElement (nl::Weave::TLV::TLVWriter & aWriter)
Beenden Sie das Schreiben eines Datenlistenelements.
EndEncodePath (TLVWriter & aWriter, TLVType & mOuterContainer, WEAVE_ERROR mError)
EndList (nl::Weave::TLV::TLVWriter & aWriter)
Beenden Sie das Schreiben einer Pfadliste oder Datenliste.
EndList ( ReferencedTLVData & aList,nl::Weave::TLV::TLVWriter & aWriter)
Beenden Sie das Schreiben einer Pfadliste oder Datenliste.
IsPublisherSpecific (const TopicIdentifier & aTopicId)
bool
Prüfen Sie, ob eine Themen-ID verlegerspezifisch ist.
OpenDataList ( ReferencedTLVData & aDataList,nl::Weave::TLV::TLVReader & aReader)
Beginnen Sie mit dem Lesen einer Datenliste.
OpenDataListElement (nl::Weave::TLV::TLVReader & aReader,nl::Weave::TLV::TLVReader & aPathReader, uint64_t & aVersion)
Beginnen Sie mit dem Lesen eines Datenlistenelements.
OpenPathList ( ReferencedTLVData & aPathList,nl::Weave::TLV::TLVReader & aReader)
Beginnen Sie mit dem Lesen einer Pfadliste.
PublisherSpecificTopicId (void)
Generieren Sie eine verlegerspezifische Themen-ID von Grund auf neu.
SendStatusReport ( ExchangeContext *aExchangeCtx, StatusReport & aStatus)
StartDataList (nl::Weave::TLV::TLVWriter & aWriter)
Beginnen Sie mit dem Schreiben einer Datenliste.
StartDataList ( ReferencedTLVData & aDataList,nl::Weave::TLV::TLVWriter & aWriter)
Starten Sie eine Datenliste zu einem bestimmten Schreiben ReferencedTLVData Objekt.
StartDataListElement (nl::Weave::TLV::TLVWriter & aWriter)
Beginnen Sie mit dem Schreiben eines Datenlistenelements.
StartEncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, TLVType & mOuterContainer, TLVType & mPath)
StartPathList (nl::Weave::TLV::TLVWriter & aWriter)
Beginnen Sie mit dem Schreiben einer Pfadliste.
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)
Validieren , dass ein TLV Element eingelesen hat den erwarteten TLV - Typen.
ValidateWDMTag (uint32_t aTagNum,nl::Weave::TLV::TLVReader & aReader)
Validieren , dass ein TLV Element ist die erwartete Lese WDM - Tag hat.

Klassen

nl :: Weave :: Profile :: DataManagement_Legacy :: Bindung

Die Binding - Klasse verwaltet Kommunikationszustand im Auftrag eines Anwendungsentität mit Weave.

nl :: Weave :: Profile :: DataManagement_Legacy :: ClientDataManager

Eine abstrakte Klasse, die vom WDM-Client benötigte Bestätigungs- und Anzeigemethodendefinitionen enthält.

nl :: Weave :: Profile :: DataManagement_Legacy :: ClientNotifier

Eine Hilfsklasse, die verwendet wird, wenn Abonnement- und Benachrichtigungsunterstützung auf einem WDM-Client gewünscht wird.

nl :: Weave :: Profile :: DataManagement_Legacy :: DMClient

Die abstrakte Basisklasse für anwendungsspezifische WDM-Clients.

nl :: Weave :: Profile :: DataManagement_Legacy :: DMPublisher

Die abstrakte Basisklasse für anwendungsspezifische WDM-Publisher.

nl :: Weave :: Profile :: DataManagement_Legacy :: ProfileDatabase

Die abstrakte ProfileDatabase Zusatzklasse.

nl :: Weave :: Profile :: DataManagement_Legacy :: ProtocolEngine

Die WDM-Protokoll-Engine-Klasse.

nl :: Weave :: Profile :: DataManagement_Legacy :: PublisherDataManager

Eine abstrakte Klasse, die vom WDM-Herausgeber erforderliche Bestätigungs- und Benachrichtigungsmethodendefinitionen enthält.

Aufzählungen

@103

 @103
Eigenschaften
kStatus_CancelSuccess

Dieser Legacy-Statuscode bedeutet, dass ein Abonnement erfolgreich gekündigt wurde.

Dieser Statuscode bedeutet, dass ein Abonnement erfolgreich gekündigt wurde.

kStatus_IllegalReadRequest

Dieser Legacy-Statuscode bedeutet, dass der Knoten, der eine Anforderung zum Lesen eines bestimmten Datenelements stellt, keine Berechtigung dazu hat.

Dieser Statuscode bedeutet, dass der Knoten, der eine Anforderung zum Lesen eines bestimmten Datenelements stellt, dazu keine Berechtigung hat.

kStatus_IllegalWriteRequest

Dieser Legacy-Statuscode bedeutet, dass der Knoten, der eine Anfrage zum Schreiben eines bestimmten Datenelements stellt, dazu keine Berechtigung hat.

Dieser Statuscode bedeutet, dass der Knoten, der eine Anfrage zum Schreiben eines bestimmten Datenelements stellt, dazu keine Berechtigung hat.

kStatus_InvalidPath

Dieser Legacy-Statuscode bedeutet, dass ein Pfad aus der Pfadliste eines View- oder Update-Request-Frames nicht mit dem knotenresidenten Schema des Responders übereinstimmt.

Dieser Statuscode bedeutet, dass ein Pfad aus der Pfadliste eines View- oder Update-Request-Frames nicht mit dem knotenresidenten Schema des Responders übereinstimmt.

kStatus_InvalidVersion

Dieser Legacy-Statuscode bedeutet, dass die Version für Daten, die in einer Aktualisierungsanforderung enthalten sind, nicht mit der neuesten Version auf dem Herausgeber übereinstimmte und das Update daher nicht angewendet werden konnte.

Dieser Statuscode bedeutet, dass die Version für Daten, die in einer Aktualisierungsanforderung enthalten sind, nicht mit der neuesten Version auf dem Herausgeber übereinstimmte und das Update daher nicht angewendet werden konnte.

kStatus_UnknownTopic

Dieser Legacy-Statuscode bedeutet, dass die in einer Abbruchanforderung oder -Benachrichtigung angegebene Themenkennung nicht mit einem auf dem empfangenden Knoten vorhandenen Abonnement übereinstimmt.

Dieser Statuscode bedeutet, dass die in einer Abbruchanforderung oder Benachrichtigung angegebene Themenkennung nicht mit einem auf dem empfangenden Knoten vorhandenen Abonnement übereinstimmt.

kStatus_UnsupportedSubscriptionMode

Dieser Legacy-Statuscode bedeutet, dass der angeforderte Abonnementmodus vom empfangenden Gerät nicht unterstützt wird.

Dieser Statuscode bedeutet, dass der angeforderte Abonnementmodus vom empfangenden Gerät nicht unterstützt wird.

@166

 @166

WDM-Pool- und Tischgrößen.

WDM definiert verschiedene Pools und Tabellen, die für seinen Betrieb wie folgt benötigt werden.

Kundentransaktionspools:

  • kViewPoolSize
  • kSubscribePoolSize
  • kCancelSubscriptionPoolSize
  • kUpdatePoolSize

Publisher-Transaktionspools:

  • kNotifyPoolSize

Protokoll-Engine-Tabellen:

  • kTransactionTableSize
  • kBindingTableSize

Abonnementbezogene Tabellen:

  • kNotifierTableSize (nur Client)
  • kSubscriptionMgrTableSize (nur Herausgeber)

Beachten Sie, dass diese konfigurierbare Mengen sind und dass die pro-Plattform Werte erscheinen in der zugehörigen WeaveConfig.h .

Eigenschaften
kBindingTableSize

Dies ist die Standardgröße der Bindungstabelle in der WDM-Protokoll-Engine.

Dieser Wert kann so konfiguriert werden , über WEAVE_CONFIG_WDM_BINDING_TABLE_SIZE .

kCancelSubscriptionPoolSize

Dies ist die Standardgröße des Transaktionspools für die Anforderung des Abonnements kündigen für einen WDM-Client.

Dieser Wert kann so konfiguriert werden , über WEAVE_CONFIG_WDM_CANCEL_SUBSCRIPTION_POOL_SIZE .

kNotifierTableSize

Dies ist die Standardgröße der Benachrichtigungstabelle für WDM-Clients.

Dieser Wert kann so konfiguriert werden , über WEAVE_CONFIG_WDM_NOTIFIER_TABLE_SIZE .

kNotifyPoolSize

Dies ist die Standardgröße des Transaktionspools für Benachrichtigungsanforderungen für einen WDM-Publisher.

Dieser Wert kann so konfiguriert werden , über WEAVE_CONFIG_WDM_NOTIFY_POOL_SIZE .

kSubscribePoolSize

Dies ist die Standardgröße des Transaktionspools für Abonnementanforderungen für einen WDM-Client.

Dieser Wert kann so konfiguriert werden , über WEAVE_CONFIG_WDM_SUBSCRIBE_POOL_SIZE .

kSubscriptionMgrTableSize

Dies ist die Standardgröße der Abonnementtabelle für WDM-Publisher.

Dieser Wert kann so konfiguriert werden , über WEAVE_CONFIG_WDM_SUBSCRIPTION_MGR_TABLE_SIZE .

kTransactionTableSize

Dies ist die Standardgröße der Transaktionstabelle in der WDM-Protokoll-Engine.

Dieser Wert kann so konfiguriert werden , über WEAVE_CONFIG_WDM_TRANSACTION_TABLE_SIZE .

kUpdatePoolSize

Dies ist die Standardgröße des Transaktionspools für Aktualisierungsanforderungen für einen WDM-Client.

Dieser Wert kann so konfiguriert werden , über WEAVE_CONFIG_WDM_UPDATE_POOL_SIZE .

kViewPoolSize

Dies ist die Standardgröße des Transaktionspools für Ansichtsanforderungen für einen WDM-Client.

Dieser Wert kann so konfiguriert werden , über WEAVE_CONFIG_WDM_VIEW_POOL_SIZE .

@167

 @167

Die Nachrichtentypen des WDM-Profils.

Diese Werte werden in der Datenverwaltungsspezifikation genannt.

HINWEIS!! Ab dem ersten Quartal 2015 sind die in früheren Versionen von WDM verwendeten Nachrichtentypen veraltet und es wurden neue Nachrichtentypen definiert, die eine ausreichende Verschiebung mit früheren Pack- und Parsing-Details widerspiegeln, um einen sauberen Bruch zu rechtfertigen.

Eigenschaften
kMsgType_CancelSubscriptionRequest

Nachricht zur Abo-Anfrage kündigen.

kMsgType_CancelSubscriptionRequest_Deprecated

veraltet

kMsgType_NotifyRequest

Anfragenachricht benachrichtigen.

kMsgType_NotifyRequest_Deprecated

veraltet

kMsgType_SubscribeRequest

Anfragenachricht abonnieren.

kMsgType_SubscribeRequest_Deprecated

veraltet

kMsgType_SubscribeResponse

Antwortnachricht abonnieren.

kMsgType_SubscribeResponse_Deprecated

veraltet

kMsgType_UpdateRequest

Anfragenachricht aktualisieren.

kMsgType_UpdateRequest_Deprecated

veraltet

kMsgType_ViewRequest

Anfragenachricht anzeigen.

kMsgType_ViewRequest_Deprecated

veraltet

kMsgType_ViewResponse

Antwortnachricht anzeigen.

kMsgType_ViewResponse_Deprecated

veraltet

@168

 @168

Verschiedene WDM-spezifische Konstanten.

Eigenschaften
kDefaultBindingTableIndex

Der Index der Standardbindung in einer Protokoll-Engine-Bindungstabelle mit mehr als einem Eintrag.

kInstanceIdNotSpecified

Gibt bei Aufrufen, die eine Profilinstanzspezifikation erfordern, "none" an.

In den meisten Fällen bedeutet dies, dass nur eine Instanz des Profils auf der fraglichen Entität vorhanden ist.

kResponseTimeoutNotSpecified

Gibt in Methoden, die eine Transaktion anfordern, an, dass der Aufrufer die Angabe eines Timeouts abgelehnt hat.

Im Allgemeinen bedeutet dies, dass ein Standardwert verwendet werden sollte.

kTransactionIdNotSpecified

Gibt in Methoden und Datenstrukturen, die eine Transaktions-ID annehmen, "keine" oder einen Platzhalterwert an.

kVersionNotSpecified

Gibt bei Anrufen, die die Angabe einer Datenversion erfordern, "keine bestimmte Version" an.

kWeaveTLVControlByteLen

Die Länge eines TLV Steuerbyte, verwendet zur Unterstützung Methoden daß kodieren WDM Strukturen in TLV .

kWeaveTLVTagLen

Die Standardlänge in Bytes eines Voll qualifizierten TLV - Tages, in Unterstützung Methoden verwendet , dass kodieren WDM Strukturen in TLV .

@169

 @169

WDM-spezifische Statuscodes.

Eigenschaften
kStatus_CancelSuccess

Dieser Legacy-Statuscode bedeutet, dass ein Abonnement erfolgreich gekündigt wurde.

Dieser Statuscode bedeutet, dass ein Abonnement erfolgreich gekündigt wurde.

kStatus_IllegalReadRequest

Dieser Legacy-Statuscode bedeutet, dass der Knoten, der eine Anforderung zum Lesen eines bestimmten Datenelements stellt, keine Berechtigung dazu hat.

Dieser Statuscode bedeutet, dass der Knoten, der eine Anforderung zum Lesen eines bestimmten Datenelements stellt, dazu keine Berechtigung hat.

kStatus_IllegalWriteRequest

Dieser Legacy-Statuscode bedeutet, dass der Knoten, der eine Anfrage zum Schreiben eines bestimmten Datenelements stellt, dazu keine Berechtigung hat.

Dieser Statuscode bedeutet, dass der Knoten, der eine Anfrage zum Schreiben eines bestimmten Datenelements stellt, dazu keine Berechtigung hat.

kStatus_InvalidPath

Dieser Legacy-Statuscode bedeutet, dass ein Pfad aus der Pfadliste eines View- oder Update-Request-Frames nicht mit dem knotenresidenten Schema des Responders übereinstimmt.

Dieser Statuscode bedeutet, dass ein Pfad aus der Pfadliste eines View- oder Update-Request-Frames nicht mit dem knotenresidenten Schema des Responders übereinstimmt.

kStatus_InvalidVersion

Dieser Legacy-Statuscode bedeutet, dass die Version für Daten, die in einer Aktualisierungsanforderung enthalten sind, nicht mit der neuesten Version auf dem Herausgeber übereinstimmte und das Update daher nicht angewendet werden konnte.

Dieser Statuscode bedeutet, dass die Version für Daten, die in einer Aktualisierungsanforderung enthalten sind, nicht mit der neuesten Version auf dem Herausgeber übereinstimmte und das Update daher nicht angewendet werden konnte.

kStatus_UnknownTopic

Dieser Legacy-Statuscode bedeutet, dass die in einer Abbruchanforderung oder -Benachrichtigung angegebene Themenkennung nicht mit einem auf dem empfangenden Knoten vorhandenen Abonnement übereinstimmt.

Dieser Statuscode bedeutet, dass die in einer Abbruchanforderung oder Benachrichtigung angegebene Themenkennung nicht mit einem auf dem empfangenden Knoten vorhandenen Abonnement übereinstimmt.

kStatus_UnsupportedSubscriptionMode

Dieser Legacy-Statuscode bedeutet, dass der angeforderte Abonnementmodus vom empfangenden Gerät nicht unterstützt wird.

Dieser Statuscode bedeutet, dass der angeforderte Abonnementmodus vom empfangenden Gerät nicht unterstützt wird.

@170

 @170

Datenverwaltungsprotokoll-Tags.

Das Datenmanagement - Protokoll definiert eine Reihe von Tags in der zu verwendenden TLV Darstellung von Profildaten.

Wie üblich gibt es Kompatibilitätsprobleme zwischen neuem und altem WDM. Früher wurden alle diese Tags profilspezifisch angewendet, was Platzverschwendung war. jetzt verwenden wir wo möglich Kontext-Tags, aber wir müssen die alten beibehalten (und einen Mechanismus zum Kodieren von Pfaden mit ihnen haben), wo es angebracht ist.

Das Tag kTag_WDMDataListElementData wurde in früheren Versionen nicht verwendet und vom Code vollständig ignoriert, sodass wir keine veraltete Version bereitstellen müssen.

Eigenschaften
kTag_WDMDataList

Das Element ist eine Liste von Strukturen, die Pfad, optionale Version und Datenelemente enthält.

Tag-Typ: Profilspezifisch Elementtyp: Array Disposition: Top-Level

kTag_WDMDataListElementData

Das Element stellt die Daten dar, auf die durch den angegebenen Pfad verwiesen wird und die die angegebene Version haben.

Tag-Typ: Kontextspezifisch Elementtyp: Beliebig Disposition: Erforderlich

kTag_WDMDataListElementData_Deprecated

Veraltet.

Tag-Typ: Kontextspezifisch Elementtyp: Beliebig Disposition: Erforderlich

kTag_WDMDataListElementPath

Das Element ist die Pfadkomponente eines Datenlistenelements.

Tag-Typ: Kontextspezifisch Elementtyp: Pfad Disposition: Erforderlich

kTag_WDMDataListElementPath_Deprecated

Veraltet.

Tag-Typ: Profilspezifischer Elementtyp: Pfaddisposition: Erforderlich

kTag_WDMDataListElementVersion

Das Element ist die Versionskomponente eines Datenlistenelements.

Tag-Typ: Kontextspezifisch Elementtyp: Integer Disposition: Erforderlich

kTag_WDMDataListElementVersion_Deprecated

Veraltet.

Tag-Typ: Profilspezifisch Elementtyp: Integer Disposition: Erforderlich

kTag_WDMPathArrayIndexSelector

Das Pfadelement entspricht einem Array im Schema und das enthaltene Integer-Element soll als Index in dieses Array verwendet werden.

Tag-Typ: Profilspezifischer Elementtyp: Integer Disposition: Optional

kTag_WDMPathArrayValueSelector

Das Pfadelement entspricht einem Array im Schema und das gekapselte Element soll als Datensatzselektor verwendet werden.

Tag-Typ: Profilspezifisch Elementtyp: Struktur Disposition: Optional

kTag_WDMPathList

Das Element ist eine Liste der TLV Pfade.

Tag-Typ: Profilspezifisch Elementtyp: Array Disposition: Top-Level

kTag_WDMPathProfile

Das Element ist eine Struktur, die verwendet wird, um einen Pfad zu beginnen und die Profilinformationen enthält, anhand derer die Tags im Pfad interpretiert werden sollen.

Tag-Typ: Profilspezifisch Elementtyp: Struktur Disposition: Erforderlich

kTag_WDMPathProfileId

Das Element ist eine Profil - ID - Komponente des Pfadprofilelement , das einen beginnt TLV - Pfad.

Tag-Typ: Kontextspezifisch Elementtyp: Integer Disposition: Erforderlich

kTag_WDMPathProfileId_Deprecated

Veraltet.

Tag-Typ: Profilspezifisch Elementtyp: Integer Disposition: Erforderlich

kTag_WDMPathProfileInstance

Das Element ist ein Profil , beispielsweise , welche dem Profil - ID in einem folgen können TLV - Pfad.

Beachten Sie, dass ein Knoten mehrere Instanzen eines bestimmten Profils haben kann oder nicht, und falls es nur einen gibt, kann dieses Element weggelassen werden.

Tag-Typ: Kontextspezifisch Elementtyp: Beliebig Disposition: Optional

kTag_WDMPathProfileInstance_Deprecated

Veraltet.

Tag-Typ: Profilspezifischer Elementtyp: Beliebig Disposition: Optional

@171

 @171

Distinguierte Themen-IDs.

Es gibt drei verschiedene Themen-IDs von Interesse, von denen alle drei als "herausgeberspezifisch" formatiert sind.

Eigenschaften
kAnyTopicId

Dies ist als Wildcard-Themen-ID reserviert.

kTopicIdNotSpecified

Dies ist ein spezieller Wert, der reserviert ist, um entweder eine ungültige oder eine Platzhalter-Themen-ID auszudrücken.

kTopicIdPublisherSpecificMask

Dies wird als Maske verwendet, um eine Topci-ID zu erstellen oder zu zerlegen.

WeaveTransportOption

 WeaveTransportOption

WDM-Transportmöglichkeiten.

Dies sind sich gegenseitig ausschließende Transportmöglichkeiten für WDM.

Eigenschaften
kTransport_TCP

Der zugrunde liegende Transport ist TCP.

Die Bindung kann entweder über den Service-Manager oder direkt über die Nachrichtenschicht erfolgen.

kTransport_UDP

Der zugrunde liegende Transport ist ausschließlich UDP.

kTransport_WRMP

Der zugrunde liegende Transport ist ausschließlich UDP, jedoch mit Verbesserungen der Zuverlässigkeit der "Application Support Layer".

Typdefinitionen

Themenkennung

uint64_t TopicIdentifier

Die Themenkennung.

Themenbezeichner sind 64-Bit-Größen mit zwei verwandten Verwendungen/Semantiken. Zunächst einmal können sie als konventionelle Abkürzung für bekannte Pfade verwendet werden, zB "der Nest-Rauchmelder". Themen-IDs, die auf diese Weise verwendet werden, müssen wie Profilkennungen einen Anbietercode enthalten, der verhindert, dass Themen-IDs, die von unterschiedlichen Anbietern autonom ausgewählt werden, wie folgt in Konflikt geraten:

Bit 48 - 63 Bit 0 - 47
Hersteller-ID Themennummer
Die zweite Verwendung/Semantik für Themenkennungen ergibt sich in diesem Fall einer dynamischen Subskription zwischen einem WDM-Client und einem Herausgeber. in diesem Fall liefert der Verlag immer eine eindeutige Themen-ID, die für das jeweilige Abonnement steht, und zwar unabhängig davon, ob das Abonnement über eine bekannte Themen-ID oder eine beliebige Pfadliste angefordert wurde. Themenkennungen dieser Form werden dadurch unterschieden, dass sie den Herstellercode 0xFFFF haben.

Siehe auch:
WeaveVendorIdentifiers.hpp

Funktionen

CheckTLVType

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

Überprüfen Sie, ob eine TLV Element seiner Lese den erwarteten hat TLV - Typen.

Überprüfen Sie einen bestimmten TLV - Typ gegen den Elementtyp an der Spitze eines TLV - Reader.

Einzelheiten
Parameter
[in] aType
Der TLVType, der gegen ein bestimmtes Element geprüft werden soll
[in] aReader
Ein Verweis auf eine TLV - Lesegerät bei dem Element positioniert zu kontrollierenden
Kehrt zurück
true , wenn TLVType des Elements und aType übereinstimmen.
Siehe auch:
WeaveTLVTypes.h

CheckWDMTag

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

Überprüfen Sie ein WDM-spezifisches Tag.

Überprüfen Sie die Nummer eines WDM-spezifischen Tages, von ... / Daten-Management / DMConstants.h, gegen den eigentlichen Tag an der Spitze eines TLV - Reader.

Einzelheiten
Parameter
[in] aTagNum
Die Tag - Nummer gegen ein bestimmtes geprüft wird TLV Element.
[in] aReader
Ein Verweis auf einen TLV Leser auf das Element zeigt überprüft werden.
Kehrt zurück
true , wenn aReader.GetTag() ein Tag erzeugt, das einer der erwarteten Tag-Formen für die angegebene Tag-Nummer entspricht.

CloseDataListElement

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

Beenden Sie das Lesen eines WDM-Datenlistenelements.

Diese Methode geht davon aus, dass das betreffende Element Teil einer WDM-Datenliste ist und übergibt daher kTLVType_Array an ExitContainer().

Einzelheiten
Parameter
[in,out] aReader
Ein TLV reader positioniert in einem WDM - Datenlistenelement.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Andernfalls eine Rückkehr WEAVE_ERROR eine Unfähigkeit reflektieren , einen Behälter zu verlassen.

SchließenListe

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

Beenden Sie das Lesen eines WDM-Pfads oder einer Datenliste.

Dieses Verfahren geht davon aus, dass die Liste in Frage das oberste ist TLV - Element und so gelangt kTLVType_Sructure zu ExitContainer ().

Einzelheiten
Parameter
[in,out] aReader
Ein TLV reader positioniert in einem WDM - Pfad oder Datenliste.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Andernfalls eine Rückkehr WEAVE_ERROR eine Unfähigkeit reflektieren , einen Behälter zu verlassen.

EncodeDeprecatedPath

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

Codieren Sie einen WDM-Pfad mit veralteten Tags und einer ganzzahligen Instanz-ID.

Hinweis: Encode ein Pfad des veralteten Tag - Satz durch den Service vor Weave Version 2.0 akzeptiert werden. Diese Version der Methode verwendet eine numerische Instanzkennung. Diese Methode startet einen Container mit ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfile) und fügt dann die Profil-ID mit ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileId_Deprecated) ein. Anschließend wird die Instanz-ID mit ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileInstance_Deprecated) eingefügt. Dies ist eine der veralteten Versionen zum Codieren eines Pfads, und neue Designs sollten dieses Format vermeiden.

Einzelheiten
Parameter
[in] aWriter
Ein Verweis auf den TLV Schreiber verwendet , um den Pfad zu schreiben.
[in] aTag
Ein Verweis auf den vollständig qualifizierten TLV - Tag , das auf diesem Weg trifft.
[in] aProfileId
Die Profil-ID, unter der Elemente des Pfades interpretiert werden sollen.
[in] aInstanceId
Ein Verweis auf die optionale Instanz-ID des zu verwendenden Profils.
[in] aPathLen
Die, möglicherweise 0, Länge der Liste von Pfadelementen über den anfänglichen Profilbezeichner hinaus.
[in] ...
Die optionale Liste von zusätzlichen Pfad-Tags mit variabler Länge.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Ansonsten eine Rückkehr WEAVE_ERROR eine Unfähigkeit , was den gegebenen Pfad zu formatieren.

EncodeDeprecatedPath

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

Codieren Sie einen WDM-Pfad mit veralteten Tags und einer Zeichenfolgeninstanz-ID.

Hinweis: Encode ein Pfad des deprecated Tag - Satz (siehe DMConstants.h). Diese Version der Methode verwendet eine Instanz-ID-Zeichenfolge. Diese Methode startet einen Container mit ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfile) und fügt dann die Profil-ID mit ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileId_Deprecated) ein. Anschließend wird die Instanz-ID mit ProfileTag(kWeaveProfile_WDM, kTag_WDMPathProfileInstance_Deprecated) eingefügt. Dies ist eine der veralteten Versionen zum Codieren eines Pfads, und neue Designs sollten dieses Format vermeiden.

Einzelheiten
Parameter
[in] aWriter
Ein Verweis auf den TLV Schreiber verwendet , um den Pfad zu schreiben.
[in] aTag
Ein Verweis auf den vollständig qualifizierten TLV - Tag , das auf diesem Weg trifft.
[in] aProfileId
Die Profil-ID, unter der Elemente des Pfades interpretiert werden sollen.
[in] aInstanceId
Die optionale Zeichenfolge, die als Profilinstanz-ID verwendet wird. Dieses Argument kann NULL sein, wenn keine Instanz-ID angegeben ist.
[in] aPathLen
Die, möglicherweise 0, Länge der Liste von Pfadelementen über den anfänglichen Profilbezeichner hinaus.
[in] ...
Die optionale Liste mit variabler Länge zusätzlicher Pfad-Tags.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Ansonsten eine Rückkehr WEAVE_ERROR eine Unfähigkeit , was den gegebenen Pfad zu formatieren.

EncodePath

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

Codieren Sie einen WDM-Pfad mit einer ganzzahligen Profilinstanz-ID.

Hinweis: Schreiben Sie einen TLV Pfad der Art in Datenmanagement eingesetzt , in denen vor allem gibt es eine Bezeichnung Profil am Anfang gelegt , um Interpretation der nachfolgenden Pfadelemente zu ermöglichen. Diese Version der Methode verwendet eine ganzzahlige Profilinstanz-ID.

Diese Methode fügt die Instanz-ID mithilfe von ContextTag(kTag_WDMPathProfileInstance) ein, der neuesten Version zum Codieren eines Pfads.

Einzelheiten
Parameter
[in] aWriter
Ein Verweis auf den TLV Schreiber verwendet , um den Pfad zu schreiben.
[in] aTag
Ein Verweis auf den vollständig qualifizierten TLV - Tag , das auf diesem Weg trifft.
[in] aProfileId
Die Profil-ID, unter der Elemente des Pfades interpretiert werden sollen.
[in] aInstanceId
Ein Verweis auf die optionale Instanzkennung des zu verwendenden Profils. Wenn keine Instanz-ID verwendet werden soll, sollte dieser Parameter den Wert kInstanceIdNotSpecified haben.
[in] aPathLen
Die, möglicherweise 0, Länge der Liste von Pfadelementen über den anfänglichen Profilbezeichner hinaus.
[in] ...
Die optionale Liste von zusätzlichen Pfad-Tags mit variabler Länge.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Ansonsten eine Rückkehr WEAVE_ERROR eine Unfähigkeit , was den gegebenen Pfad zu formatieren.

EncodePath

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

Codieren Sie einen WDM-Pfad mit einer Byte-Array-Instanz-ID.

Hinweis: Schreiben Sie einen TLV Pfad der Art in Datenmanagement eingesetzt , in denen vor allem gibt es eine Bezeichnung Profil am Anfang gelegt , um Interpretation der nachfolgenden Pfadelemente zu ermöglichen. Diese Version der Methode verwendet eine Instanz-ID des Byte-Array-Profils zusammen mit einer Länge.

Diese Methode fügt die Instanz-ID mithilfe von ContextTag(kTag_WDMPathProfileInstance) ein, der neuesten Version zum Codieren eines Pfads.

Einzelheiten
Parameter
[in] aWriter
Ein Verweis auf den TLV Schreiber verwendet , um den Pfad zu schreiben.
[in] aTag
Ein Verweis auf den vollständig qualifizierten TLV - Tag , das auf diesem Weg trifft.
[in] aProfileId
Die Profil-ID, unter der die Elemente des Pfades interpretiert werden sollen.
[in] aInstanceIdLen
Die Länge des Byte-Arrays, das die Instanz-ID bildet. Wenn keine ID vorhanden ist, muss dieser Parameter den Wert 0 haben.
[in] aInstanceId
Das optionale Byte-Array, das als Profilinstanz-ID verwendet wird. Dieses Argument kann NULL sein, wenn keine Instanz-ID angegeben ist.
[in] aPathLen
Die, möglicherweise 0, Länge der Liste von Pfadelementen über den anfänglichen Profilbezeichner hinaus.
[in] ...
Die optionale Liste mit variabler Länge zusätzlicher Pfad-Tags.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Ansonsten eine Rückkehr WEAVE_ERROR eine Unfähigkeit , was den gegebenen Pfad zu formatieren.

EncodePath

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

Codieren Sie einen WDM-Pfad mit einer Zeichenfolgeninstanz-ID.

Hinweis: Schreiben Sie einen TLV Pfad der Art in Datenmanagement eingesetzt , in denen vor allem gibt es eine Bezeichnung Profil am Anfang gelegt , um Interpretation der nachfolgenden Pfadelemente zu ermöglichen. Diese Version der Methode verwendet eine Zeichenfolgenprofilinstanz-ID.

Diese Methode fügt die Instanz-ID mithilfe von ContextTag(kTag_WDMPathProfileInstance) ein, der neuesten Version zum Codieren eines Pfads.

Einzelheiten
Parameter
[in] aWriter
Ein Verweis auf den TLV Schreiber verwendet , um den Pfad zu schreiben.
[in] aTag
Ein Verweis auf den vollständig qualifizierten TLV - Tag , das auf diesem Weg trifft.
[in] aProfileId
Die Profil-ID, unter der Elemente des Pfades interpretiert werden sollen.
[in] aInstanceId
Die optionale Zeichenfolge, die als Profilinstanz-ID verwendet wird. Dieses Argument kann NULL sein, wenn keine Instanz-ID angegeben ist.
[in] aPathLen
Die, möglicherweise 0, Länge der Liste von Pfadelementen über den anfänglichen Profilbezeichner hinaus.
[in] ...
Die optionale Liste mit variabler Länge zusätzlicher Pfad-Tags.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Ansonsten eine Rückkehr WEAVE_ERROR eine Unfähigkeit , was den gegebenen Pfad zu formatieren.

EndDataListElement

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

Beenden Sie das Schreiben eines Datenlistenelements.

Schreiben die TLV für das Ende eines WDM - Datenlistenelement. Beachten Sie, dass dies automatisch einen Typ von kTLVType_Array an den EndContainer()-Aufruf übergibt, vorausgesetzt, wir schließen immer ein Listenelement.

Einzelheiten
Parameter
[in] aWriter
Ein Verweis auf einen TLV - Brenner mit dem das Ende des Artikels zu schreiben.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Andernfalls eine Rückkehr WEAVE_ERROR eine Unfähigkeit Reflektieren einen Behälter zu beenden.

EndEncodePath

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

Endliste

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

Beenden Sie das Schreiben einer Pfadliste oder Datenliste.

Schreiben die TLV für das Ende eines WDM - Pfad oder Datenliste. Schließen Sie auch den Autor ab.

Einzelheiten
Parameter
[in,out] aWriter
Ein Verweis auf einen TLV - Brenner mit dem das Ende der Liste zu schreiben.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Andernfalls eine Rückkehr WEAVE_ERROR eine Unfähigkeit Reflektieren einen Behälter zu beenden.

Endliste

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

Beenden Sie das Schreiben einer Pfadliste oder Datenliste.

Schreiben die TLV für das Ende eines WDM - Pfad oder Datenliste. Schließen Sie auch den Autor ab. In diesem Fall ist die ReferencedTLVData an dem Objekt der TLV geschrieben wird in übergeben wird , und modifiziert , um die Menge der zu schreibenden Daten zu reflektieren.

Einzelheiten
Parameter
[in,out] aList
Ein Verweis auf das ReferenceTLVData-Objekt, in das die Liste geschrieben wurde.
[in] aWriter
Ein Verweis auf einen TLV - Brenner mit dem das Ende der Liste zu schreiben.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Andernfalls eine Rückkehr WEAVE_ERROR eine Unfähigkeit Reflektieren einen Behälter zu beenden.

IsPublisherSpecific

bool IsPublisherSpecific(
  const TopicIdentifier & aTopicId
)

Prüfen Sie, ob eine Themen-ID verlegerspezifisch ist.

Einzelheiten
Parameter
[in] aTopicId
eine Themenkennung ot check
Kehrt zurück
true, wenn die Themen-ID verlegerspezifisch ist, andernfalls false

OpenDataList

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

Beginnen Sie mit dem Lesen einer Datenliste.

Beginnen Sie mit dem Lesen der Liste mit einem neuen Lesegerät und einer Datenliste und validieren Sie die Tags und Typen, die ursprünglich im Prozess gefunden wurden. Wenn alles gut geht, stoppt der Reader, nachdem der Listencontainer eingegeben wurde.

Einzelheiten
Parameter
[in] aDataList
Eine Datenliste als Verweis auf ein bestandene ReferencedTLVData Objekt. Der normale Anwendungsfall ist, dass sich die Liste nach dem Empfang tatsächlich noch in einem Puffer befindet.
[out] aReader
Ein Verweis auf einen TLV - Leser verwendet , um die Datenliste zu lesen. Dieses Lesegerät zeigt kurz vor dem ersten Element in der Liste.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Ansonsten eine Rückkehr WEAVE_ERROR einen Fehler reflektieren die die Datenliste öffnen und / oder die entsprechenden Tags und Arten validieren.

OpenDataListElement

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

Beginnen Sie mit dem Lesen eines Datenlistenelements.

Wenn ein Lesegerät an einem Datenlistenelement positioniert ist, beginnen Sie mit dem Lesen des Elements und validieren Sie die Tags und Typen, die ursprünglich im Prozess gefunden wurden. Wenn alles gut geht, wird der Leser am Datenelement Daten positioniert und der Ein-/Ausgangspfadleser wird am entsprechenden Pfad positioniert.

Einzelheiten
Parameter
[in] aReader
Ein Verweis auf einen TLV reader positionierte an einem Datenlistenelement.
[out] aPathReader
Ein Verweis auf einen TLV - Leser sein an der Bahnkomponente des Datenlistenelementes spitz.
[out] aVersion
Eine Referenz auf eine 64-Bit-Ganzzahl, die entweder auf die Version des Datenlistenelements, falls vorhanden, oder auf kVersionNotSpecified gesetzt wird.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg oder auch eine WEAVE_ERROR zugeordnet öffnen und die Datenlistenelement zu lesen.

OpenPathList

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

Beginnen Sie mit dem Lesen einer Pfadliste.

Beginnen Sie mit dem Lesen der Liste mit einem neuen Leser und einer Pfadliste und validieren Sie die Tags und Typen, die ursprünglich im Prozess gefunden wurden. Wenn alles gut geht, stoppt der Reader, nachdem der Listencontainer eingegeben wurde.

Einzelheiten
Parameter
[in] aPathList
Eine Pfadliste als Verweis auf ein bestandene ReferencedTLVData Objekt. Der normale Anwendungsfall ist, dass sich die Liste nach dem Empfang tatsächlich noch in einem Puffer befindet.
[out] aReader
Ein Verweis auf einen TLV - Leser verwendet , um die Pfadliste zu lesen. Dieser Reader zeigt direkt vor dem ersten Pfad in der Liste.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg; andernfalls ein WEAVE_ERROR einen Ausfall der reflektierende öffnen Sie die Pfadliste und / oder die entsprechenden Tags und Arten validieren.

PublisherSpecificTopicId

TopicIdentifier PublisherSpecificTopicId(
  void
)

Generieren Sie eine verlegerspezifische Themen-ID von Grund auf neu.

Einzelheiten
Kehrt zurück
die neue Themenkennung.

Statusbericht senden

WEAVE_ERROR SendStatusReport(
  ExchangeContext *aExchangeCtx,
  StatusReport & aStatus
)

StartDataList

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

Beginnen Sie mit dem Schreiben einer Datenliste.

Schreibt die TLV für den Beginn einer WDM - Datenliste, zB als primäres Argument einer UpdateRequest ().

Einzelheiten
Parameter
[in] aWriter
Ein Verweis auf einen TLV Schriftsteller , mit dem Schreiben zu beginnen.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Ansonsten eine Rückkehr WEAVE_ERROR eine Unfähigkeit reflektiert einen Behälter zu starten.

StartDataList

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

Starten Sie eine Datenliste zu einem bestimmten Schreiben ReferencedTLVData Objekt.

Schreiben Sie den TLV für den Beginn einer WDM - Datenliste. In diesem Fall gehen wir davon aus, dass wir die Datenliste eine referenzierten sind auszuschreiben TLV - Datenstruktur. Es wird davon ausgegangen, dass der Writer nicht initialisiert ist - oder auf jeden Fall so initialisiert wird, dass er auf das angegebene Objekt zeigt.

Einzelheiten
Parameter
[out] aDataList
Ein Verweis auf ein ReferencedTLVData Objekt , das ist das Ziel der Verfasser sein , und schließlich enthält die Daten von Interesse.
[in] aWriter
Ein Verweis auf einen TLV Schriftsteller , mit dem Schreiben zu beginnen.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Ansonsten eine Rückkehr WEAVE_ERROR eine Unfähigkeit reflektiert einen Behälter zu starten.

StartDataListElement

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

Beginnen Sie mit dem Schreiben eines Datenlistenelements.

Schreiben Sie den TLV für den Beginn eines WDM - Datenlistenelement.

Einzelheiten
Parameter
[in] aWriter
Ein Verweis auf einen TLV Schriftsteller , mit dem Schreiben zu beginnen.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Ansonsten eine Rückkehr WEAVE_ERROR eine Unfähigkeit reflektiert einen Behälter zu starten.

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
)

Beginnen Sie mit dem Schreiben einer Pfadliste.

Schreibt die TLV für den Beginn eines WDM Pfadliste, zB als primäres Argument einer ViewRequest ().

Einzelheiten
Parameter
[in] aWriter
Ein Verweis auf einen TLV Schriftsteller , mit dem Schreiben zu beginnen.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Ansonsten eine Rückkehr WEAVE_ERROR eine Unfähigkeit reflektiert einen Behälter zu starten.

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
)

Validieren , dass ein TLV Element eingelesen hat den erwarteten TLV - Typen.

Überprüfen Sie einen bestimmten TLV - Typ gegen den Elementtyp an der Spitze eines TLV - Leser und geben einen Fehler zurück , wenn es keine Übereinstimmung gibt.

Einzelheiten
Parameter
[in] aType
Der TLVType, der gegen ein bestimmtes Element validiert werden soll.
[in] aReader
Ein Verweis auf eine TLV - Lesegerät bei dem Element positioniert zu validieren.
Kehrt zurück
WEAVE_NO_ERROR wenn es eine Übereinstimmung oder WEAVE_ERROR_WRONG_TLV_TYPE , wenn nicht.
Siehe auch:
WeaveTLVTypes.h

ValidateWDMTag

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

Validieren , dass ein TLV Element ist die erwartete Lese WDM - Tag hat.

Einzelheiten
Parameter
[in] aTagNum
Die 32-Bit-Tag-Nummer des erwarteten WDM-Tags.
[in] aReader
Ein TLV - Lesegerät bei dem Element positioniert zu validieren.
Kehrt zurück
WEAVE_NO_ERROR auf Erfolg. Ansonsten WEAVE_ERROR_INVALID_TLV_TAG wenn der Tag nicht mit der angegebenen Tag - Nummer , wenn sie als WDM - Tag interpretiert.