nl::Weave::TLV::Utilities

Cet espace de noms comprend des types et des interfaces utilitaires permettant de gérer et d'utiliser les TLV Weave.

Résumé

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

Fonctions
Count(const TLVReader & aReader, size_t & aCount)
Comptez le nombre d'éléments TLV dans le lecteur TLV spécifié, dans l'ordre décroissant en tableaux ou structures.
Count(const TLVReader & aReader, size_t & aCount, const bool aRecurse)
Compte le nombre d'éléments TLV dans le lecteur TLV spécifié, éventuellement dans des tableaux ou structures.
CountHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Incrémentez le compteur lors de l'itération des données TLV.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult)
Recherchez la balise spécifiée dans le lecteur TLV fourni.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult, const bool aRecurse)
Recherchez la balise spécifiée dans le lecteur TLV fourni, en partant de zéro dans des tableaux ou structures.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult)
Recherchez le premier élément correspondant au prédicat dans le lecteur TLV, descendant sous forme de tableaux ou de structures.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult, const bool aRecurse)
Recherchez le premier élément correspondant au prédicat dans le lecteur TLV, descendant éventuellement dans des tableaux ou des structures.
FindHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Recherchez la balise spécifiée dans le lecteur TLV fourni.
FindPredicateHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Iterate(TLVReader & aReader, size_t aDepth, IterateHandler aHandler, void *aContext, bool aRecurse)
Parcourez les données TLV référencées par aReader et appelez aHandler pour chaque élément TLV consulté dans le contexte d'aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext)
Parcourez les données TLV référencées par aReader et appelez aHandler pour chaque élément TLV consulté dans le contexte d'aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext, const bool aRecurse)
Parcourez les données TLV référencées par aReader et appelez aHandler pour chaque élément TLV consulté dans le contexte d'aContext.

Structs
nl::Weave::TLV::Utilities::FindContext
nl::Weave::TLV::Utilities::FindPredicateContext

Typedefs

IterateHandler

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

Fonctions

Nombre

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

Comptez le nombre d'éléments TLV dans le lecteur TLV spécifié, dans l'ordre décroissant en tableaux ou structures.

Détails
Paramètres
[in] aReader
Référence en lecture seule au lecteur TLV pour laquelle compter le nombre d'éléments TLV.
[in,out] aCount
Référence au stockage pour le nombre renvoyé. Cette valeur est initialisée sur zéro (0) avant le comptage et est définie sur le nombre d'éléments comptabilisés en cas de réussite.
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.

Nombre

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

Compte le nombre d'éléments TLV dans le lecteur TLV spécifié, éventuellement dans des tableaux ou structures.

Détails
Paramètres
[in] aReader
Référence en lecture seule au lecteur TLV pour laquelle comptabiliser le nombre d'éléments TLV.
[in,out] aCount
Référence au stockage pour le nombre renvoyé. Cette valeur est initialisée sur zéro (0) avant le comptage et est définie sur le nombre d'éléments comptabilisés en cas de réussite.
[in] aRecurse
Booléen indiquant si (vrai) ou non (faux) les tableaux ou structures rencontrés doivent être descendus.
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.

CountHandler

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

Incrémentez le compteur lors de l'itération des données TLV.

Détails
Paramètres
[in] aReader
Référence au lecteur TLV contenant les données TLV pour compter le nombre d'éléments TLV.
[in] aDepth
Profondeur actuelle dans les données TLV.
[in,out] aContext
Pointeur vers le contexte spécifique au gestionnaire, c'est-à-dire vers le stockage de la valeur de nombre.
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.
WEAVE_ERROR_INVALID_ARGUMENT
Si aContext est NULL.

Rechercher

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

Recherchez la balise spécifiée dans le lecteur TLV fourni.

Détails
Paramètres
[in] aReader
Référence en lecture seule au lecteur TLV, dans laquelle rechercher la balise spécifiée.
[in] aTag
Référence en lecture seule à la balise TLV à rechercher.
[out] aResult
Référence au stockage à un lecteur TLV qui sera positionné sur le tag spécifié en cas de réussite.
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Si la balise aTag spécifiée est introuvable.

Rechercher

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

Recherchez la balise spécifiée dans le lecteur TLV fourni, en partant de zéro dans des tableaux ou structures.

Détails
Paramètres
[in] aReader
Référence en lecture seule au lecteur TLV, dans laquelle rechercher la balise spécifiée.
[in] aTag
Référence en lecture seule à la balise TLV à rechercher.
[out] aResult
Référence au stockage à un lecteur TLV qui sera positionné sur le tag spécifié en cas de réussite.
[in] aRecurse
Booléen indiquant si (vrai) ou non (faux) les tableaux ou structures rencontrés doivent être descendus.
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Si la balise aTag spécifiée est introuvable.

Rechercher

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

Recherchez le premier élément correspondant au prédicat dans le lecteur TLV, dans l'ordre décroissant en tableaux ou structures.

aPredicate est appliqué à chaque élément TLV visité ; aPredicate renvoie WEAVE_ERROR_MAX pour les éléments correspondants, WEAVE_NO_ERROR pour les éléments qui ne correspondent pas et toute autre valeur pour mettre fin à la recherche.

