nl::Weave::TLV::TLVReader

Ruft den Wert des aktuellen Byte- oder UTF8-Stringelements ab.

Rufen Sie die Methode GetLength() vor GetBytes() auf, um die erforderliche Größe des Eingabepuffers zu bestimmen.

Gibt den Typ des Containers zurück, in dem der TLVReader gerade liest.

Die Methode GetContainerType() gibt den Typ des TLV-Containers zurück, in dem TLVReader liest. Wenn sich der TLVReader auf der äußersten Ebene einer TLV-Codierung befindet, also vor, auf oder nach dem äußersten TLV-Element, gibt die Methode kTLVType_NotRequested zurück.

Gibt das Steuerbyte zurück, das dem aktuellen TLV-Element zugeordnet ist.

Im Idealfall muss niemand etwas über das Kontrollbyte wissen und nur die interne Implementierung von TLV sollte Zugriff darauf haben. Trotzdem ist der Zugriff auf das Kontrollbyte für Debugging-Zwecke durch TLVDebugUtilities hilfreich, die versuchen, das Tag-Steuerbyte zu decodieren, wenn der TLV-Zwischenspeicherinhalt ausgegeben wird.

Rufen Sie einen Zeiger auf das erste codierte Byte eines TLV-Byte- oder UTF8-Stringelements ab.

Diese Methode gibt einen direkten Zeiger auf den codierten Stringwert innerhalb des zugrunde liegenden Eingabepuffers zurück. Für eine erfolgreiche Methode muss der gesamte Stringwert in einem einzigen Zwischenspeicher vorhanden sein. Andernfalls gibt die Methode WEAVE_ERROR_TLV_UNDERRUN zurück. Dadurch ist diese Methode beim Lesen von Daten aus mehreren nicht zusammenhängenden Zwischenspeichern nur begrenzt geeignet.

Gibt die Länge der Daten zurück, die mit dem aktuellen TLV-Element verknüpft sind.

Die Datenlänge gilt nur für Elemente vom Typ UTF8-String oder -Bytestring. Bei UTF8-Strings ist der zurückgegebene Wert die Anzahl der Byte im String, nicht die Anzahl der Zeichen.

Gibt die Gesamtzahl der gelesenen Byte zurück, seit der Reader initialisiert wurde.

Ruft den Punkt im zugrunde liegenden Eingabepuffer ab, der der aktuellen Position des Lesers entspricht.

Gibt die Gesamtzahl der Byte zurück, die gelesen werden können, bis die maximale Leselänge erreicht ist.

Ruft den Wert des aktuellen Byte- oder UTF8-Stringelements als String mit Null-Beendigung ab.

Rufen Sie die Methode GetLength() vor GetBytes() auf, um die erforderliche Größe des Eingabepuffers zu bestimmen. Der Eingabepuffer sollte mindestens ein Byte größer als die Stringlänge sein, um das Nullzeichen aufzunehmen.

Gibt das Tag zurück, das mit dem aktuellen TLV-Element verknüpft ist.

Der von GetTag() zurückgegebene Wert kann mit den Tag-Dienstprogrammfunktionen (IsProfileTag(), IsContextTag(), ProfileIdFromTag() usw.) verwendet werden, um den Tag-Typ zu bestimmen und verschiedene Tag-Feldwerte zu extrahieren.

Gibt den Typ des aktuellen TLV-Elements zurück.

Initialisiert ein TLVReader-Objekt aus einem anderen TLVReader-Objekt.

Initialisiert ein TLVReader-Objekt, um aus einem einzelnen Eingabepuffer zu lesen.

Initialisiert ein TLVReader-Objekt, um aus einem einzelnen PacketBuffer zu lesen.

Das Parsing beginnt an der Startposition des Zwischenspeichers (buf->DataStart()) und wird bis zum Ende der Daten im Zwischenspeicher fortgesetzt (wie durch buf->Datalen() angegeben), oder wenn maxLen-Bytes geparst wurden.

Initialisiert ein TLVReader-Objekt, um aus einem oder mehreren PacketBuffers zu lesen.

Das Parsing beginnt an der Startposition des anfänglichen Zwischenspeichers (buf->DataStart()). Wenn „allowDiscontiguousBuffers“ auf „true“ gesetzt ist, springt der Leser durch die Zwischenspeicherkette, die mit seinen Next()-Zeigern verknüpft ist. Das Parsing wird fortgesetzt, bis alle Daten in der Pufferkette aufgebraucht sind (wie durch buf -> Datalen() angegeben) oder maxLen-Bytes geparst wurden.

Überträgt das TLVReader-Objekt mit dem nächsten zu lesenden TLV-Element.

Die Methode Next() positioniert das Leseobjekt auf dem nächsten Element in einer TLV-Codierung, die sich im selben Begrenzungskontext befindet. Wenn sich der Leser auf der äußersten Ebene einer TLV-Codierung befindet, gelangt er durch das Aufrufen von Next() zum nächsten, obersten Element. Wenn sich das Lesegerät in einem TLV-Containerelement (einer Struktur, einem Array oder einem Pfad) befindet, wird der Leser durch Aufrufen von Next() zum nächsten Mitgliedselement des Containers weitergeleitet.

