nl::Weave::TLV::TLVReader

Pobierz wartość bieżącego bajta lub elementu ciągu UTF8.

Aby określić wymagany rozmiar bufora wejściowego, przed wywołaniem funkcji GetBytes() wywołaj metodę GetLength().

Zwraca typ kontenera, w którym obecnie odczytuje TLVReader.

Metoda GetContainerType() zwraca typ kontenera TLV, w którym odczytuje obiekt TLVReader. Jeśli TLVReader znajduje się na najbardziej zewnętrznym poziomie kodowania TLV (tzn. przed, w dniu lub za zewnętrznym elementem TLV), metoda zwróci wartość kTLVType_NotOkreślified.

Zwraca bajt kontrolny powiązany z bieżącym elementem TLV.

W idealnej sytuacji nikt nigdy nie musi wiedzieć o bajcie kontrolnym i powinno mieć do niego dostęp tylko wewnętrzna implementacja TLV. Dostęp do bajtu kontrolnego może jednak pomagać w debugowaniu w narzędziach TLVDebugTools (które próbują zdekodować bajt kontrolny tagu podczas drukowania zawartości bufora TLV).

Znajdź wskaźnik do początkowo zakodowanego bajtu bajtu TLV lub elementu ciągu UTF8.

Ta metoda zwraca bezpośredni wskaźnik zakodowaną wartość ciągu w bazowym buforze danych wejściowych. Aby ta metoda się udała, cała wartość ciągu musi znajdować się w jednym buforze. W przeciwnym razie zwraca wartość WEAVE_ERROR_TLV_UNDERRUN. Dzięki temu ta metoda może mieć ograniczone zastosowanie przy odczytywaniu danych z wielu nieprzylegających buforów.

Zwraca długość danych powiązanych z bieżącym elementem TLV.

Długość danych dotyczy tylko elementów typu UTF8 lub ciągu bajtów. W przypadku ciągów UTF8 zwracaną wartością jest liczba bajtów w ciągu znaków, a nie liczby znaków.

Zwraca łączną liczbę bajtów odczytanych od czasu zainicjowania czytnika.

Pobiera punkt w bazowym buforze danych wejściowych, który odpowiada bieżącej pozycji czytelnika.

Zwraca łączną liczbę bajtów, które mogą być odczytywane do momentu osiągnięcia maksymalnej długości odczytu.

Pobierz wartość bieżącego bajta lub elementu ciągu UTF8 jako ciąg znaków zakończony wartością null.

Aby określić wymagany rozmiar bufora wejściowego, przed wywołaniem funkcji GetBytes() wywołaj metodę GetLength(). Aby można było zmieścić znak null, bufor wejściowy powinien być o co najmniej 1 bajt większy od długości ciągu znaków.

Zwraca tag powiązany z bieżącym elementem TLV.

Wartości zwracanej przez funkcję GetTag() można używać z funkcjami narzędzia do tagów (IsProfileTag(), IsContextTag(), ProfileIdFromTag() itp.) do określenia typu tagu i wyodrębniania różnych wartości pól tagu.

Zwraca typ bieżącego elementu TLV.

Inicjuje obiekt TLVReader z innego obiektu TLVReader.

Inicjuje obiekt TLVReader do odczytu z jednego bufora wejściowego.

Inicjuje obiekt TLVReader do odczytu z pojedynczego obiektu PacketBuffer.

Analiza rozpoczyna się od pozycji początkowej bufora (buf->DataStart()) i trwa aż do końca danych w buforze (co oznacza buf->Datalen()) lub do przeanalizowania bajtów maxLen.

Inicjuje obiekt TLVReader w celu odczytu z co najmniej jednego obiektu PacketBuffer.

Analiza rozpoczyna się od pozycji początkowej bufora (buf->DataStart()). Jeśli parametr allowDiscontiguousBuffers ma wartość prawda, czytelnik przechodzi przez łańcuch buforów połączonych wskaźnikami Next(). Analiza jest kontynuowana, dopóki nie zostaną wykorzystane wszystkie dane w łańcuchu bufora (oznaczone jako buf->Datalen()) lub dopóki nie zostaną przeanalizowane bajty maxLen.

Przewija obiekt TLVReader do następnego elementu TLV do odczytu.

