nl::Weave::TLV::WeaveCircularTLVBuffer

#include <src/lib/core/WeaveCircularTLVBuffer.h>

WeaveCircularTLVBuffer bietet kreisförmigen Speicher für nl::Weave::TLV::TLVWriter und nl::Weave::TLVTLVReader.

Zusammenfassung

nl::Weave::TLV::TLVWriter kann eine unbegrenzte Anzahl von TLV-Einträgen in den WeaveCircularTLVBuffer schreiben, solange jeder einzelne TLV-Eintrag vollständig in den bereitgestellten Speicherplatz passt. nl::Weave::TLV::TLVReader kann höchstens die Größe des Puffers lesen, nimmt aber die Umschließung innerhalb des Puffers auf.

Konstruktoren und Zerstörer
WeaveCircularTLVBuffer(uint8_t *inBuffer, size_t inBufferLength)
WeaveCircularTLVBuffer(uint8_t *inBuffer, size_t inBufferLength, uint8_t *inHead)

Öffentliche Typen
ProcessEvictedElementFunct)(WeaveCircularTLVBuffer &inBuffer, void *inAppData, TLVReader &inReader) WEAVE_ERROR(*
Eine Funktion, die aufgerufen wird, um ein TLV-Element zu verarbeiten, bevor es aus dem nl::Weave::TLV::WeaveCircularTLVBuffer entfernt wird.

Öffentliche Attribute
mAppData
void *
Ein optionaler, vom Nutzer bereitgestellter Kontext, der bei der Callback-Verarbeitung des entfernten Elements verwendet wird.
mImplicitProfileId
uint32_t
mProcessEvictedElement
Ein optionaler, vom Nutzer bereitgestellter Callback, der das Element verarbeitet, bevor es aus dem Kreispuffer entfernt wird.

Öffentliche Funktionen
AvailableDataLength(void) const
size_t
DataLength(void) const
size_t
EvictHead(void)
Entfernt das älteste TLV-Element der obersten Ebene im WeaveCircularTLVBuffer.
FinalizeBuffer(TLVWriter & ioWriter, uint8_t *inBufStart, uint32_t inBufLen)
FinalizeBuffer passt den WeaveCircularTLVBuffer-Status nach Abschluss der Ausgabe aus dem TLVWriter an.
GetNewBuffer(TLVWriter & ioWriter, uint8_t *& outBufStart, uint32_t & outBufLen)
Fordern Sie zusätzlichen Speicherplatz für den TLVWriter an.
GetNextBuffer(TLVReader & ioReader, const uint8_t *& outBufStart, uint32_t & outBufLen)
Holen Sie sich zusätzlichen Speicherplatz für TLVReader.
GetQueue(void) const
uint8_t *
GetQueueSize(void) const
size_t
QueueHead(void) const
uint8_t *
QueueTail(void) const
uint8_t *
SetQueueHead(uint8_t *aQueueHead)
void
SetQueueLength(size_t aQueueLength)
void

Öffentliche statische Funktionen
FinalizeBufferFunct(TLVWriter & ioWriter, uintptr_t inBufHandle, uint8_t *inBufStart, uint32_t inBufLen)
GetNewBufferFunct(TLVWriter & ioWriter, uintptr_t & inBufHandle, uint8_t *& outBufStart, uint32_t & outBufLen)
Ein Trampolin, um mehr Platz für den TLVWriter zu finden.
GetNextBufferFunct(TLVReader & ioReader, uintptr_t & inBufHandle, const uint8_t *& outBufStart, uint32_t & outBufLen)

Öffentliche Typen

ProcessEvictedElementFunct

WEAVE_ERROR(* ProcessEvictedElementFunct)(WeaveCircularTLVBuffer &inBuffer, void *inAppData, TLVReader &inReader)

Eine Funktion, die aufgerufen wird, um ein TLV-Element zu verarbeiten, bevor es aus dem nl::Weave::TLV::WeaveCircularTLVBuffer entfernt wird.

Funktionen dieses Typs werden verwendet, um ein TLV-Element zu verarbeiten, das demnächst aus dem Zwischenspeicher entfernt werden soll. Die Funktion erhält einen nl::Weave::TLV::TLVReader, der auf dem Element positioniert ist, das gelöscht werden soll, sowie einen void *-Kontext, in dem der Nutzer möglicherweise eine zusätzliche Umgebung für den Callback bereitgestellt hat. Wenn die Funktion das Element erfolgreich verarbeitet hat, muss sie WEAVE_NO_ERROR zurückgeben. Dies bedeutet für WeaveCircularTLVBuffer, dass das Element sicher entfernt werden kann. Jeder andere Rückgabewert wird als Fehler behandelt und verhindert, dass WeaveCircularTLVBuffer das betreffende Element entfernt.

Hinweis: Dieser Callback kann verwendet werden, um zu erzwingen, dass WeaveCircularTLVBuffer das Element nicht entfernt. Dies kann in einer Reihe von Situationen nützlich sein, wenn ein zugrunde liegender zirkulärer Puffer benötigt, aber keine darin enthaltenen Elemente überschrieben werden sollen.

Details
Parameter
[in] inBuffer
Ein Verweis auf den Puffer, von dem aus die Bereinigung erfolgt
[in] inAppData
Ein Zeiger auf die vom Nutzer bereitgestellte Struktur, die zusätzlichen Kontext für diesen Callback enthält
[in] inReader
Ein TLVReader, der sich an dem Element befindet, das entfernt werden soll.
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg. Das Element wird entfernt.
other
Bei der Ereignisverarbeitung ist ein Fehler aufgetreten. Das Element bleibt im Puffer. Die Schreibfunktion, die diese Elementbereinigung ausgelöst hat, schlägt fehl.

Öffentliche Attribute

mAppData

void * mAppData

Ein optionaler, vom Nutzer bereitgestellter Kontext, der bei der Callback-Verarbeitung des entfernten Elements verwendet wird.

mImplicitProfileId

uint32_t mImplicitProfileId

mProcessEvictedElement

ProcessEvictedElementFunct mProcessEvictedElement

Ein optionaler, vom Nutzer bereitgestellter Callback, der das Element verarbeitet, bevor es aus dem Kreispuffer entfernt wird.

Weitere Informationen zur Implementierung der Funktion mProcessEBearbeitungsElementFunct finden Sie in der Typdefinition von ProcessE SchlafedElementFunct.

Öffentliche Funktionen

AvailableDataLength

size_t AvailableDataLength(
  void
) const

DataLength

size_t DataLength(
  void
) const

EvictHead

WEAVE_ERROR EvictHead(
  void
)

Entfernt das älteste TLV-Element der obersten Ebene im WeaveCircularTLVBuffer.

Diese Funktion entfernt das älteste TLV-Element der obersten Ebene im Zwischenspeicher. Die Funktion ruft den unter mProcessEvictedElement registrierten Callback auf, um das Element vor dem Entfernen zu verarbeiten. Wenn der Callback etwas anderes als WEAVE_NO_ERROR zurückgibt, wird das Element nicht entfernt. Gleichermaßen bleibt der zugrunde liegende WeaveCircularTLVBuffer unverändert, wenn ein anderer Fehler auftritt, keine Elemente im Puffer usw.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Bei jedem anderen Fehler, der entweder vom Callback oder vom TLVReader zurückgegeben wird.

FinalizeBuffer

WEAVE_ERROR FinalizeBuffer(
  TLVWriter & ioWriter,
  uint8_t *inBufStart,
  uint32_t inBufLen
)

FinalizeBuffer passt den WeaveCircularTLVBuffer-Status nach Abschluss der Ausgabe aus dem TLVWriter an.

Diese Funktion wirkt sich auf die Position des Warteschlangenendes aus.

Details
Parameter
[in,out] ioWriter
TLVWriter ruft diese Funktion auf.
[in] inBufStart
Zeiger auf den Anfang der Daten (aus TLVWriter-Perspektive)
[in] inBufLen
Länge der Daten im Zwischenspeicher, auf die inbufStart zeigt
Rückgabewerte
WEAVE_NO_ERROR
Bedingungslos.

GetNewBuffer

WEAVE_ERROR GetNewBuffer(
  TLVWriter & ioWriter,
  uint8_t *& outBufStart,
  uint32_t & outBufLen
)

Fordern Sie zusätzlichen Speicherplatz für den TLVWriter an.

Tatsächlich entfernt die Funktion ein Element aus dem kreisförmigen Puffer und passt den Kopf dieser Pufferwarteschlange an.

Details
Parameter
[in,out] ioWriter
TLVWriter ruft diese Funktion auf.
[out] outBufStart
Den Zeiger auf den neuen Puffer
[out] outBufLen
Verfügbare Länge für das Schreiben
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Wenn die Funktion kein vollständiges TLV-Element der obersten Ebene auslassen konnte.

GetNextBuffer

WEAVE_ERROR GetNextBuffer(
  TLVReader & ioReader,
  const uint8_t *& outBufStart,
  uint32_t & outBufLen
)

Holen Sie sich zusätzlichen Speicherplatz für TLVReader.

Der von WeaveCircularTLVBuffer bereitgestellte Speicher kann innerhalb des Puffers umschlossen werden. Diese Funktion bietet uns die Möglichkeit, die Zwischenspeicherung des Kreispuffers an die TLVReader-Einschränkungen abzugleichen. Der Leser liest höchstens mQueueSize Byte aus dem Zwischenspeicher.

Details
Parameter
[in] ioReader
TLVReader ist ein Aufruf dieser Funktion.
[in,out] outBufStart
Der Verweis auf den Datenpuffer. Er wird dann auf einen Wert in diesem Puffer gesetzt.
[out] outBufLen
Wird bei Rückgabe auf die Anzahl der kontinuierlichen Byte festgelegt, die aus dem Puffer gelesen werden können.
Rückgabewerte
WEAVE_NO_ERROR
Erfolg ohne Bedingungen.

GetQueue

uint8_t * GetQueue(
  void
) const

GetQueueSize

size_t GetQueueSize(
  void
) const

QueueHead

uint8_t * QueueHead(
  void
) const

QueueTail

uint8_t * QueueTail(
  void
) const

SetQueueHead

void SetQueueHead(
  uint8_t *aQueueHead
)

SetQueueLength

void SetQueueLength(
  size_t aQueueLength
)

WeaveCircularTLVBuffer

 WeaveCircularTLVBuffer(
  uint8_t *inBuffer,
  size_t inBufferLength
)

WeaveCircularTLVBuffer Konstruktor.

Details
Parameter
[in] inBuffer
Ein Zeiger auf den Sicherungsspeicher für die Warteschlange
[in] inBufferLength
Länge des Sicherungsspeichers in Byte

WeaveCircularTLVBuffer

 WeaveCircularTLVBuffer(
  uint8_t *inBuffer,
  size_t inBufferLength,
  uint8_t *inHead
)

WeaveCircularTLVBuffer Konstruktor.

Details
Parameter
[in] inBuffer
Ein Zeiger auf den Sicherungsspeicher für die Warteschlange
[in] inBufferLength
Länge des Sicherungsspeichers in Byte
[in] inHead
Anfangspunkt für den Kopf Der inHead-Zeiger muss im Sicherungsspeicher für den Kreispuffer liegen, also in inBuffer und &(inBuffer[inBufferLength])

Öffentliche statische Funktionen

FinalizeBufferFunct

WEAVE_ERROR FinalizeBufferFunct(
  TLVWriter & ioWriter,
  uintptr_t inBufHandle,
  uint8_t *inBufStart,
  uint32_t inBufLen
)

Ein Trampolin nach WeaveCircularTLVBuffer::FinalizeBuffer

Details
Parameter
[in,out] ioWriter
TLVWriter ruft diese Funktion auf.
[in,out] inBufHandle
Ein Handle zum CircularTLVWriter-Objekt
[in] inBufStart
Zeiger auf den Anfang der Daten (aus TLVWriter-Perspektive)
[in] inBufLen
Länge der Daten im Zwischenspeicher, auf die inbufStart zeigt
Rückgabewerte
WEAVE_NO_ERROR
Bedingungslos.

GetNewBufferFunct

WEAVE_ERROR GetNewBufferFunct(
  TLVWriter & ioWriter,
  uintptr_t & inBufHandle,
  uint8_t *& outBufStart,
  uint32_t & outBufLen
)

Ein Trampolin, um mehr Platz für den TLVWriter zu finden.

Details
Parameter
[in,out] ioWriter
TLVWriter ruft diese Funktion auf.
[in,out] inBufHandle
Ein Handle zum CircularTLVWriter-Objekt
[out] outBufStart
Den Zeiger auf den neuen Puffer
[out] outBufLen
Verfügbare Länge für das Schreiben
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Wenn die Funktion kein vollständiges TLV-Element der obersten Ebene auslassen konnte.

GetNextBufferFunct

WEAVE_ERROR GetNextBufferFunct(
  TLVReader & ioReader,
  uintptr_t & inBufHandle,
  const uint8_t *& outBufStart,
  uint32_t & outBufLen
)

Ein Trampolin nach WeaveCircularTLVBuffer::GetNextBuffer

Details
Parameter
[in,out] ioReader
TLVReader ruft diese Funktion auf.
[in,out] inBufHandle
Ein Handle zum CircularTLVWriter-Objekt
[in,out] outBufStart
Der Verweis auf den Datenpuffer. Er wird dann auf einen Wert in diesem Puffer gesetzt.
[out] outBufLen
Wird bei Rückgabe auf die Anzahl der kontinuierlichen Byte festgelegt, die aus dem Puffer gelesen werden können.
Rückgabewerte
WEAVE_NO_ERROR
Erfolg ohne Bedingungen.