nl::Weave::TLV::Utilities

Ta przestrzeń nazw zawiera typy i interfejsy narzędziowe do zarządzania Weave TLV i zarządzania nimi.

Podsumowanie

Definiuje typ
IterateHandler)(const TLVReader &aReader, size_t aDepth, void *aContext) typedef

Funkcje
Count(const TLVReader & aReader, size_t & aCount)
Zlicza elementy TLV w określonym czytniku TLV malejąco do tablic lub struktur.
Count(const TLVReader & aReader, size_t & aCount, const bool aRecurse)
Zlicza elementy TLV w określonym czytniku TLV, opcjonalnie malejąco do tablic lub struktur.
CountHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Zwiększ licznik podczas iteracji za pomocą 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 podanym czytniku TLV, opcjonalnie obserwując tablice lub struktury.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult)
W czytniku TLV wyszukaj pierwszy element pasujący do predykatu, malejący do tablic lub struktur.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult, const bool aRecurse)
Wyszukaj w czytniku TLV pierwszy element pasujący do predykatu, opcjonalnie malejący do 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ę moduł aReader, i wywołuj metodę aHandler dla każdego odwiedzonego elementu TLV w kontekście aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext)
Przejrzyj dane TLV, do których odwołuje się moduł aReader, i wywołuj metodę aHandler dla każdego odwiedzonego elementu TLV w kontekście aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext, const bool aRecurse)
Przejrzyj dane TLV, do których odwołuje się moduł aReader, i wywołuj metodę aHandler dla każdego odwiedzonego elementu TLV w kontekście aContext.

Struktura
nl::Weave::TLV::Utilities::FindContext
nl::Weave::TLV::Utilities::FindPredicateContext

Definiuje typ

IterateHandler

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

Funkcje

Liczba

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

Zlicza elementy TLV w określonym czytniku TLV malejąco do tablic lub struktur.

Szczegóły
Parametry
[in] aReader
Odwołanie tylko do odczytu do czytnika TLV, dla którego ma być zliczana liczba elementów TLV.
[in,out] aCount
Odwołanie do miejsca na dane dla zwróconej liczby. Przed zliczeniem wartość ta ma wartość 0 (0), a przy tym jest ustawiona liczba elementów liczonych w przypadku powodzenia.
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.

Liczba

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

Zlicza elementy TLV w określonym czytniku TLV, opcjonalnie malejąco do tablic lub struktur.

Szczegóły
Parametry
[in] aReader
Odwołanie tylko do odczytu do czytnika TLV, dla którego ma być zliczana liczba elementów TLV.
[in,out] aCount
Odwołanie do miejsca na dane dla zwróconej liczby. Przed zliczeniem wartość ta ma wartość 0 (0), a przy tym jest ustawiona liczba elementów liczonych w przypadku powodzenia.
[in] aRecurse
Wartość logiczna wskazująca, czy ma być uwzględniana wartość (prawda) lub (fałsz) wszelkie napotkane tablice lub struktury.
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.

CountHandler

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

Zwiększ licznik podczas iteracji za pomocą danych TLV.

Szczegóły
Parametry
[in] aReader
Odwołanie do czytnika TLV zawierającego dane TLV do zliczania elementów TLV.
[in] aDepth
Aktualna szczegółowość danych TLV.
[in,out] aContext
Wskaźnik do kontekstu powiązanego z modułem obsługi, który jest wskaźnikiem miejsca zapisu wartości liczby.
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.
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
Odwołanie tylko do odczytu do czytnika TLV, w którym można znaleźć określony tag.
[in] aTag
Odwołanie tylko do odczytu do tagu TLV do znalezienia.
[out] aResult
Odniesienie do pamięci masowej do czytnika TLV, który po udanym działaniu zostanie umieszczony pod określonym tagiem.
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.
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 podanym czytniku TLV, opcjonalnie obserwując tablice lub struktury.

Szczegóły
Parametry
[in] aReader
Odwołanie tylko do odczytu do czytnika TLV, w którym można znaleźć określony tag.
[in] aTag
Odwołanie tylko do odczytu do tagu TLV do znalezienia.
[out] aResult
Odniesienie do pamięci masowej do czytnika TLV, który po udanym działaniu zostanie umieszczony pod określonym tagiem.
[in] aRecurse
Wartość logiczna wskazująca, czy ma być uwzględniana wartość (prawda) lub (fałsz) wszelkie napotkane tablice lub struktury.
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.
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
)

W czytniku TLV wyszukaj pierwszy element pasujący do predykatu, malejący do tablic lub struktur.

aPredicate jest stosowany do każdego odwiedzonego elementu TLV. aPredicate zwróci wartość WEAVE_ERROR_MAX dla pasujących elementów, WEAVE_NO_ERROR w przypadku niepasujących elementów i wszelkie inne wartości, aby zakończyć wyszukiwanie.