Metoda Next() umieszcza obiekt czytnika w następnym elemencie w kodowaniu TLV, który znajduje się w tym samym kontekście ograniczenia. W szczególności jeśli czytnik znajduje się na najbardziej zewnętrznym poziomie kodowania TLV, wywołanie funkcji Next() spowoduje przeniesienie go do następnego elementu znajdującego się u góry góry. Jeśli czytnik znajduje się w elemencie kontenera TLV (strukturze, tablicy lub ścieżce), wywołanie funkcji Next() przeniesie go do następnego elementu kontenera.

Funkcja Next() ogranicza ruch czytnika do bieżącego kontekstu zawartości, dlatego wywołanie funkcji Next(), gdy czytelnik znajduje się w elemencie kontenera, przechodzi nad kontenerem, pomijając jego elementy składowe (oraz elementy wszystkich zagnieżdżonych kontenerów), aż dotrze do pierwszego elementu po kontenerze.

Gdy w konkretnym kontekście zawartości nie ma innych elementów, metoda Next() zwraca błąd WEAVE_END_OF_TLV, a położenie czytnika pozostanie niezmienione.

Przewija obiekt TLVReader do następnego elementu TLV, który ma zostać odczytany, potwierdzając typ i tag nowego elementu.

Metoda Next(TLVTypeexpectedType, uint64_texpectedTag) jest metodą udogodnienia, która działa tak samo jak funkcja Next(), ale sprawdza też, czy typ i tag nowego elementu TLV są zgodne z podanymi argumentami.

Inicjuje nowy obiekt TLVReader do odczytu elementów kontenera TLV.

Metoda OpenContainer() inicjuje nowy obiekt TLVReader do odczytu elementów składowych kontenera TLV (struktury, tablicy lub ścieżki). Po wywołaniu funkcji OpenContainer() bieżący obiekt TLVReader musi zostać umieszczony w elemencie kontenera, który ma być odczytywany. Jako jedynym argumentem tej metody jest odwołanie do nowego czytnika, który zostanie zainicjowany w celu odczytu kontenera. Ten czytnik jest nazywany czytnikiem kontenerów, a czytnik, w przypadku którego wywoływana jest funkcja OpenContainer(), nazywany czytnikiem nadrzędnym.

Po powrocie metody OpenContainer() czytnik kontenerów jest umieszczany bezpośrednio przed pierwszym elementem kontenera. Wywołanie Next() na czytniku kontenera będzie przechodzić przez elementy zbioru aż do osiągnięcia wartości końcowej, po której czytelnik zwróci wartość WEAVE_END_OF_TLV.

Gdy czytnik kontenerów jest otwarty, aplikacje nie mogą wywoływać ani w inny sposób zmieniać stanu czytnika nadrzędnego. Gdy aplikacja skończy korzystać z czytnika kontenerów, musi ją zamknąć, wywołując na czytniku nadrzędnym wywołanie CloseContainer(), przekazując czytnik kontenerów jako argument. Aplikacje mogą zamknąć czytnik kontenerów w dowolnym momencie, nawet bez odczytu wszystkich elementów w bazowym kontenerze. Po zamknięciu czytnika kontenerów aplikacje mogą dalej z niego korzystać.

Czytnik kontenerów dziedziczy różne właściwości konfiguracji z czytnika nadrzędnego. Dostępne symbole:

• Niejawny identyfikator profilu (ImplicitProfileId)
• wskaźnik danych aplikacji (AppData)
• Wskaźnik funkcji GetNextBuffer

Przesuwa obiekt TLVReader na bieżący element TLV.

Metoda Skip() umieszcza obiekt czytnika bezpośrednio po bieżącym elemencie TLV, tak aby kolejne wywołanie funkcji Next() skierowało czytelnika do kolejnego elementu. Podobnie jak w przypadku funkcji Next(), jeśli w momencie wywołania czytelnik zostanie umieszczony na elemencie kontenera, elementy kontenera zostaną pominięte. Jeśli czytnik nie jest umieszczony na żadnym elemencie, jego położenie pozostaje niezmienione.

Sprawdza, czy obiekt TVLReader znajduje się na końcu kontenera TLV.

Metoda VerifyEndOfContainer() sprawdza, czy w bieżącym kontenerze TLV nie ma dalszych elementów TLV do odczytu. Jest to wygodna metoda, która odpowiada wywołaniu funkcji Next() i sprawdzaniu zwracanej wartości WEAVE_END_OF_TLV.

Wyczyść stan TLVReader.

Ta metoda służy do umieszczania czytnika przed pierwszym TLV, między TLV lub po ostatnim TLV.

To jest metoda prywatna, która zwraca TLVElementType z mControlByte.

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
)