nl::Weave::TLV::Utilities

Este espacio de nombres incluye interfaces de utilidad y tipos para administrar y trabajar con TLV de Weave.

Resumen

Typedefs

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

remotas

Count(const TLVReader & aReader, size_t & aCount)
Cuenta la cantidad de elementos TLV dentro del lector TLV especificado y descendentes en arrays o estructuras.
Count(const TLVReader & aReader, size_t & aCount, const bool aRecurse)
Cuenta la cantidad de elementos TLV dentro del lector de TLV especificado y, de manera opcional, descendente en arreglos o estructuras.
CountHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Aumenta el contador cuando iteras con los datos de TLV.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult)
Busca la etiqueta especificada dentro del lector TLV proporcionado.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult, const bool aRecurse)
Busca la etiqueta especificada dentro del lector TLV proporcionado, de manera opcional en orden descendente según los arrays o las estructuras.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult)
Busca el primer elemento que coincida con el predicado dentro del lector TLV descendente en arreglos o estructuras.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult, const bool aRecurse)
Busca el primer elemento que coincida con el predicado dentro del lector TLV, de forma opcional, descendente en arreglos o estructuras.
FindHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Busca la etiqueta especificada dentro del lector TLV proporcionado.
FindPredicateHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Iterate(TLVReader & aReader, size_t aDepth, IterateHandler aHandler, void *aContext, bool aRecurse)
Itera los datos de TLV a los que hace referencia aReader y, luego, invoca aHandler para cada elemento TLV visitado en el contexto de aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext)
Itera los datos de TLV a los que hace referencia aReader y, luego, invoca aHandler para cada elemento TLV visitado en el contexto de aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext, const bool aRecurse)
Itera los datos de TLV a los que hace referencia aReader y, luego, invoca aHandler para cada elemento TLV visitado en el contexto 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)

remotas

Recuento

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

Cuenta la cantidad de elementos TLV dentro del lector TLV especificado y descendentes en arrays o estructuras.

Detalles
Parámetros
[in] aReader
Es una referencia de solo lectura al lector de TLV para el que se cuenta la cantidad de elementos TLV.
[in,out] aCount
Es una referencia al almacenamiento para el recuento que se muestra. Se inicializa en cero (0) antes del recuento y se establece en el número de elementos que se cuentan tras el éxito.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación es exitosa.

Recuento

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

Cuenta la cantidad de elementos TLV dentro del lector de TLV especificado y, de manera opcional, descendente en arreglos o estructuras.

Detalles
Parámetros
[in] aReader
Es una referencia de solo lectura al lector de TLV para el que se cuenta la cantidad de elementos TLV.
[in,out] aCount
Es una referencia al almacenamiento para el recuento que se muestra. Se inicializa en cero (0) antes del recuento y se establece en el número de elementos que se cuentan tras el éxito.
[in] aRecurse
Es un valor booleano que indica si (verdadero) o no (falso) cualquier matriz o estructura encontrada debe descenderse.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación es exitosa.

CountHandler

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

Aumenta el contador cuando iteras con los datos de TLV.

Detalles
Parámetros
[in] aReader
Es una referencia al lector de TLV que contiene los datos de TLV para contar la cantidad de elementos de TLV.
[in] aDepth
La profundidad actual de los datos de TLV.
[in,out] aContext
Un puntero para el contexto específico del controlador que es un puntero al almacenamiento para el valor de recuento.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación es exitosa.
WEAVE_ERROR_INVALID_ARGUMENT
Si aContext es NULL.

Buscar

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

Busca la etiqueta especificada dentro del lector TLV proporcionado.

Detalles
Parámetros
[in] aReader
Una referencia de solo lectura al lector TLV en el que se encuentra la etiqueta especificada.
[in] aTag
Es una referencia de solo lectura a la etiqueta TLV para encontrar.
[out] aResult
Es una referencia al almacenamiento para un lector de TLV que se posicionará en la etiqueta especificada cuando se realice de forma correcta.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación es exitosa.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Si no se encontró la etiqueta aTag especificada.

Buscar

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

Busca la etiqueta especificada dentro del lector TLV proporcionado, de manera opcional en orden descendente según los arrays o las estructuras.

Detalles
Parámetros
[in] aReader
Una referencia de solo lectura al lector TLV en el que se encuentra la etiqueta especificada.
[in] aTag
Es una referencia de solo lectura a la etiqueta TLV para encontrar.
[out] aResult
Es una referencia al almacenamiento para un lector de TLV que se posicionará en la etiqueta especificada cuando se realice de forma correcta.
[in] aRecurse
Es un valor booleano que indica si (verdadero) o no (falso) cualquier matriz o estructura encontrada debe descenderse.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación es exitosa.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Si no se encontró la etiqueta aTag especificada.

Buscar

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

Busca el primer elemento que coincida con el predicado dentro del lector TLV descendente en arreglos o estructuras.

El aPredicate se aplica a cada elemento TLV visitado; aPredicate mostrará WEAVE_ERROR_MAX para los elementos coincidentes, WEAVE_NO_ERROR para los elementos no coincidentes y cualquier otro valor para finalizar la búsqueda.

