Cette page a été traduite par l'API Cloud Translation.

nl::Weave::TLV::Utilities

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

Résumé

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

distantes
`Count(const TLVReader & aReader, size_t & aCount)`	`WEAVE_ERROR` Comptez le nombre d'éléments TLV dans le lecteur TLV spécifié, en ordre décroissant dans des tableaux ou des structures.
`Count(const TLVReader & aReader, size_t & aCount, const bool aRecurse)`	`WEAVE_ERROR` Compter le nombre d'éléments TLV dans le lecteur TLV spécifié, éventuellement dans des tableaux ou des structures par ordre décroissant.
`CountHandler(const TLVReader & aReader, size_t aDepth, void *aContext)`	`WEAVE_ERROR` Incrémentez le compteur lors de l'itération des données TLV.
`Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult)`	`WEAVE_ERROR` Recherchez le tag spécifié dans le lecteur TLV fourni.
`Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult, const bool aRecurse)`	`WEAVE_ERROR` Rechercher le tag spécifié dans le lecteur TLV fourni, éventuellement par ordre décroissant dans des tableaux ou des structures
`Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult)`	`WEAVE_ERROR` Recherchez le premier élément correspondant au prédicat dans le lecteur TLV en décroissant dans des tableaux ou des structures.
`Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult, const bool aRecurse)`	`WEAVE_ERROR` Recherchez le premier élément correspondant au prédicat dans le lecteur TLV (facultatif) par ordre décroissant dans des tableaux ou des structures.
`FindHandler(const TLVReader & aReader, size_t aDepth, void *aContext)`	`WEAVE_ERROR` Recherchez le tag spécifié dans le lecteur TLV fourni.
`FindPredicateHandler(const TLVReader & aReader, size_t aDepth, void *aContext)`	`WEAVE_ERROR`
`Iterate(TLVReader & aReader, size_t aDepth, IterateHandler aHandler, void *aContext, bool aRecurse)`	`WEAVE_ERROR` Parcourez les données TLV référencées par aReader et appelez aHandler pour chaque élément TLV consulté dans le contexte de aContext.
`Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext)`	`WEAVE_ERROR` Parcourez les données TLV référencées par aReader et appelez aHandler pour chaque élément TLV consulté dans le contexte de aContext.
`Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext, const bool aRecurse)`	`WEAVE_ERROR` Parcourez les données TLV référencées par aReader et appelez aHandler pour chaque élément TLV consulté dans le contexte de 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)

distantes

Nombre

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

Comptez le nombre d'éléments TLV dans le lecteur TLV spécifié, en ordre décroissant dans des tableaux ou des 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 à l'espace de stockage correspondant au nombre renvoyé. Ce paramètre est initialisé sur zéro (0) avant le comptage et défini sur le nombre d'éléments comptabilisés en cas de réussite.

Valeurs de retour

WEAVE_NO_ERROR

Pour la réussite.

Nombre

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

Compter le nombre d'éléments TLV dans le lecteur TLV spécifié, éventuellement dans des tableaux ou des structures par ordre décroissant.

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 à l'espace de stockage correspondant au nombre renvoyé. Ce paramètre est initialisé sur zéro (0) avant le comptage et défini sur le nombre d'éléments comptabilisés en cas de réussite.
`[in] aRecurse`	Booléen indiquant si (true) ou non (false) les tableaux ou structures rencontrés doivent être descendants.

Valeurs de retour

WEAVE_NO_ERROR

