nl::Weave::TLV::Utilities

Ta przestrzeń nazw obejmuje typy i interfejsy narzędziowe umożliwiające zarządzanie TLV Weave i pracę z nim.

Podsumowanie

Definicje typów
IterateHandler)(const TLVReader &aReader, size_t aDepth, void *aContext) typedef

Funkcje
Count(const TLVReader & aReader, size_t & aCount)
Policz elementy TLV w określonym czytniku TLV, malejąco według tablic lub struktur.
Count(const TLVReader & aReader, size_t & aCount, const bool aRecurse)
Policz elementy TLV w określonym czytniku TLV, opcjonalnie malejąco według tablic lub struktur.
CountHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Zwiększ licznik podczas iteracji danych TLV.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult)
Wyszukaj określony tag w udostępnionym czytniku TLV.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult, const bool aRecurse)
Wyszukaj określony tag w udostępnionym czytniku TLV, opcjonalnie malejąco do tablic lub struktur.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult)
Wyszukaj pierwszy element pasujący do predykatu w czytniku TLV malejąco w tablice lub struktury.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult, const bool aRecurse)
W czytniku TLV wyszukaj pierwszy element pasujący do predykatu, opcjonalnie malejąco według tablic lub struktur.
FindHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Wyszukaj określony tag w udostępnionym czytniku TLV.
FindPredicateHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Iterate(TLVReader & aReader, size_t aDepth, IterateHandler aHandler, void *aContext, bool aRecurse)
Przejrzyj dane TLV, do których odwołuje się aReader, i wywołaj metodę aHandler dla każdego odwiedzanego elementu TLV w kontekście elementu aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext)
Przejrzyj dane TLV, do których odwołuje się aReader, i wywołaj metodę aHandler dla każdego odwiedzanego elementu TLV w kontekście elementu aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext, const bool aRecurse)
Przejrzyj dane TLV, do których odwołuje się aReader, i wywołaj metodę aHandler dla każdego odwiedzanego elementu TLV w kontekście elementu aContext.

Konstrukcja
nl::Weave::TLV::Utilities::FindContext
nl::Weave::TLV::Utilities::FindPredicateContext

Definicje typów

IterateHandler

WEAVE_ERROR(* IterateHandler)(const TLVReader &aReader, size_t aDepth, void *aContext)

Funkcje

Liczba

WEAVE_ERROR Count(
  const TLVReader & aReader,
  size_t & aCount
)

Policz elementy TLV w określonym czytniku TLV, malejąco według tablic lub struktur.

Szczegóły
Parametry
[in] aReader
Odniesienie tylko do odczytu do czytnika TLV, w którym można zliczać elementy TLV.
[in,out] aCount
Odwołanie do miejsca na dane w zwracanej liczbie. Inicjowana jest wartość zero (0) przed liczeniem i ustawia się na liczbę elementów zliczonych po pomyślnym zakończeniu.
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.

Liczba

WEAVE_ERROR Count(
  const TLVReader & aReader,
  size_t & aCount,
  const bool aRecurse
)

Policz elementy TLV w określonym czytniku TLV, opcjonalnie malejąco według tablic lub struktur.

Szczegóły
Parametry
[in] aReader
Odniesienie tylko do odczytu do czytnika TLV, w którym można zliczać elementy TLV.
[in,out] aCount
Odwołanie do miejsca na dane w zwracanej liczbie. Inicjowana jest wartość zero (0) przed liczeniem i ustawia się na liczbę elementów zliczonych po pomyślnym zakończeniu.
[in] aRecurse
Wartość logiczna wskazująca, czy wartość (prawda) czy nie (fałsz) powinna zostać dodana do wszystkich napotkanych tablic lub struktur.
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.

CountHandler

WEAVE_ERROR CountHandler(
  const TLVReader & aReader,
  size_t aDepth,
  void *aContext
)

Zwiększ licznik podczas iteracji danych TLV.

Szczegóły
Parametry
[in] aReader
Odwołanie do czytnika TLV zawierającego dane TLV służące do zliczenia liczby elementów TLV.
[in] aDepth
Bieżąca głębokość danych TLV.
[in,out] aContext
Wskaźnik do kontekstu konkretnego modułu obsługi, który wskazuje informację o wartości liczby.
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.
WEAVE_ERROR_INVALID_ARGUMENT
Jeśli aContext ma wartość NULL.

Znajdź

WEAVE_ERROR Find(
  const TLVReader & aReader,
  const uint64_t & aTag,
  TLVReader & aResult
)

Wyszukaj określony tag w udostępnionym czytniku TLV.