Détails
Paramètres
[in] aReader
Référence en lecture seule au lecteur TLV, dans laquelle rechercher l'élément correspondant au prédicat.
[in] aPredicate
Un prédicat à appliquer à chaque élément TLV Pour permettre la réutilisation du code, aPredicate utilise le type IterateHandler. La valeur renvoyée par aPredicate contrôle la recherche: WEAVE_ERROR_MAX indique que l'élément souhaité a été trouvé, WEAVE_NO_ERROR indique que l'élément souhaité n'a pas été trouvé et toutes les autres valeurs indiquent que la recherche doit être arrêtée.
[in] aContext
Pointeur facultatif vers les données de contexte fournies par l'appelant.
[out] aResult
Référence au stockage à un lecteur TLV qui sera positionné sur le tag spécifié en cas de réussite.
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Si aPredicate spécifié n'a pas localisé l'élément spécifié

Rechercher

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

Recherchez le premier élément correspondant au prédicat dans le lecteur TLV, descendant éventuellement dans des tableaux ou des structures.

aPredicate est appliqué à chaque élément TLV visité ; aPredicate renvoie WEAVE_ERROR_MAX pour les éléments correspondants, WEAVE_NO_ERROR pour les éléments qui ne correspondent pas et toute autre valeur pour mettre fin à la recherche.

Détails
Paramètres
[in] aReader
Référence en lecture seule au lecteur TLV, dans laquelle rechercher l'élément correspondant au prédicat.
[in] aPredicate
Un prédicat à appliquer à chaque élément TLV Pour permettre la réutilisation du code, aPredicate utilise le type IterateHandler. La valeur renvoyée par aPredicate contrôle la recherche: WEAVE_ERROR_MAX indique que l'élément souhaité a été trouvé, WEAVE_NO_ERROR indique que l'élément souhaité n'a pas été trouvé et toutes les autres valeurs indiquent que la recherche doit être arrêtée.
[in] aContext
Pointeur facultatif vers les données de contexte fournies par l'appelant.
[out] aResult
Référence au stockage à un lecteur TLV qui sera positionné sur le tag spécifié en cas de réussite.
[in] aRecurse
Booléen indiquant si (vrai) ou non (faux) les tableaux ou structures rencontrés doivent descendre.
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Si aPredicate spécifié n'a pas localisé l'élément spécifié

FindHandler

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

Recherchez la balise spécifiée dans le lecteur TLV fourni.

Détails
Paramètres
[in] aReader
Référence en lecture seule au lecteur TLV, dans laquelle rechercher la balise spécifiée.
[in] aDepth
Profondeur actuelle dans les données TLV.
[in,out] aContext
Pointeur vers le contexte spécifique au gestionnaire.
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.
WEAVE_ERROR_INVALID_ARGUMENT
Si aContext est NULL.
WEAVE_ERROR_MAX
Si le tag spécifié est trouvé.

FindPredicateHandler

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

Itérations

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

Parcourez les données TLV référencées par aReader et appelez aHandler pour chaque élément TLV consulté dans le contexte d'aContext.

L'itération est annulée si aHandler renvoie autre chose que WEAVE_NO_ERROR.

Détails
Paramètres
[in] aReader
Référence au lecteur TLV contenant les données TLV à itérer.
[in] aDepth
Profondeur actuelle dans les données TLV.
[in] aHandler
Rappel à invoquer pour l'élément TLV actuellement consulté.
[in,out] aContext
Pointeur facultatif vers les données de contexte fournies par l'appelant.
[in] aRecurse
Booléen indiquant si (vrai) ou non (faux) les tableaux ou structures rencontrés doivent être descendus.
Valeurs renvoyées
WEAVE_END_OF_TLV
En cas d'itération réussie vers la fin d'un encodage TLV ou d'un conteneur TLV.
The
Dernière valeur renvoyée par aHandler, si différente de WEAVE_NO_ERROR

Itérations

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

Parcourez les données TLV référencées par aReader et appelez aHandler pour chaque élément TLV consulté dans le contexte d'aContext.

L'itération est annulée si aHandler renvoie autre chose que WEAVE_NO_ERROR.

Détails
Paramètres
[in] aReader
Référence au lecteur TLV contenant les données TLV à itérer.
[in] aHandler
Rappel à invoquer pour l'élément TLV actuellement consulté.
[in,out] aContext
Pointeur facultatif vers les données de contexte fournies par l'appelant.
Valeurs renvoyées
WEAVE_END_OF_TLV
En cas d'itération réussie vers la fin d'un encodage TLV ou d'un conteneur TLV.
WEAVE_ERROR_INVALID_ARGUMENT
Si aHandler est NULL.
The
Dernière valeur renvoyée par aHandler, si différente de WEAVE_NO_ERROR

Itérations

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

Parcourez les données TLV référencées par aReader et appelez aHandler pour chaque élément TLV consulté dans le contexte d'aContext.

L'itération est annulée si aHandler renvoie autre chose que WEAVE_NO_ERROR.

Détails
Paramètres
[in] aReader
Référence au lecteur TLV contenant les données TLV à itérer.
[in] aHandler
Rappel à invoquer pour l'élément TLV actuellement consulté.
[in,out] aContext
Pointeur facultatif vers les données de contexte fournies par l'appelant.
[in] aRecurse
Booléen indiquant si (vrai) ou non (faux) les tableaux ou structures rencontrés doivent être descendus.
Valeurs renvoyées
WEAVE_END_OF_TLV
En cas d'itération réussie vers la fin d'un encodage TLV ou d'un conteneur TLV.
WEAVE_ERROR_INVALID_ARGUMENT
Si aHandler est NULL.
The
Dernière valeur renvoyée par aHandler, si différente de WEAVE_NO_ERROR