Pour la 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`	Une référence au lecteur TLV contenant les données TLV pour compter le nombre d'éléments TLV.
`[in] aDepth`	Profondeur actuelle des données TLV.
`[in,out] aContext`	Pointeur vers le contexte spécifique au gestionnaire, qui pointe vers l'espace de stockage pour la valeur "count".

Valeurs de retour

`WEAVE_NO_ERROR`	Pour la réussite.
`WEAVE_ERROR_INVALID_ARGUMENT`	Si aContext est NULL.

Rechercher

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

Recherchez le tag spécifié dans le lecteur TLV fourni.

Détails

Paramètres

`[in] aReader`	Référence en lecture seule au lecteur TLV dans lequel trouver la balise spécifiée.
`[in] aTag`	Référence en lecture seule à la balise TLV à rechercher.
`[out] aResult`	Référence au stockage pour un lecteur TLV qui sera positionné au niveau de la balise spécifiée en cas de réussite.

Valeurs de retour

`WEAVE_NO_ERROR`	Pour la 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
)

Rechercher le tag spécifié dans le lecteur TLV fourni, éventuellement par ordre décroissant dans des tableaux ou des structures

Détails

Paramètres

`[in] aReader`	Référence en lecture seule au lecteur TLV dans lequel trouver la balise spécifiée.
`[in] aTag`	Référence en lecture seule à la balise TLV à rechercher.
`[out] aResult`	Référence au stockage pour un lecteur TLV qui sera positionné au niveau de la balise spécifiée en cas de réussite.
`[in] aRecurse`	Booléen indiquant si (true) ou non (false) les tableaux ou structures rencontrés doivent être descendants.

Valeurs de retour

`WEAVE_NO_ERROR`	Pour la 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 en décroissant dans des tableaux ou des structures.

Le 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 arrêter la recherche.

Détails

Paramètres

`[in] aReader`	Référence en lecture seule au lecteur TLV dans laquelle trouver 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 est de type IterateHandler. La valeur renvoyée pour aPredicate contrôle la recherche: WEAVE_ERROR_MAX signale que l'élément souhaité a été trouvé, WEAVE_NO_ERROR indique que l'élément souhaité est introuvable, et toutes les autres valeurs indiquent que le saerch doit être arrêté.
`[in] aContext`	Pointeur facultatif vers les données contextuelles fournies par l'appelant.
`[out] aResult`	Référence au stockage pour un lecteur TLV qui sera positionné au niveau de la balise spécifiée en cas de réussite.

Valeurs de retour

`WEAVE_NO_ERROR`	Pour la réussite.
`WEAVE_ERROR_TLV_TAG_NOT_FOUND`	Si le 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 (facultatif) par ordre décroissant dans des tableaux ou des structures.

Détails

Paramètres

`[in] aReader`	Référence en lecture seule au lecteur TLV dans laquelle trouver 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 est associé au type IterateHandler. La valeur renvoyée pour aPredicate contrôle la recherche: WEAVE_ERROR_MAX signale que l'élément souhaité a été trouvé, WEAVE_NO_ERROR indique que l'élément souhaité est introuvable, et toutes les autres valeurs indiquent que le saerch doit être arrêté.
`[in] aContext`	Pointeur facultatif vers les données contextuelles fournies par l'appelant.
`[out] aResult`	Référence au stockage pour un lecteur TLV qui sera positionné au niveau de la balise spécifiée en cas de réussite.
`[in] aRecurse`	Booléen indiquant si les valeurs (true) ou (false) des tableaux ou structures doivent être descendues.

Valeurs de retour

`WEAVE_NO_ERROR`	Pour la réussite.
`WEAVE_ERROR_TLV_TAG_NOT_FOUND`	Si le 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 le tag spécifié dans le lecteur TLV fourni.

Détails

Paramètres

`[in] aReader`	Référence en lecture seule au lecteur TLV dans lequel trouver la balise spécifiée.
`[in] aDepth`	Profondeur actuelle des données TLV.
`[in,out] aContext`	Pointeur vers le contexte spécifique au gestionnaire.

Valeurs de retour

`WEAVE_NO_ERROR`	Pour la réussite.
`WEAVE_ERROR_INVALID_ARGUMENT`	Si aContext est NULL.
`WEAVE_ERROR_MAX`	Si la balise spécifiée est trouvée.

FindPredicateHandler

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

Optimisez

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 de aContext.

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

Détails

Paramètres

`[in] aReader`	Une référence au lecteur TLV contenant les données TLV à itérer.
`[in] aDepth`	Profondeur actuelle des données TLV.
`[in] aHandler`	Rappel à invoquer pour l'élément TLV actuellement visité.
`[in,out] aContext`	Pointeur facultatif vers les données contextuelles fournies par l'appelant.
`[in] aRecurse`	Booléen indiquant si (true) ou non (false) les tableaux ou structures rencontrés doivent être descendants.

Valeurs de retour

`WEAVE_END_OF_TLV`	Lors d'une itération réussie jusqu'à la fin d'un encodage TLV ou à la fin d'un conteneur TLV.
`The`	Dernière valeur renvoyée par aHandler, si différente de WEAVE_NO_ERROR

Optimisez

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 de aContext.

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

Détails

Paramètres

`[in] aReader`	Une référence au lecteur TLV contenant les données TLV à itérer.
`[in] aHandler`	Rappel à invoquer pour l'élément TLV actuellement visité.
`[in,out] aContext`	Pointeur facultatif vers les données contextuelles fournies par l'appelant.

Valeurs de retour

`WEAVE_END_OF_TLV`	Lors d'une itération réussie jusqu'à la fin d'un encodage TLV ou à la fin d'un conteneur TLV.
`WEAVE_ERROR_INVALID_ARGUMENT`	Si aHandler est défini sur NULL.
`The`	Dernière valeur renvoyée par aHandler, si différente de WEAVE_NO_ERROR

Optimisez

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 de aContext.

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

Détails

Paramètres

`[in] aReader`	Une référence au lecteur TLV contenant les données TLV à itérer.
`[in] aHandler`	Rappel à invoquer pour l'élément TLV actuellement visité.
`[in,out] aContext`	Pointeur facultatif vers les données contextuelles fournies par l'appelant.
`[in] aRecurse`	Booléen indiquant si (true) ou non (false) les tableaux ou structures rencontrés doivent être descendants.

Valeurs de retour

`WEAVE_END_OF_TLV`	Lors d'une itération réussie jusqu'à la fin d'un encodage TLV ou à la fin d'un conteneur TLV.
`WEAVE_ERROR_INVALID_ARGUMENT`	Si aHandler est défini sur NULL.
`The`	Dernière valeur renvoyée par aHandler, si différente de WEAVE_NO_ERROR

nl::Weave::TLV::Utilities

Résumé

Typedefs

distantes

Structs

Typedefs

IterateHandler

distantes

Nombre

Nombre

CountHandler

Rechercher

Rechercher

Rechercher

Rechercher

FindHandler

FindPredicateHandler

Optimisez

Optimisez

Optimisez