Szczegóły
Parametry
[in] aReader
Odniesienie tylko do odczytu do czytnika TLV, w którym można znaleźć określony tag.
[in] aTag
Odniesienie tylko do odczytu do tagu TLV do znalezienia.
[out] aResult
Odwołanie do zapisu w czytniku TLV, które po pomyślnym zakończeniu zostanie umieszczone w określonym tagu.
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Jeśli nie znaleziono określonego tagu aTag.

Znajdź

WEAVE_ERROR Find(
  const TLVReader & aReader,
  const uint64_t & aTag,
  TLVReader & aResult,
  const bool aRecurse
)

Wyszukaj określony tag w udostępnionym czytniku TLV, opcjonalnie malejąco do tablic lub struktur.

Szczegóły
Parametry
[in] aReader
Odniesienie tylko do odczytu do czytnika TLV, w którym można znaleźć określony tag.
[in] aTag
Odniesienie tylko do odczytu do tagu TLV do znalezienia.
[out] aResult
Odwołanie do zapisu w czytniku TLV, które po pomyślnym zakończeniu zostanie umieszczone w określonym tagu.
[in] aRecurse
Wartość logiczna wskazująca, czy wartość (prawda) czy nie (fałsz) powinna zostać dodana do wszystkich napotkanych tablic lub struktur.
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Jeśli nie znaleziono określonego tagu aTag.

Znajdź

WEAVE_ERROR Find(
  const TLVReader & aReader,
  IterateHandler aPredicate,
  void *aContext,
  TLVReader & aResult
)

Wyszukaj pierwszy element pasujący do predykatu w czytniku TLV malejąco w tablice lub struktury.

Predykat jest stosowany do każdego odwiedzanego elementu TLV. Tag aPredicate powinien zwrócić wartość WEAVE_ERROR_MAX w przypadku pasujących elementów, WEAVE_NO_ERROR w przypadku niepasujących elementów i dowolną inną wartość, aby zakończyć wyszukiwanie.

Szczegóły
Parametry
[in] aReader
Odniesienie tylko do odczytu do czytnika TLV, w którym można znaleźć element pasujący do predykatu.
[in] aPredicate
Predykat stosowany do każdego elementu TLV. Aby umożliwić ponowne używanie kodu, aPredicate ma typ IterateHandler. Zwracana wartość predykatu steruje wyszukiwaniem: WEAVE_ERROR_MAX sygnalizuje, że znaleziono odpowiedni element, WEAVE_NO_ERROR – że nie znaleziono żądanego elementu, a wszystkie inne wartości sygnalizują, że saerch należy zakończyć.
[in] aContext
Opcjonalny wskaźnik do danych kontekstowych przekazywanych przez rozmówcę.
[out] aResult
Odwołanie do zapisu w czytniku TLV, które po pomyślnym zakończeniu zostanie umieszczone w określonym tagu.
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Jeśli określony element aPredicate nie znalazł określonego elementu

Znajdź

WEAVE_ERROR Find(
  const TLVReader & aReader,
  IterateHandler aPredicate,
  void *aContext,
  TLVReader & aResult,
  const bool aRecurse
)

W czytniku TLV wyszukaj pierwszy element pasujący do predykatu, opcjonalnie malejąco według tablic lub struktur.

Predykat jest stosowany do każdego odwiedzanego elementu TLV. Tag aPredicate powinien zwrócić wartość WEAVE_ERROR_MAX w przypadku pasujących elementów, WEAVE_NO_ERROR w przypadku niepasujących elementów i dowolną inną wartość, aby zakończyć wyszukiwanie.

Szczegóły
Parametry
[in] aReader
Odniesienie tylko do odczytu do czytnika TLV, w którym można znaleźć element pasujący do predykatu.
[in] aPredicate
Predykat stosowany do każdego elementu TLV. Aby umożliwić ponowne używanie kodu, aPredicate ma typ IterateHandler. Zwracana wartość predykatu steruje wyszukiwaniem: WEAVE_ERROR_MAX sygnalizuje, że znaleziono odpowiedni element, WEAVE_NO_ERROR – że nie znaleziono żądanego elementu, a wszystkie inne wartości sygnalizują, że saerch należy zakończyć.
[in] aContext
Opcjonalny wskaźnik do danych kontekstowych przekazywanych przez rozmówcę.
[out] aResult
Odwołanie do zapisu w czytniku TLV, które po pomyślnym zakończeniu zostanie umieszczone w określonym tagu.
[in] aRecurse
Wartość logiczna wskazująca, czy (prawda) czy nie (fałsz) należy uwzględnić wszystkie napotkane tablice lub struktury.
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Jeśli określony element aPredicate nie znalazł określonego elementu

FindHandler

