En Google, luchamos por la equidad racial de la comunidad negra. Más información

nl::Weave::TLV::TLVReader

#include <src/lib/core/WeaveTLV.h>

Proporciona un analizador de memoria eficiente para los datos codificados en formato Weave de Weave.

Resumen

TLVReader implementa un analizador de "extracción" de solo reenvío para datos TLV de Weave. El objeto TLVReader funciona como un cursor que se puede usar para iterar sobre una secuencia de elementos TLV e interpretar su contenido. Cuando se posicionan en un elemento, las aplicaciones pueden realizar llamadas a los métodos Get() del lector para consultar el tipo y la etiqueta del elemento actual, y extraer cualquier valor asociado. El método Next() del lector se utiliza para avanzar de un elemento a otro.

Un objeto TLVReader siempre se posiciona antes, en o después de un elemento TLV. Cuando se inicializa por primera vez, un TLVReader se coloca inmediatamente antes del primer elemento de la codificación. Para comenzar a leer, una aplicación debe realizar una llamada inicial al método Next() para posicionar el lector en el primer elemento. Cuando se encuentra un elemento contenedor, se puede usar una estructura, un arreglo o los métodos OpenContainer() o EnterContainer() para iterar a través del contenido del contenedor.

Cuando el lector alcanza el final de una codificación TLV, o el último elemento dentro de un contenedor, indica a la aplicación que muestra un error WEAVE_END_OF_TLV desde el método Next(). El lector seguirá mostrando WEAVE_END_OF_TLV hasta que se inicialice o hasta que se cierre el contenedor actual (a través de CloseContainer() / ExitContainer()).

Un objeto TLVReader puede analizar datos directamente desde un búfer de entrada fijo, o desde una cadena de uno o más PacketBuffers. Además, las aplicaciones pueden proporcionar una función GetNextBuffer para proporcionar datos al lector desde una fuente arbitraria, p.ej., un socket o un puerto en serie.

Herencia

Subclases conocidas directas:
nl::Weave::Profiles::DataManagement_Current::CircularEventReader
nl::Weave::TLV::CircularTLVReader

