nl::Weave::TLV::Utilities

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

Resumen

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

Funciones
Count(const TLVReader & aReader, size_t & aCount)
Cuenta la cantidad de elementos TLV dentro del lector de TLV especificado desciende 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. Opcionalmente, desciende a arrays o estructuras.
CountHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Incrementa el contador cuando iteres a través de los datos de TLV.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult)
Busca la etiqueta especificada en el lector de TLV proporcionado.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult, const bool aRecurse)
Busca la etiqueta especificada en el lector de TLV proporcionado (opcionalmente desciende por arrays o estructuras).
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult)
Busca el primer elemento que coincida con el predicado dentro del lector de TLV que descienda en arrays 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 de TLV que descienda opcionalmente a arrays o estructuras.
FindHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Busca la etiqueta especificada en el lector de 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)

Funciones

Recuento

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

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

Detalles
Parámetros
[in] aReader
Una referencia de solo lectura al lector TLV para la que se cuenta la cantidad de elementos TLV.
[in,out] aCount
Una referencia al almacenamiento para el recuento que se muestra. Se inicializa en cero (0) antes de contar y se establece en el número de elementos que se contaron con éxito.
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.

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. Opcionalmente, desciende a arrays o estructuras.

Detalles
Parámetros
[in] aReader
Una referencia de solo lectura al lector TLV para la que se cuenta la cantidad de elementos TLV.
[in,out] aCount
Una referencia al almacenamiento para el recuento que se muestra. Se inicializa en cero (0) antes de contar y se establece en el número de elementos que se contaron con éxito.
[in] aRecurse
Es un valor booleano que indica si se debe descender (verdadero) o no (falso).
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.

CountHandler

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

Incrementa el contador cuando iteres a través de 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 TLV.
[in] aDepth
La profundidad actual de los datos de TLV.
[in,out] aContext
Un puntero al contexto específico del controlador, que es un puntero al almacenamiento para el valor de recuento.
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
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 en el lector de TLV proporcionado.

Detalles
Parámetros
[in] aReader
Una referencia de solo lectura al lector TLV en la que se puede encontrar la etiqueta especificada.
[in] aTag
Una referencia de solo lectura a la etiqueta TLV que se debe encontrar.
[out] aResult
Una referencia al almacenamiento a un lector de TLV que se posicionará en la etiqueta especificada en caso de éxito.
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
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 en el lector de TLV proporcionado (opcionalmente desciende por arrays o estructuras).

Detalles
Parámetros
[in] aReader
Una referencia de solo lectura al lector TLV en la que se puede encontrar la etiqueta especificada.
[in] aTag
Una referencia de solo lectura a la etiqueta TLV que se debe encontrar.
[out] aResult
Una referencia al almacenamiento a un lector de TLV que se posicionará en la etiqueta especificada en caso de éxito.
[in] aRecurse
Es un valor booleano que indica si se debe descender (verdadero) o no (falso).
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
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 de TLV que descienda en arrays o estructuras.

El aPredicate se aplica a cada elemento TLV visitado. aPredicate debe devolver WEAVE_ERROR_MAX para los elementos coincidentes, WEAVE_NO_ERROR para los elementos que no coinciden y cualquier otro valor para finalizar la búsqueda.

Detalles
Parámetros
[in] aReader
Una referencia de solo lectura al lector TLV en la que se puede encontrar el elemento que coincide con el predicado.
[in] aPredicate
Un predicado para aplicar a cada elemento TLV. Para admitir la reutilización del código, aPredicate tiene el tipo IterateHandler. El valor que se muestra de aPredicado controla la búsqueda: un 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 se debe finalizar la búsqueda.
[in] aContext
Un puntero opcional a datos de contexto proporcionados por el emisor.
[out] aResult
Una referencia al almacenamiento a un lector de TLV que se posicionará en la etiqueta especificada en caso de éxito.
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
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 de TLV que descienda opcionalmente a arrays o estructuras.

El aPredicate se aplica a cada elemento TLV visitado. aPredicate debe devolver WEAVE_ERROR_MAX para los elementos coincidentes, WEAVE_NO_ERROR para los elementos que no coinciden y cualquier otro valor para finalizar la búsqueda.

Detalles
Parámetros
[in] aReader
Una referencia de solo lectura al lector TLV en la que se puede encontrar el elemento que coincide con el predicado.
[in] aPredicate
Un predicado para aplicar a cada elemento TLV. Para admitir la reutilización del código, aPredicate tiene el tipo IterateHandler. El valor que se muestra de aPredicado controla la búsqueda: un 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 se debe finalizar la búsqueda.
[in] aContext
Un puntero opcional a datos de contexto proporcionados por el emisor.
[out] aResult
Una referencia al almacenamiento a un lector de TLV que se posicionará en la etiqueta especificada en caso de éxito.
[in] aRecurse
Un valor booleano que indica si se debe descender (verdadero) o no (falso) a cualquier matriz o estructura que se encuentre.
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
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 en el lector de TLV proporcionado.

Detalles
Parámetros
[in] aReader
Una referencia de solo lectura al lector TLV en la que se puede encontrar 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 de retorno
WEAVE_NO_ERROR
Si tiene éxito.
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 un valor distinto de WEAVE_NO_ERROR.

Detalles
Parámetros
[in] aReader
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
Una devolución de llamada para invocar el elemento TLV actual que se está visitando.
[in,out] aContext
Un puntero opcional a datos de contexto proporcionados por el emisor.
[in] aRecurse
Es un valor booleano que indica si se debe descender (verdadero) o no (falso).
Valores de retorno
WEAVE_END_OF_TLV
En una iteración correcta hasta el 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 un valor distinto de WEAVE_NO_ERROR.

Detalles
Parámetros
[in] aReader
Una referencia al lector de TLV que contiene los datos de TLV para iterar.
[in] aHandler
Una devolución de llamada para invocar el elemento TLV actual que se está visitando.
[in,out] aContext
Un puntero opcional a datos de contexto proporcionados por el emisor.
Valores de retorno
WEAVE_END_OF_TLV
En una iteración correcta hasta el final de una codificación TLV o al final de un contenedor TLV
WEAVE_ERROR_INVALID_ARGUMENT
Si aHandler es NULL.
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 un valor distinto de WEAVE_NO_ERROR.

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