Detalles
Parámetros
[in] aReader
Una referencia de solo lectura al lector TLV en el que se encuentra el elemento que coincide con el predicado.
[in] aPredicate
Un predicado que se aplicará a cada elemento TLV. Para admitir la reutilización de código, aPredicate tiene el tipo IterateHandler. El valor que se muestra de aPredicate controla la búsqueda: WEAVE_ERROR_MAX indica que se encontró el elemento deseado, WEAVE_NO_ERROR indica que no se encontró el elemento deseado y todos los demás valores indican que la saerch debe finalizar.
[in] aContext
Un puntero opcional para datos de contexto proporcionados por el emisor.
[out] aResult
Es una referencia al almacenamiento para un lector de TLV que se posicionará en la etiqueta especificada cuando se realice de forma correcta.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación es exitosa.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Si el aPredicate especificado no encontró el elemento especificado

Buscar

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

Busca el primer elemento que coincida con el predicado dentro del lector TLV, de forma opcional, descendente en arreglos o estructuras.

El aPredicate se aplica a cada elemento TLV visitado; aPredicate mostrará WEAVE_ERROR_MAX para los elementos coincidentes, WEAVE_NO_ERROR para los elementos no coincidentes y cualquier otro valor para finalizar la búsqueda.

Detalles
Parámetros
[in] aReader
Una referencia de solo lectura al lector TLV en el que se encuentra el elemento que coincide con el predicado.
[in] aPredicate
Un predicado que se aplicará a cada elemento TLV. Para admitir la reutilización de código, aPredicate tiene el tipo IterateHandler. El valor que se muestra de aPredicate controla la búsqueda: WEAVE_ERROR_MAX indica que se encontró el elemento deseado, WEAVE_NO_ERROR indica que no se encontró el elemento deseado y todos los demás valores indican que la saerch debe finalizar.
[in] aContext
Un puntero opcional para datos de contexto proporcionados por el emisor.
[out] aResult
Es una referencia al almacenamiento para un lector de TLV que se posicionará en la etiqueta especificada cuando se realice de forma correcta.
[in] aRecurse
Valor booleano que indica si (verdadero) o no (falso) cualquier matriz o estructura encontrada debe descenderse.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación es exitosa.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Si el aPredicate especificado no encontró el elemento especificado

FindHandler

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

Busca la etiqueta especificada dentro del lector TLV proporcionado.

Detalles
Parámetros
[in] aReader
Una referencia de solo lectura al lector TLV en el que se encuentra la etiqueta especificada.
[in] aDepth
La profundidad actual de los datos de TLV.
[in,out] aContext
Un puntero para el contexto específico del controlador.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación es exitosa.
WEAVE_ERROR_INVALID_ARGUMENT
Si aContext es NULL.
WEAVE_ERROR_MAX
Si se encuentra la etiqueta especificada.

FindPredicateHandler

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

Iteración

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

Itera los datos de TLV a los que hace referencia aReader y, luego, invoca aHandler para cada elemento TLV visitado en el contexto de aContext.

La iteración se anula si aHandler muestra cualquier otro elemento que no sea WEAVE_NO_ERROR.

Detalles
Parámetros
[in] aReader
Es una referencia al lector de TLV que contiene los datos de TLV para iterar.
[in] aDepth
La profundidad actual de los datos de TLV.
[in] aHandler
Es una devolución de llamada para invocar el elemento TLV actual que se visita.
[in,out] aContext
Un puntero opcional para datos de contexto proporcionados por el emisor.
[in] aRecurse
Es un valor booleano que indica si (verdadero) o no (falso) cualquier matriz o estructura encontrada debe descenderse.
Valores que se muestran
WEAVE_END_OF_TLV
En una iteración correcta al final de una codificación TLV o al final de un contenedor TLV
The
último valor que muestra aHandler, si es diferente de WEAVE_NO_ERROR

Iteración

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

Itera los datos de TLV a los que hace referencia aReader y, luego, invoca aHandler para cada elemento TLV visitado en el contexto de aContext.

La iteración se anula si aHandler muestra cualquier otro elemento que no sea WEAVE_NO_ERROR.

Detalles
Parámetros
[in] aReader
Es una referencia al lector de TLV que contiene los datos de TLV para iterar.
[in] aHandler
Es una devolución de llamada para invocar el elemento TLV actual que se visita.
[in,out] aContext
Un puntero opcional para datos de contexto proporcionados por el emisor.
Valores que se muestran
WEAVE_END_OF_TLV
En una iteración correcta al final de una codificación TLV o al final de un contenedor TLV
WEAVE_ERROR_INVALID_ARGUMENT
Si aHandler es NULO.
The
último valor que muestra aHandler, si es diferente de WEAVE_NO_ERROR

Iteración

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

Itera los datos de TLV a los que hace referencia aReader y, luego, invoca aHandler para cada elemento TLV visitado en el contexto de aContext.

La iteración se anula si aHandler muestra cualquier otro elemento que no sea WEAVE_NO_ERROR.

Detalles
Parámetros
[in] aReader
Es una referencia al lector de TLV que contiene los datos de TLV para iterar.
[in] aHandler
Es una devolución de llamada para invocar el elemento TLV actual que se visita.
[in,out] aContext
Un puntero opcional para datos de contexto proporcionados por el emisor.
[in] aRecurse
Es un valor booleano que indica si (verdadero) o no (falso) cualquier matriz o estructura encontrada debe descenderse.
Valores que se muestran
WEAVE_END_OF_TLV
En una iteración correcta al final de una codificación TLV o al final de un contenedor TLV
WEAVE_ERROR_INVALID_ARGUMENT
Si aHandler es NULO.
The
último valor que muestra aHandler, si es diferente de WEAVE_NO_ERROR