Szczegóły
Parametry
[in] aReader
Odwołanie 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 możliwe było ponowne użycie kodu, aPredykat ma typ IterateHandler. Wartość zwrócona przez aPredykat kontroluje wyszukiwanie: WEAVE_ERROR_MAX wskazuje, że dany element został znaleziony, WEAVE_NO_ERROR – że nie znaleziono żądanego elementu, a wszystkie inne wartości – że saerch musi zostać zakończony.
[in] aContext
Opcjonalny wskaźnik do danych kontekstowych przekazanych przez dzwoniącego.
[out] aResult
Odniesienie do pamięci masowej do czytnika TLV, który po udanym działaniu zostanie umieszczony pod określonym tagiem.
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.
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
)

Wyszukaj w czytniku TLV pierwszy element pasujący do predykatu, opcjonalnie malejący do tablic lub struktur.

aPredicate jest stosowany do każdego odwiedzonego elementu TLV. aPredicate zwróci wartość WEAVE_ERROR_MAX dla pasujących elementów, WEAVE_NO_ERROR w przypadku niepasujących elementów i wszelkie inne wartości, aby zakończyć wyszukiwanie.

Szczegóły
Parametry
[in] aReader
Odwołanie 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 możliwe było ponowne użycie kodu, aPredykat ma typ IterateHandler. Wartość zwrócona przez aPredykat kontroluje wyszukiwanie: WEAVE_ERROR_MAX wskazuje, że dany element został znaleziony, WEAVE_NO_ERROR – że nie znaleziono żądanego elementu, a wszystkie inne wartości – że saerch musi zostać zakończony.
[in] aContext
Opcjonalny wskaźnik do danych kontekstowych przekazanych przez dzwoniącego.
[out] aResult
Odniesienie do pamięci masowej do czytnika TLV, który po udanym działaniu zostanie umieszczony pod określonym tagiem.
[in] aRecurse
Wartość logiczna wskazująca, czy (prawda) lub nie (fałsz) dotyczą jakichkolwiek napotkanych tablic lub struktur.
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.
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
Odwołanie tylko do odczytu do czytnika TLV, w którym można znaleźć określony tag.
[in] aDepth
Aktualna szczegółowość danych TLV.
[in,out] aContext
wskaźnik do kontekstu powiązanego z modułem obsługi;
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.
WEAVE_ERROR_INVALID_ARGUMENT
Jeśli aContext ma wartość NULL.
WEAVE_ERROR_MAX
Jeśli zostanie znaleziony określony tag.

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ę moduł aReader, i wywołuj metodę aHandler dla każdego odwiedzonego elementu TLV w kontekście aContext.

Iteracja zostanie przerwana, jeśli aHandler zwróci jakąkolwiek inną wartość niż WEAVE_NO_ERROR

Szczegóły
Parametry
[in] aReader
Odwołanie do czytnika TLV zawierającego dane TLV do iteracji.
[in] aDepth
Aktualna szczegółowość danych TLV.
[in] aHandler
Wywołanie zwrotne do wywołania bieżącego elementu TLV.
[in,out] aContext
Opcjonalny wskaźnik do danych kontekstowych przekazanych przez dzwoniącego.
[in] aRecurse
Wartość logiczna wskazująca, czy ma być uwzględniana wartość (prawda) lub (fałsz) wszelkie napotkane tablice lub struktury.
Zwracane wartości
WEAVE_END_OF_TLV
Po udanej iteracji na końcu kodowania TLV lub na końcu 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ę moduł aReader, i wywołuj metodę aHandler dla każdego odwiedzonego elementu TLV w kontekście aContext.

Iteracja zostanie przerwana, jeśli aHandler zwróci jakąkolwiek inną wartość niż WEAVE_NO_ERROR

Szczegóły
Parametry
[in] aReader
Odwołanie do czytnika TLV zawierającego dane TLV do iteracji.
[in] aHandler
Wywołanie zwrotne do wywołania bieżącego elementu TLV.
[in,out] aContext
Opcjonalny wskaźnik do danych kontekstowych przekazanych przez dzwoniącego.
Zwracane wartości
WEAVE_END_OF_TLV
Po udanej iteracji na końcu kodowania TLV lub na końcu 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ę moduł aReader, i wywołuj metodę aHandler dla każdego odwiedzonego elementu TLV w kontekście aContext.

Iteracja zostanie przerwana, jeśli aHandler zwróci jakąkolwiek inną wartość niż WEAVE_NO_ERROR

Szczegóły
Parametry
[in] aReader
Odwołanie do czytnika TLV zawierającego dane TLV do iteracji.
[in] aHandler
Wywołanie zwrotne do wywołania bieżącego elementu TLV.
[in,out] aContext
Opcjonalny wskaźnik do danych kontekstowych przekazanych przez dzwoniącego.
[in] aRecurse
Wartość logiczna wskazująca, czy ma być uwzględniana wartość (prawda) lub (fałsz) wszelkie napotkane tablice lub struktury.
Zwracane wartości
WEAVE_END_OF_TLV
Po udanej iteracji na końcu kodowania TLV lub na końcu 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.