WEAVE_ERROR FindHandler(
  const TLVReader & aReader,
  size_t aDepth,
  void *aContext
)

Wyszukaj określony tag w udostępnionym czytniku TLV.

Szczegóły
Parametry
[in] aReader
Odniesienie tylko do odczytu do czytnika TLV, w którym można znaleźć określony tag.
[in] aDepth
Bieżąca głębokość danych TLV.
[in,out] aContext
Wskaźnik do kontekstu właściwy dla modułu obsługi.
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.
WEAVE_ERROR_INVALID_ARGUMENT
Jeśli aContext ma wartość NULL.
WEAVE_ERROR_MAX
Jeśli określony tag zostanie znaleziony.

FindPredicateHandler

WEAVE_ERROR FindPredicateHandler(
  const TLVReader & aReader,
  size_t aDepth,
  void *aContext
)

Regulacja

WEAVE_ERROR Iterate(
  TLVReader & aReader,
  size_t aDepth,
  IterateHandler aHandler,
  void *aContext,
  bool aRecurse
)

Przejrzyj dane TLV, do których odwołuje się aReader, i wywołaj metodę aHandler dla każdego odwiedzanego elementu TLV w kontekście elementu aContext.

Iteracja zostaje przerwana, jeśli funkcja aHandler zwraca coś innego niż WEAVE_NO_ERROR

Szczegóły
Parametry
[in] aReader
Odniesienie do czytnika TLV zawierającego dane TLV do iteracji.
[in] aDepth
Bieżąca głębokość danych TLV.
[in] aHandler
Wywołanie zwrotne do aktualnie odwiedzanego elementu TLV.
[in,out] aContext
Opcjonalny wskaźnik do danych kontekstowych przekazywanych przez rozmówcę.
[in] aRecurse
Wartość logiczna wskazująca, czy wartość (prawda) czy nie (fałsz) powinna zostać dodana do wszystkich napotkanych tablic lub struktur.
Zwracane wartości
WEAVE_END_OF_TLV
udanego iteracji na koniec kodowania TLV lub na koniec kontenera TLV.
The
ostatnia wartość zwrócona przez funkcję aHandler, jeśli jest inna niż WEAVE_NO_ERROR

Regulacja

WEAVE_ERROR Iterate(
  const TLVReader & aReader,
  IterateHandler aHandler,
  void *aContext
)

Przejrzyj dane TLV, do których odwołuje się aReader, i wywołaj metodę aHandler dla każdego odwiedzanego elementu TLV w kontekście elementu aContext.

Iteracja zostaje przerwana, jeśli funkcja aHandler zwraca coś innego niż WEAVE_NO_ERROR

Szczegóły
Parametry
[in] aReader
Odniesienie do czytnika TLV zawierającego dane TLV do iteracji.
[in] aHandler
Wywołanie zwrotne do aktualnie odwiedzanego elementu TLV.
[in,out] aContext
Opcjonalny wskaźnik do danych kontekstowych przekazywanych przez rozmówcę.
Zwracane wartości
WEAVE_END_OF_TLV
udanego iteracji na koniec kodowania TLV lub na koniec kontenera TLV.
WEAVE_ERROR_INVALID_ARGUMENT
Jeśli aHandler ma wartość NULL.
The
ostatnia wartość zwrócona przez funkcję aHandler, jeśli jest inna niż WEAVE_NO_ERROR

Regulacja

WEAVE_ERROR Iterate(
  const TLVReader & aReader,
  IterateHandler aHandler,
  void *aContext,
  const bool aRecurse
)

Przejrzyj dane TLV, do których odwołuje się aReader, i wywołaj metodę aHandler dla każdego odwiedzanego elementu TLV w kontekście elementu aContext.

Iteracja zostaje przerwana, jeśli funkcja aHandler zwraca coś innego niż WEAVE_NO_ERROR

Szczegóły
Parametry
[in] aReader
Odniesienie do czytnika TLV zawierającego dane TLV do iteracji.
[in] aHandler
Wywołanie zwrotne do aktualnie odwiedzanego elementu TLV.
[in,out] aContext
Opcjonalny wskaźnik do danych kontekstowych przekazywanych przez rozmówcę.
[in] aRecurse
Wartość logiczna wskazująca, czy wartość (prawda) czy nie (fałsz) powinna zostać dodana do wszystkich napotkanych tablic lub struktur.
Zwracane wartości
WEAVE_END_OF_TLV
udanego iteracji na koniec kodowania TLV lub na koniec kontenera TLV.
WEAVE_ERROR_INVALID_ARGUMENT
Jeśli aHandler ma wartość NULL.
The
ostatnia wartość zwrócona przez funkcję aHandler, jeśli jest inna niż WEAVE_NO_ERROR