Tipos públicos
GetNextBufferFunct)(TLVReader &reader, uintptr_t &bufHandle, const uint8_t *&bufStart, uint32_t &bufLen) WEAVE_ERROR(*
Una función que se puede usar para recuperar datos TLV adicionales que se analizarán.

Atributos públicos
AppData
void *
Un campo de puntero que se puede usar para datos específicos de la aplicación.
GetNextBuffer
Un puntero para una función que producirá datos de entrada para el objeto TLVReader.
ImplicitProfileId
uint32_t
El ID de perfil que se utilizará para las etiquetas de perfil codificadas de forma implícita.

Atributos protegidos
mBufEnd
const uint8_t *
mBufHandle
uintptr_t
mContainerType
mControlByte
uint16_t
mElemLenOrVal
uint64_t
mElemTag
uint64_t
mLenRead
uint32_t
mMaxLen
uint32_t
mReadPoint
const uint8_t *

Funciones públicas
CloseContainer(TLVReader & containerReader)
Completa la lectura de un contenedor TLV después de una llamada a OpenContainer().
DupBytes(uint8_t *& buf, uint32_t & dataLen)
Asigna y muestra un búfer que contiene el valor del byte actual o la string UTF8.
DupString(char *& buf)
Asigna y muestra un búfer que contiene el valor terminado en null del byte actual o la string UTF8.
EnterContainer(TLVType & outerContainerType)
Prepara un objeto TLVReader para leer los miembros del elemento contenedor TLV.
ExitContainer(TLVType outerContainerType)
Completa la lectura de un contenedor TLV y prepara un objeto TLVReader para leer elementos después del contenedor.
Get(bool & v)
Obtiene el valor del elemento actual como un tipo booleano.
Get(int8_t & v)
Obtiene el valor del elemento actual como un número entero firmado de 8 bits.
Get(int16_t & v)
Obtiene el valor del elemento actual como un número entero firmado de 16 bits.
Get(int32_t & v)
Obtiene el valor del elemento actual como un número entero firmado de 32 bits.
Get(int64_t & v)
Obtiene el valor del elemento actual como un número entero firmado de 64 bits.
Get(uint8_t & v)
Obtiene el valor del elemento actual como un número entero de 8 bits sin firma.
Get(uint16_t & v)
Obtiene el valor del elemento actual como un número entero sin firma de 16 bits.
Get(uint32_t & v)
Obtiene el valor del elemento actual como un número entero sin firma de 32 bits.
Get(uint64_t & v)
Obtiene el valor del elemento actual como un número entero sin firma de 64 bits.
Get(float & v)
Get(double & v)
Obtiene el valor del elemento actual como un número de punto flotante de doble precisión.
GetBufHandle(void) const
uintptr_t
GetBytes(uint8_t *buf, uint32_t bufSize)
Obtiene el valor del byte actual o del elemento de string UTF8.
GetContainerType(void) const
Muestra el tipo de contenedor en el que se está leyendo TLVReader.
GetControlByte(void) const
uint16_t
Muestra el byte de control asociado con el elemento TLV actual.
GetDataPtr(const uint8_t *& data)
Obtiene un puntero al byte codificado inicial de un byte TLV o elemento de string UTF8.
GetLength(void) const
uint32_t
Muestra la longitud de los datos asociados con el elemento TLV actual.
GetLengthRead(void) const
uint32_t
Muestra la cantidad total de bytes leídos desde la inicialización del lector.
GetReadPoint(void) const
const uint8_t *
Obtiene el punto en el búfer de entrada subyacente que corresponde a la posición actual del lector.
GetRemainingLength(void) const
uint32_t
Muestra la cantidad total de bytes que se pueden leer hasta alcanzar la longitud máxima de lectura.
GetString(char *buf, uint32_t bufSize)
Obtenga el valor del byte actual o del elemento de string UTF8 como una string nula nula.
GetTag(void) const
uint64_t
Muestra la etiqueta asociada con el elemento TLV actual.
GetType(void) const
Muestra el tipo del elemento TLV actual.
Init(const TLVReader & aReader)
void
Inicializa un objeto TLVReader desde otro objeto TLVReader.
Init(const uint8_t *data, uint32_t dataLen)
void
Inicializa un objeto TLVReader para leer desde un solo búfer de entrada.
Init(PacketBuffer *buf, uint32_t maxLen)
void
Inicializa un objeto TLVReader para leer desde un solo PacketBuffer.
Init(PacketBuffer *buf, uint32_t maxLen, bool allowDiscontiguousBuffers)
void
Inicializa un objeto TLVReader para leer desde uno o más PacketBuffers.
Next(void)
Avanza el objeto TLVReader al siguiente elemento TLV que se leerá.
Next(TLVType expectedType, uint64_t expectedTag)
Avanza el objeto TLVReader al siguiente elemento TLV para que se lea y afirma el tipo y la etiqueta del elemento nuevo.
OpenContainer(TLVReader & containerReader)
Inicializa un objeto TLVReader nuevo para leer los miembros de un elemento contenedor TLV.
Skip(void)
Avanza el objeto TLVReader inmediatamente después del elemento TLV actual.
VerifyEndOfContainer(void)
Verifica que el objeto TVLReader esté al final de un contenedor TLV.

Funciones protegidas
ClearElementState(void)
void
Borra el estado de TLVReader.
ElementType(void) const
TLVElementType
Este es un método privado que muestra el TLVElementType de mControlByte.
EnsureData(WEAVE_ERROR noDataErr)
GetElementHeadLength(uint8_t & elemHeadBytes) const
Este es un método privado que se usa para calcular la longitud de un encabezado de elemento TLV.
IsContainerOpen(void) const
bool
ReadData(uint8_t *buf, uint32_t len)
ReadElement(void)
ReadTag(TLVTagControl tagControl, const uint8_t *& p)
uint64_t
SetContainerOpen(bool aContainerOpen)
void
SkipData(void)
Omite cualquier dato contenido en el TLV actual leyéndolo sin un búfer de destino.
SkipToEndOfContainer(void)
VerifyElement(void)

Funciones estáticas protegidas
FailGetNextBuffer(TLVReader & reader, uintptr_t & bufHandle, const uint8_t *& bufStart, uint32_t & bufLen)
GetNextPacketBuffer(TLVReader & reader, uintptr_t & bufHandle, const uint8_t *& bufStart, uint32_t & bufLen)

Tipos públicos

ObtenerNextBufferFunct

WEAVE_ERROR(* GetNextBufferFunct)(TLVReader &reader, uintptr_t &bufHandle, const uint8_t *&bufStart, uint32_t &bufLen)

Una función que se puede usar para recuperar datos TLV adicionales que se analizarán.

Las funciones de este tipo se usan para ingresar datos de entrada a un TLVReader. Cuando se la llama, se espera que la función produzca datos adicionales para que el lector analice o le indique que no hay más datos disponibles.

Detalles
Parámetros
[in] reader
Una referencia al objeto TLVReader que solicita datos de entrada.
[in,out] bufHandle
Una referencia a un valor uintptr_t que la función puede usar para almacenar datos de contexto entre llamadas. Este valor se inicializa en 0 antes de la primera llamada.
[in,out] bufStart
Una referencia a un puntero de datos. Cuando ingresa a la función, bufStart apunta a un byte más allá del último byte de datos TLV que consume el lector. Al salir, se espera que bufStart apunte al primer byte de los datos nuevos de TLV que se analizarán. El nuevo valor del puntero puede estar dentro del mismo búfer que los datos consumidos anteriormente o puede apuntar a un búfer completamente nuevo.
[out] bufLen
Referencia a un número entero sin firma que la función debe establecer como cantidad de bytes de datos TLV que se muestran. Si se alcanzó el final de los datos de entrada TLV, la función debe establecer este valor en 0.
Valores de retorno
WEAVE_NO_ERROR
Si la función produjo correctamente más datos TLV o se alcanzó el final de los datos de entrada (en este caso, bufLen debe establecerse en 0).
other
Otros códigos de error de Weave o de la plataforma que indican que se produjo un error que impide que la función produzca los datos solicitados

Atributos públicos

Datos de app

void * AppData

Un campo de puntero que se puede usar para datos específicos de la aplicación.

GetNextBuffer

GetNextBufferFunct GetNextBuffer

Un puntero para una función que producirá datos de entrada para el objeto TLVReader.

Si se configura como NULL (el valor predeterminado), el lector supondrá que no hay más datos de entrada disponibles.

Una aplicación puede configurar GetNextBuffer en cualquier momento, pero, por lo general, se establece cuando se inicializa el lector.

Consulta la definición de tipo GetNextBufferFunct para obtener información adicional sobre la implementación de una función GetNextBuffer.

ID de perfil implícito

uint32_t ImplicitProfileId

El ID de perfil que se utilizará para las etiquetas de perfil codificadas de forma implícita.

Cuando el lector encuentra una etiqueta específica del perfil que se codificó de manera implícita, usa el valor de la propiedad ImplicitProfileId como ID de perfil que se supone para la etiqueta.

De forma predeterminada, la propiedad ImplicitProfileId se configura como kProfileIdNotspecified. Cuando se decodifica TLV que contiene etiquetas codificadas de forma implícita, las aplicaciones deben establecer ImplicitProfileId antes de leer cualquier elemento TLV que tenga esas etiquetas. Por lo general, el ID de perfil adecuado depende del contexto de la aplicación o el protocolo que se habla.

Si se encuentra una etiqueta codificada de forma implícita mientras ImplicitProfileId está configurado como kProfileIdNotspecified, el lector mostrará un error WEAVE_ERROR_UNKNOWN_IMPLICIT_TLV_TAG.

Atributos protegidos

Fin del mBuf

const uint8_t * mBufEnd

mBufHandle

uintptr_t mBufHandle

Tipo de contenedor para dispositivos móviles

TLVType mContainerType

mControlByte

uint16_t mControlByte

MELÉMOR ORAL

uint64_t mElemLenOrVal

Etiqueta de elemento electrónico

uint64_t mElemTag

Lectura de mLen

uint32_t mLenRead

Campaña de máximo rendimiento

uint32_t mMaxLen

mReadPoint

const uint8_t * mReadPoint

Funciones públicas

Cerrar contenedor

WEAVE_ERROR CloseContainer(
  TLVReader & containerReader
)

Completa la lectura de un contenedor TLV después de una llamada a OpenContainer().

El método CloseContainer() restablece el estado de un objeto TLVReader principal después de una llamada a OpenContainer(). Para cada llamada a OpenContainer(), las aplicaciones deben realizar una llamada correspondiente a CloseContainer() y pasar una referencia al mismo lector de contenedores a ambos métodos.

Cuando se muestra CloseContainer(), el lector superior se posiciona inmediatamente antes del primer elemento que sigue al contenedor. Desde este punto, una aplicación puede usar el método Next() para avanzar por los elementos restantes.

Las aplicaciones pueden llamar a CloseContainer() en un lector superior en cualquier momento, sin importar si se leyeron todos los elementos del contenedor subyacente. Después de llamar a CloseContainer(), la aplicación debe considerar el lector de contenedores "de-initialized" y no debe usarlo más sin volver a inicializarlo.

Detalles
Parámetros
[in] containerReader
Una referencia al objeto TLVReader que se suministró al método OpenContainer().
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_INCORRECT_STATE
Si no se llamó a OpenContainer() en el lector o si este no coincide con el que se pasó al método OpenContainer().
WEAVE_ERROR_TLV_UNDERRUN
Si la codificación de TLV subyacente finalizó antes de tiempo.
WEAVE_ERROR_INVALID_TLV_ELEMENT
Si el lector encontró un tipo de elemento TLV no válido o no compatible.
WEAVE_ERROR_INVALID_TLV_TAG
Si el lector encontró una etiqueta TLV en un contexto no válido.
other
Otros códigos de errores de Weave o de la plataforma que muestra la función GetNextBuffer() configurada Solo es posible cuando GetNextBuffer no es NULL.

DupBytes

WEAVE_ERROR DupBytes(
  uint8_t *& buf,
  uint32_t & dataLen
)

Asigna y muestra un búfer que contiene el valor del byte actual o la string UTF8.

Este método crea un búfer para y muestra una copia de los datos asociados con el byte o el elemento de string UTF-8 de la posición actual. La memoria para el búfer se obtiene con malloc() y el emisor debe liberarla con free() cuando ya no sea necesaria.

Detalles
Parámetros
[out] buf
Una referencia a un puntero al que se asignará un búfer de dataLen bytes asignado de forma correcta.
[out] dataLen
Una referencia al almacenamiento del tamaño, en bytes, de buf en caso de éxito.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_WRONG_TLV_TYPE
Si el elemento actual no es un byte TLV o una string UTF8, o el lector no está posicionado en un elemento.
WEAVE_ERROR_NO_MEMORY
Si no se pudo asignar memoria para el búfer de salida.
WEAVE_ERROR_TLV_UNDERRUN
Si la codificación de TLV subyacente finalizó antes de tiempo.
WEAVE_ERROR_UNSUPPORTED_WEAVE_FEATURE
Si la plataforma de destino no admite malloc() y free(),
other
Otros códigos de errores de Weave o de la plataforma que muestra la función GetNextBuffer() configurada Solo es posible cuando GetNextBuffer no es NULL.

DupString;

WEAVE_ERROR DupString(
  char *& buf
)

Asigna y muestra un búfer que contiene el valor terminado en null del byte actual o la string UTF8.

Este método crea un búfer y muestra una copia terminada en null de los datos asociados con el byte o elemento de cadena UTF-8 en la posición actual. La memoria para el búfer se obtiene con malloc() y el emisor debe liberarla con free() cuando ya no sea necesaria.

Detalles
Parámetros
[out] buf
Una referencia a un puntero al que se asignará un búfer asignado de montón en caso de éxito.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_WRONG_TLV_TYPE
Si el elemento actual no es un byte TLV o una string UTF8, o el lector no está posicionado en un elemento.
WEAVE_ERROR_NO_MEMORY
Si no se pudo asignar memoria para el búfer de salida.
WEAVE_ERROR_TLV_UNDERRUN
Si la codificación de TLV subyacente finalizó antes de tiempo.
WEAVE_ERROR_UNSUPPORTED_WEAVE_FEATURE
Si la plataforma de destino no admite malloc() y free(),
other
Otros códigos de errores de Weave o de la plataforma que muestra la función GetNextBuffer() configurada Solo es posible cuando GetNextBuffer no es NULL.

Contenedor contenedor

WEAVE_ERROR EnterContainer(
  TLVType & outerContainerType
)

Prepara un objeto TLVReader para leer los miembros del elemento contenedor TLV.

El método EnterContainer() prepara el objeto TLVReader actual para comenzar a leer los elementos miembros de un contenedor TLV (una estructura, una matriz o una ruta). Por cada llamada a EnterContainer(), las aplicaciones deben hacer una llamada correspondiente a ExitContainer().

Cuando se llama a EnterContainer(), se debe colocar el objeto TLVReader en el elemento contenedor para leerlo. El método toma como argumento una referencia a un valor TLVType que se usará para guardar el contexto del lector mientras lee el contenedor.

Cuando se muestra el método EnterContainer(), el lector se posiciona inmediatamente antes del primer miembro del contenedor. Si se llama repetidamente a Next(), el lector avanzará por los miembros de la colección hasta llegar al final, momento en el cual el lector mostrará WEAVE_END_OF_TLV.

Una vez que la aplicación termina de leer un contenedor, puede continuar leyendo los elementos después del contenedor llamando al método ExitContainer().

Detalles
Parámetros
[out] outerContainerType
Una referencia a un valor TLVType que recibirá el contexto del lector.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_INCORRECT_STATE
Si el elemento actual no está posicionado en un elemento contenedor

Salir del contenedor

WEAVE_ERROR ExitContainer(
  TLVType outerContainerType
)

Completa la lectura de un contenedor TLV y prepara un objeto TLVReader para leer elementos después del contenedor.

El método ExitContainer() restablece el estado de un objeto TLVReader después de una llamada a EnterContainer(). Para cada llamada a EnterContainer(), las aplicaciones deben realizar una llamada correspondiente a ExitContainer() y pasar el valor de contexto que muestra el método EnterContainer().

Cuando se muestra ExitContainer(), el lector se posiciona inmediatamente antes del primer elemento que sigue al contenedor. Desde este punto, una aplicación puede usar el método Next() para avanzar por los elementos restantes.

Una vez que se haya llamado a EnterContainer(), las aplicaciones pueden llamar a ExitContainer() en un lector en cualquier momento, sin importar si se leyeron todos los elementos del contenedor subyacente.

Detalles
Parámetros
[in] outerContainerType
El valor de TLVType que mostró el método EnterContainer().
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_INCORRECT_STATE
Si no se llamó a OpenContainer() en el lector o si este no coincide con el que se pasó al método OpenContainer().
WEAVE_ERROR_TLV_UNDERRUN
Si la codificación de TLV subyacente finalizó antes de tiempo.
WEAVE_ERROR_INVALID_TLV_ELEMENT
Si el lector encontró un tipo de elemento TLV no válido o no compatible.
WEAVE_ERROR_INVALID_TLV_TAG
Si el lector encontró una etiqueta TLV en un contexto no válido.
other
Otros códigos de errores de Weave o de la plataforma que muestra la función GetNextBuffer() configurada Solo es posible cuando GetNextBuffer no es NULL.

Obtener

WEAVE_ERROR Get(
  bool & v
)

Obtiene el valor del elemento actual como un tipo booleano.

Detalles
Parámetros
[out] v
Recibe el valor asociado con el elemento TLV actual.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_WRONG_TLV_TYPE
Si el elemento actual no es un tipo booleano TLV o el lector no está posicionado en un elemento.

Obtener

WEAVE_ERROR Get(
  int8_t & v
)

Obtiene el valor del elemento actual como un número entero firmado de 8 bits.

Si el valor de número entero codificado es mayor que el tipo de datos de salida, se truncará el valor resultante.

Detalles
Parámetros
[out] v
Recibe el valor asociado con el elemento TLV actual.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_WRONG_TLV_TYPE
Si el elemento actual no es un número entero TLV (con o sin firma) o el lector no está posicionado en un elemento.

Obtener

WEAVE_ERROR Get(
  int16_t & v
)

Obtiene el valor del elemento actual como un número entero firmado de 16 bits.

Si el valor de número entero codificado es mayor que el tipo de datos de salida, se truncará el valor resultante.

Detalles
Parámetros
[out] v
Recibe el valor asociado con el elemento TLV actual.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_WRONG_TLV_TYPE
Si el elemento actual no es un número entero TLV (con o sin firma) o el lector no está posicionado en un elemento.

Obtener

WEAVE_ERROR Get(
  int32_t & v
)

Obtiene el valor del elemento actual como un número entero firmado de 32 bits.

Si el valor de número entero codificado es mayor que el tipo de datos de salida, se truncará el valor resultante.

Detalles
Parámetros
[out] v
Recibe el valor asociado con el elemento TLV actual.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_WRONG_TLV_TYPE
Si el elemento actual no es un número entero TLV (con o sin firma) o el lector no está posicionado en un elemento.

Obtener

WEAVE_ERROR Get(
  int64_t & v
)

Obtiene el valor del elemento actual como un número entero firmado de 64 bits.

Si el valor de número entero codificado es mayor que el tipo de datos de salida, se truncará el valor resultante.

Detalles
Parámetros
[out] v
Recibe el valor asociado con el elemento TLV actual.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_WRONG_TLV_TYPE
Si el elemento actual no es un número entero TLV (con o sin firma) o el lector no está posicionado en un elemento.

Obtener

WEAVE_ERROR Get(
  uint8_t & v
)

Obtiene el valor del elemento actual como un número entero de 8 bits sin firma.

Si el valor de número entero codificado es mayor que el tipo de datos de salida, se truncará el valor resultante. Del mismo modo, si el valor entero codificado es negativo, el valor se convertirá en "sin firmar".

Detalles
Parámetros
[out] v
Recibe el valor asociado con el elemento TLV actual.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_WRONG_TLV_TYPE
Si el elemento actual no es un número entero TLV (con o sin firma) o el lector no está posicionado en un elemento.

Obtener

WEAVE_ERROR Get(
  uint16_t & v
)

Obtiene el valor del elemento actual como un número entero sin firma de 16 bits.

Si el valor de número entero codificado es mayor que el tipo de datos de salida, se truncará el valor resultante. Del mismo modo, si el valor entero codificado es negativo, el valor se convertirá en "sin firmar".

Detalles
Parámetros
[out] v
Recibe el valor asociado con el elemento TLV actual.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_WRONG_TLV_TYPE
Si el elemento actual no es un número entero TLV (con o sin firma) o el lector no está posicionado en un elemento.

Obtener

WEAVE_ERROR Get(
  uint32_t & v
)

Obtiene el valor del elemento actual como un número entero sin firma de 32 bits.

Si el valor de número entero codificado es mayor que el tipo de datos de salida, se truncará el valor resultante. Del mismo modo, si el valor entero codificado es negativo, el valor se convertirá en "sin firmar".

Detalles
Parámetros
[out] v
Recibe el valor asociado con el elemento TLV actual.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_WRONG_TLV_TYPE
Si el elemento actual no es un número entero TLV (con o sin firma) o el lector no está posicionado en un elemento.

Obtener

WEAVE_ERROR Get(
  uint64_t & v
)

Obtiene el valor del elemento actual como un número entero sin firma de 64 bits.

Si el valor de número entero codificado es negativo, el valor se convertirá en "sin firmar".

Detalles
Parámetros
[out] v
Recibe el valor asociado con el elemento TLV actual.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_WRONG_TLV_TYPE
Si el elemento actual no es un número entero TLV (con o sin firma) o el lector no está posicionado en un elemento.

Obtener

WEAVE_ERROR Get(
  float & v
)

Obtener

WEAVE_ERROR Get(
  double & v
)

Obtiene el valor del elemento actual como un número de punto flotante de doble precisión.

Detalles
Parámetros
[out] v
Recibe el valor asociado con el elemento TLV actual.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_WRONG_TLV_TYPE
Si el elemento actual no es un tipo de punto flotante TLV o el lector no está posicionado en un elemento.

GetBufHandle.

uintptr_t GetBufHandle(
  void
) const

Obtener bytes

WEAVE_ERROR GetBytes(
  uint8_t *buf,
  uint32_t bufSize
)

Obtiene el valor del byte actual o del elemento de string UTF8.

Para determinar el tamaño del búfer de entrada requerido, llama al método GetLength() antes de llamar a GetBytes().

Detalles
Parámetros
[in] buf
Un puntero para un búfer a fin de recibir los datos de string.
[in] bufSize
El tamaño en bytes del búfer al que apunta buf.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_WRONG_TLV_TYPE
Si el elemento actual no es un byte TLV o una string UTF8, o el lector no está posicionado en un elemento.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si el búfer proporcionado es demasiado pequeño para los datos asociados con el elemento actual.
WEAVE_ERROR_TLV_UNDERRUN
Si la codificación de TLV subyacente finalizó antes de tiempo.
other
Otros códigos de errores de Weave o de la plataforma que muestra la función GetNextBuffer() configurada Solo es posible cuando GetNextBuffer no es NULL.

GetContainerType.

TLVType GetContainerType(
  void
) const

Muestra el tipo de contenedor en el que se está leyendo TLVReader.

El método GetContainerType() muestra el tipo del contenedor TLV en el que lee TLVReader. Si el TLVReader se posiciona en el nivel más externo de una codificación TLV (es decir, antes o después del elemento TLV más externo), el método mostrará kTLVType_Notspecified.

Detalles
Qué muestra
El TLVType del contenedor actual o kTLVType_Notspecified si el TLVReader no está posicionado dentro de un contenedor

GetControlByte.

uint16_t GetControlByte(
  void
) const

Muestra el byte de control asociado con el elemento TLV actual.

Idealmente, nadie necesita saber sobre el byte de control y solo la implementación interna de TLV debería tener acceso a él. Sin embargo, tener acceso al byte de control es útil para fines de depuración por parte de TLVDebugUtilities (que intentan decodificar el byte de control de etiqueta cuando se imprime de manera bonita el contenido del búfer de TLV).

Detalles
Qué muestra
Un número entero sin firma que contiene el byte de control asociado con el elemento TLV actual. Se muestra kTLVControlByte_Notspecified si el lector no está posicionado en un elemento.

GetDataPtr

WEAVE_ERROR GetDataPtr(
  const uint8_t *& data
)

Obtiene un puntero al byte codificado inicial de un byte TLV o elemento de string UTF8.

Este método muestra un puntero directo al valor de la string codificada dentro del búfer de entrada subyacente. Para tener éxito, el método requiere que todo el valor de la string esté presente en un solo búfer. De lo contrario, el método muestra WEAVE_ERROR_TLV_UNDERRUN. Esto hace que el método de uso limitado se lea cuando se leen datos de varios búferes discontinuos.

Detalles
Parámetros
[out] data
Una referencia a un puntero const que recibirá un puntero para los datos de string subyacentes.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_WRONG_TLV_TYPE
Si el elemento actual no es un byte TLV o una string UTF8, o el lector no está posicionado en un elemento.
WEAVE_ERROR_TLV_UNDERRUN
Si la codificación TLV subyacente finalizó prematuramente o el valor del elemento de string actual no está contenido dentro de un solo búfer contiguo.
other
Otros códigos de errores de Weave o de la plataforma que muestra la función GetNextBuffer() configurada Solo es posible cuando GetNextBuffer no es NULL.

Obtener longitud

uint32_t GetLength(
  void
) const

Muestra la longitud de los datos asociados con el elemento TLV actual.

La longitud de los datos solo se aplica a los elementos de tipo string UTF8 o string de bytes. Para las strings UTF8, el valor mostrado es la cantidad de bytes de la string, no la cantidad de caracteres.

Detalles
Qué muestra
La longitud (en bytes) de los datos asociados con el elemento TLV actual, o 0 si el elemento actual no es una string UTF8 o de bytes, o si el lector no está posicionado en un elemento.

GetLengthRead

uint32_t GetLengthRead(
  void
) const

Muestra la cantidad total de bytes leídos desde la inicialización del lector.

Detalles
Qué muestra
Cantidad total de bytes leídos desde la inicialización del lector.

GetReadPoint

const uint8_t * GetReadPoint(
  void
) const

Obtiene el punto en el búfer de entrada subyacente que corresponde a la posición actual del lector.

Detalles
Qué muestra
Un puntero al búfer de entrada subyacente que corresponde a la posición actual del lector.

GetRemainingLength

uint32_t GetRemainingLength(
  void
) const

Muestra la cantidad total de bytes que se pueden leer hasta alcanzar la longitud máxima de lectura.

Detalles
Qué muestra
Cantidad total de bytes que se pueden leer hasta alcanzar la longitud máxima de lectura.

GetString.

WEAVE_ERROR GetString(
  char *buf,
  uint32_t bufSize
)

Obtenga el valor del byte actual o del elemento de string UTF8 como una string nula nula.

Para determinar el tamaño del búfer de entrada requerido, llama al método GetLength() antes de llamar a GetBytes(). El búfer de entrada debe ser al menos un byte más grande que la longitud de la string para el carácter nulo.

Detalles
Parámetros
[in] buf
Un puntero para un búfer a fin de recibir los datos de string de bytes.
[in] bufSize
El tamaño en bytes del búfer al que apunta buf.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_WRONG_TLV_TYPE
Si el elemento actual no es un byte TLV o una string UTF8, o el lector no está posicionado en un elemento.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si el búfer proporcionado es demasiado pequeño para los datos asociados con el elemento actual.
WEAVE_ERROR_TLV_UNDERRUN
Si la codificación de TLV subyacente finalizó antes de tiempo.
other
Otros códigos de errores de Weave o de la plataforma que muestra la función GetNextBuffer() configurada Solo es posible cuando GetNextBuffer no es NULL.

GetTag

uint64_t GetTag(
  void
) const

Muestra la etiqueta asociada con el elemento TLV actual.

El valor que muestra GetTag() se puede usar con las funciones de utilidad de etiquetas (IsProfileTag(), IsContextTag(), ProfileIdFromTag(), etc.) para determinar el tipo de etiqueta y extraer varios valores de campo de etiqueta.

Detalles
Qué muestra
Un número entero sin firma que contiene información sobre la etiqueta asociada con el elemento TLV actual.

Tipo de Get

TLVType GetType(
  void
) const

Muestra el tipo del elemento TLV actual.

Detalles
Qué muestra
Un valor de TLVType que describe el tipo de datos del elemento TLV actual. Si el lector no está posicionado en un elemento TLV, el valor que se muestra será kTLVType_Notspecified.

Init

void Init(
  const TLVReader & aReader
)

Inicializa un objeto TLVReader desde otro objeto TLVReader.

Detalles
Parámetros
[in] aReader
Una referencia de solo lectura a TLVReader para inicializar esto.

Init

void Init(
  const uint8_t *data,
  uint32_t dataLen
)

Inicializa un objeto TLVReader para leer desde un solo búfer de entrada.

Detalles
Parámetros
[in] data
Un puntero para un búfer que contiene los datos TLV que se analizarán.
[in] dataLen
La longitud de los datos TLV que se analizarán.

Init

void Init(
  PacketBuffer *buf,
  uint32_t maxLen
)

Inicializa un objeto TLVReader para leer desde un solo PacketBuffer.

El análisis comienza en la posición de inicio del búfer (buf>DataStart()) y continúa hasta el final de los datos del búfer (como lo indica buf>Datalen()), o hasta que se analizan los bytes maxLen.

Detalles
Parámetros
[in] buf
Un puntero para un PacketBuffer que contiene los datos TLV que se analizarán.
[in] maxLen
La cantidad máxima de bytes que se analizarán. El valor predeterminado es la cantidad de datos en el búfer de entrada.

Init

void Init(
  PacketBuffer *buf,
  uint32_t maxLen,
  bool allowDiscontiguousBuffers
)

Inicializa un objeto TLVReader para leer desde uno o más PacketBuffers.

El análisis comienza en la posición inicial de búfer (buf>DataStart()). Si allowDiscontiguousBuffers es verdadero, el lector avanzará por la cadena de búferes vinculada por sus punteros de Next(). El análisis continúa hasta que se hayan consumido todos los datos de la cadena del búfer (como lo indica buf>Datalen()) o se hayan analizado los bytes maxLen.

Detalles
Parámetros
[in] buf
Un puntero para un PacketBuffer que contiene los datos TLV que se analizarán.
[in] maxLen
La cantidad máxima de bytes que se analizarán. La configuración predeterminada es la cantidad total de datos en la cadena del búfer de entrada.
[in] allowDiscontiguousBuffers
Si es verdadero, avanza al siguiente búfer de la cadena una vez que se hayan consumido todos los datos del búfer actual. Si es falso, deja de analizarlo al final del búfer inicial.

Siguiente

WEAVE_ERROR Next(
  void
)

Avanza el objeto TLVReader al siguiente elemento TLV que se leerá.

El método Next() coloca el objeto de lector en el siguiente elemento en una codificación TLV que reside en el mismo contexto de contención. En particular, si el lector está posicionado en el nivel más externo de una codificación TLV, llamar a Next() hará que el lector pase al siguiente elemento, en la parte superior. Si el lector se posiciona en un elemento contenedor TLV (una estructura, un arreglo o una ruta), al llamar a Next(), el lector avanzará al lector al siguiente elemento miembro del contenedor.

Dado que Next() restringe el movimiento del lector al contexto de contención actual, llamar a Next() cuando el lector se posiciona en un elemento del contenedor avanzará sobre el contenedor, y se omitirán sus elementos miembros (y los miembros de cualquier contenedor anidado) hasta que llegue al primer elemento después del contenedor.

Cuando no hay más elementos dentro de un contexto de contención en particular, el método Next() mostrará un error WEAVE_END_OF_TLV y la posición del lector no se modificará.

Detalles
Valores de retorno
WEAVE_NO_ERROR
Si el lector se ubicó correctamente en un elemento nuevo
WEAVE_END_OF_TLV
Si no hay más elementos disponibles,
WEAVE_ERROR_TLV_UNDERRUN
Si la codificación de TLV subyacente finalizó antes de tiempo.
WEAVE_ERROR_INVALID_TLV_ELEMENT
Si el lector encontró un tipo de elemento TLV no válido o no compatible.
WEAVE_ERROR_INVALID_TLV_TAG
Si el lector encontró una etiqueta TLV en un contexto no válido.
WEAVE_ERROR_UNKNOWN_IMPLICIT_TLV_TAG
Si el lector encontró una etiqueta TLV codificada de forma implícita para la que se desconoce el ID de perfil correspondiente
other
Otros códigos de errores de Weave o de la plataforma que muestra la función GetNextBuffer() configurada Solo es posible cuando GetNextBuffer no es NULL.

Siguiente

WEAVE_ERROR Next(
  TLVType expectedType,
  uint64_t expectedTag
)

Avanza el objeto TLVReader al siguiente elemento TLV para que se lea y afirma el tipo y la etiqueta del elemento nuevo.

El método Next(TLVTypeexpectedType, uint64_texpectedTag) es un método de conveniencia que tiene el mismo comportamiento que Next(), pero también verifica que el tipo y la etiqueta del elemento TLV nuevo coincidan con los argumentos proporcionados.

Detalles
Parámetros
[in] expectedType
El tipo de datos esperado para el siguiente elemento.
[in] expectedTag
La etiqueta esperada para el siguiente elemento.
Valores de retorno
WEAVE_NO_ERROR
Si el lector se ubicó correctamente en un elemento nuevo
WEAVE_END_OF_TLV
Si no hay más elementos disponibles,
WEAVE_ERROR_WRONG_TLV_TYPE
Si el tipo del elemento nuevo no coincide con el valor del argumento expectedType.
WEAVE_ERROR_UNEXPECTED_TLV_ELEMENT
Si la etiqueta asociada con el elemento nuevo no coincide con el valor del argumento expectedTag.
WEAVE_ERROR_TLV_UNDERRUN
Si la codificación de TLV subyacente finalizó antes de tiempo.
WEAVE_ERROR_INVALID_TLV_ELEMENT
Si el lector encontró un tipo de elemento TLV no válido o no compatible.
WEAVE_ERROR_INVALID_TLV_TAG
Si el lector encontró una etiqueta TLV en un contexto no válido.
other
Otros códigos de errores de Weave o de la plataforma que muestra la función GetNextBuffer() configurada Solo es posible cuando GetNextBuffer no es NULL.

OpenContainer

WEAVE_ERROR OpenContainer(
  TLVReader & containerReader
)

Inicializa un objeto TLVReader nuevo para leer los miembros de un elemento contenedor TLV.

El método OpenContainer() inicializa un nuevo objeto TLVReader para leer los elementos miembros de un contenedor TLV (una estructura, matriz o ruta). Cuando se llama a OpenContainer(), se debe colocar el objeto TLVReader actual en el elemento contenedor para leerlo. El método toma como único argumento una referencia a un nuevo lector que se inicializará para leer el contenedor. Este lector se conoce como lector de contenedores, mientras que el lector al que se llama a OpenContainer() se conoce como el lector superior.

Cuando se muestra el método OpenContainer(), el lector del contenedor se posiciona inmediatamente antes del primer miembro del contenedor. Llamar a Next() en el lector del contenedor avanzará por los miembros de la colección hasta llegar al final, momento en el cual el lector mostrará WEAVE_END_OF_TLV.

Mientras el lector de contenedores está abierto, las aplicaciones no deben realizar llamadas ni modificar el estado del lector superior. Una vez que una aplicación termina de usar el lector del contenedor, debe cerrarla. Para ello, debe llamar a CloseContainer() en el lector superior y pasar al lector del contenedor como argumento. Las aplicaciones pueden cerrar el lector de contenedores en cualquier momento, con o sin leer todos los elementos contenidos en el contenedor subyacente. Una vez que se cierra el lector de contenedores, las aplicaciones pueden continuar utilizando el lector superior.

El lector de contenedores hereda varias propiedades de configuración del lector superior. que son los siguientes:

  • El ID de perfil implícito (ImplicitProfileId)
  • El puntero de datos de aplicaciones (AppData)
  • El puntero de la función GetNextBuffer

Detalles
Parámetros
[out] containerReader
Una referencia a un objeto TLVReader que se inicializará para leer los miembros del elemento contenedor actual. Se reemplazarán todos los datos asociados con el objeto proporcionado.
Valores de retorno
WEAVE_NO_ERROR
Si el método se realizó correctamente
WEAVE_ERROR_INCORRECT_STATE
Si el elemento actual no está posicionado en un elemento contenedor

Omitir

WEAVE_ERROR Skip(
  void
)

Avanza el objeto TLVReader inmediatamente después del elemento TLV actual.

El método Skip() posiciona el objeto del lector inmediatamente después del elemento TLV actual, de modo que una llamada posterior a Next() hará avanzar al lector al siguiente elemento. Al igual que Next(), si el lector se posiciona en un elemento contenedor en el momento de la llamada, se omitirán los miembros del contenedor. Si el lector no está posicionado en ningún elemento, no se modificará su posición.

Detalles
Valores de retorno
WEAVE_NO_ERROR
Si el lector se ubicó correctamente en un elemento nuevo
WEAVE_END_OF_TLV
Si no hay más elementos disponibles,
WEAVE_ERROR_TLV_UNDERRUN
Si la codificación de TLV subyacente finalizó antes de tiempo.
WEAVE_ERROR_INVALID_TLV_ELEMENT
Si el lector encontró un tipo de elemento TLV no válido o no compatible.
WEAVE_ERROR_INVALID_TLV_TAG
Si el lector encontró una etiqueta TLV en un contexto no válido.
other
Otros códigos de errores de Weave o de la plataforma que muestra la función GetNextBuffer() configurada Solo es posible cuando GetNextBuffer no es NULL.

Verifica el extremo del contenedor

WEAVE_ERROR VerifyEndOfContainer(
  void
)

Verifica que el objeto TVLReader esté al final de un contenedor TLV.

El método VerifyEndOfContainer() verifica que no haya más elementos TLV para leer dentro del contenedor TLV actual. Este es un método conveniente que equivale a llamar a Next() y comprobar un valor de retorno de WEAVE_END_OF_TLV.

Detalles
Valores de retorno
WEAVE_NO_ERROR
Si no hay más elementos TLV para leer,
WEAVE_ERROR_UNEXPECTED_TLV_ELEMENT
Si se encontró otro elemento TLV en la colección.
WEAVE_ERROR_TLV_UNDERRUN
Si la codificación de TLV subyacente finalizó antes de tiempo.
WEAVE_ERROR_INVALID_TLV_ELEMENT
Si el lector encontró un tipo de elemento TLV no válido o no compatible.
WEAVE_ERROR_INVALID_TLV_TAG
Si el lector encontró una etiqueta TLV en un contexto no válido.
other
Otros códigos de errores de Weave o de la plataforma que muestra la función GetNextBuffer() configurada Solo es posible cuando GetNextBuffer no es NULL.

Funciones protegidas

ClearElementState

void ClearElementState(
  void
)

Borra el estado de TLVReader.

Este método se usa para posicionar el lector antes del primer TLV, entre TLV o después del último TLV.

ElementType

TLVElementType ElementType(
  void
) const

Este es un método privado que muestra el TLVElementType de mControlByte.

GarantizarDatos

WEAVE_ERROR EnsureData(
  WEAVE_ERROR noDataErr
)

ObtenerElementLengthLength

WEAVE_ERROR GetElementHeadLength(
  uint8_t & elemHeadBytes
) const

Este es un método privado que se usa para calcular la longitud de un encabezado de elemento TLV.

IsContainerOpen

bool IsContainerOpen(
  void
) const

Leer datos

WEAVE_ERROR ReadData(
  uint8_t *buf,
  uint32_t len
)

Elemento de lectura

WEAVE_ERROR ReadElement(
  void
)

Etiqueta de lectura

uint64_t ReadTag(
  TLVTagControl tagControl,
  const uint8_t *& p
)

SetContainerOpen

void SetContainerOpen(
  bool aContainerOpen
)

Omitir datos

WEAVE_ERROR SkipData(
  void
)

Omite cualquier dato contenido en el TLV actual leyéndolo sin un búfer de destino.

Detalles
Valores de retorno
WEAVE_NO_ERROR
Si el lector se colocó correctamente al final de los datos
other
Otros códigos de errores de Weave o de la plataforma que muestra la función GetNextBuffer() configurada Solo es posible cuando GetNextBuffer no es NULL.

Omitir al final del contenedor

WEAVE_ERROR SkipToEndOfContainer(
  void
)

Verificar elemento

WEAVE_ERROR VerifyElement(
  void
)

Funciones estáticas protegidas

FailGetNextBuffer

WEAVE_ERROR FailGetNextBuffer(
  TLVReader & reader,
  uintptr_t & bufHandle,
  const uint8_t *& bufStart,
  uint32_t & bufLen
)

GetNextPacketBuffer

WEAVE_ERROR GetNextPacketBuffer(
  TLVReader & reader,
  uintptr_t & bufHandle,
  const uint8_t *& bufStart,
  uint32_t & bufLen
)