Da Next() die Leserbewegung auf den aktuellen Begrenzungskontext beschränkt, wird Next() aufgerufen, wenn sich der Leser auf einem Containerelement befindet, über den Container. Dabei werden seine Mitgliedselemente (und die Mitglieder aller verschachtelten Container) übersprungen, bis das erste Element nach dem Container erreicht wird.

Wenn in einem bestimmten Begrenzungskontext keine weiteren Elemente vorhanden sind, gibt die Methode Next() den Fehler WEAVE_END_OF_TLV zurück und die Position des Lesegeräts bleibt unverändert.

Überträgt das TLVReader-Objekt zum nächsten zu lesenden TLV-Element, wobei Typ und Tag des neuen Elements bestätigt werden.

Die Methode Next(TLVType expectedType, uint64_texpectedTag) ist eine praktische Methode mit demselben Verhalten wie Next(). Sie prüft aber auch, ob der Typ und das Tag des neuen TLV-Elements mit den bereitgestellten Argumenten übereinstimmen.

Initialisiert ein neues TLVReader-Objekt zum Lesen der Mitglieder eines TLV-Containerelements.

Die Methode OpenContainer() initialisiert ein neues TLVReader-Objekt zum Lesen der Mitgliederelemente eines TLV-Containers (einer Struktur, eines Arrays oder eines Pfads). Wenn OpenContainer() aufgerufen wird, muss das aktuelle TLVReader-Objekt auf dem zu lesenden Containerelement positioniert werden. Die Methode nimmt als einziges Argument einen Verweis auf einen neuen Reader an, der initialisiert wird, um den Container zu lesen. Dieser Reader wird als Container-Reader bezeichnet, während der Reader, auf dem OpenContainer() aufgerufen wird, als Parent-Reader bezeichnet wird.

Wenn die Methode OpenContainer() zurückgegeben wird, wird der Container-Reader direkt vor dem ersten Mitglied des Containers positioniert. Durch Aufrufen von Next() auf dem Container-Reader springen Sie durch die Mitglieder der Sammlung, bis das Ende erreicht ist. An diesem Punkt gibt das Lesegerät WEAVE_END_OF_TLV zurück.

Während der Container-Leser geöffnet ist, dürfen Anwendungen keine Aufrufe an den übergeordneten Reader senden oder seinen Status anderweitig ändern. Sobald eine Anwendung die Verwendung des Container-Readers beendet hat, muss sie durch Aufrufen von CloseContainer() im übergeordneten Reader geschlossen und der Container-Reader als Argument übergeben werden. Anwendungen können den Container-Reader jederzeit schließen, mit oder ohne Lesen aller im zugrunde liegenden Container enthaltenen Elemente. Nachdem der Container-Reader geschlossen wurde, können Anwendungen den übergeordneten Reader weiterhin verwenden.

Der Container-Reader übernimmt verschiedene Konfigurationseigenschaften vom übergeordneten Reader. Diese sind:

• Die implizite Profil-ID (ImplicitProfileId)
• Anwendungsdatenzeiger (AppData)
• Der Funktionszeiger GetNextBuffer

Versetzt das TLVReader-Objekt direkt nach dem aktuellen TLV-Element.

Die Methode Skip() positioniert das Leseobjekt direkt nach dem aktuellen TLV-Element, sodass der Leser bei einem nachfolgenden Aufruf von Next() zum folgenden Element weitergeleitet wird. Wie bei Next() werden die Mitglieder des Containers übersprungen, wenn sich der Leser zum Zeitpunkt des Aufrufs in einem Containerelement befindet. Wenn der Leser nicht in einem Element positioniert ist, bleibt seine Position unverändert.

Überprüft, ob sich das TVLReader-Objekt am Ende eines TLV-Containers befindet.

Mit der Methode VerifyEndOfContainer() wird überprüft, ob im aktuellen TLV-Container keine weiteren TLV-Elemente vorhanden sind, die gelesen werden sollen. Dies ist eine unkomplizierte Methode, die dem Aufrufen von Next() und der Überprüfung auf den Rückgabewert WEAVE_END_OF_TLV entspricht.

Löscht den Status des TLVReader.

Mit dieser Methode wird das Lesegerät vor der ersten TLV, zwischen den TLVs oder nach der letzten TLV positioniert.

Dies ist eine private Methode, die den TLVElementType aus mControlByte zurückgibt.

GetElementHeadLength

WEAVE_ERROR GetElementHeadLength(
  uint8_t & elemHeadBytes
) const 

IsContainerOpen

bool IsContainerOpen(
  void
) const 

WEAVE_ERROR ReadData(
  uint8_t *buf,
  uint32_t len
)

WEAVE_ERROR ReadElement(
  void
)

uint64_t ReadTag(
  TLVTagControl tagControl,
  const uint8_t *& p
)

void SetContainerOpen(
  bool aContainerOpen
)

WEAVE_ERROR SkipData(
  void
)

WEAVE_ERROR SkipToEndOfContainer(
  void
)

WEAVE_ERROR VerifyElement(
  void
)

WEAVE_ERROR FailGetNextBuffer(
  TLVReader & reader,
  uintptr_t & bufHandle,
  const uint8_t *& bufStart,
  uint32_t & bufLen
)

WEAVE_ERROR GetNextPacketBuffer(
  TLVReader & reader,
  uintptr_t & bufHandle,
  const uint8_t *& bufStart,
  uint32_t & bufLen
)