nl

Anulaciones de nlassert.h específicas de Weave.

Resumen

Enumeraciones

@357 enum
@358 enum
@359 enum
@360 enum
@361 enum
SerializedFieldType{
  SerializedFieldTypeBoolean = 0x00,
  SerializedFieldTypeUInt8,
  SerializedFieldTypeUInt16,
  SerializedFieldTypeUInt32,
  SerializedFieldTypeUInt64,
  SerializedFieldTypeInt8,
  SerializedFieldTypeInt16,
  SerializedFieldTypeInt32,
  SerializedFieldTypeInt64,
  SerializedFieldTypeFloatingPoint32,
  SerializedFieldTypeFloatingPoint64,
  SerializedFieldTypeUTF8String,
  SerializedFieldTypeByteString,
  SerializedFieldTypeStructure,
  SerializedFieldTypeArray
}
enum
Una lista de tipos de TLV para escribir con un campo de TLV.
SerializedFieldTypeBits enum
Campo de bits de SerializedFieldType.
SerializedFieldTypeMasks enum
Máscaras para acceder a bits de SerializedFieldType.

Typedefs

Base64CharToValFunct)(uint8_t c) typedef
uint8_t(*
Base64ValToCharFunct)(uint8_t val) typedef
char(*
MemoryAllocate)(size_t size) typedef
void *(*
Punteros de función libre o asignación de memoria.
MemoryFree)(void *ptr) typedef
void(*
MemoryReallocate)(void *ptr, size_t size) typedef
void *(*

Variables

sASN1ErrorFormatter = { nl::Weave::ASN1::FormatASN1Error, NULL }
sElementSize = { sizeof(bool), sizeof(uint8_t), sizeof(uint16_t), sizeof(uint32_t), sizeof(uint64_t), sizeof(int8_t), sizeof(int16_t), sizeof(int32_t), sizeof(int64_t), sizeof(float), sizeof(double), sizeof(char *), sizeof(SerializedByteString), sizeof(void *), sizeof(void *) }[]
const uint8_t
sErrorFormatterList = &sWeaveErrorFormatter
const ErrorFormatter *
Lista vinculada de funciones de formateador de errores.
sErrorStr[WEAVE_CONFIG_ERROR_STR_SIZE]
char
Búfer estático para almacenar la cadena de error con formato.
sErrorStr[1024]
char
Esta rutina muestra una cadena C terminada en NULL que es legible por humanos que describe el código de estado proporcionado y asociado con el perfil especificado.
sWeaveErrorFormatter = { nl::Weave::FormatWeaveError, &sASN1ErrorFormatter }

Funciones

AdjustCalendarDate(uint16_t & year, uint8_t & month, uint8_t & dayOfMonth, int32_t relativeDays)
void
Base64CharToVal(uint8_t c)
uint8_t
Base64Decode(const char *in, uint16_t inLen, uint8_t *out, Base64CharToValFunct charToValFunct)
uint16_t
Base64Decode(const char *in, uint16_t inLen, uint8_t *out)
uint16_t
Base64Decode32(const char *in, uint32_t inLen, uint8_t *out, Base64CharToValFunct charToValFunct)
uint32_t
Base64Decode32(const char *in, uint32_t inLen, uint8_t *out)
uint32_t
Base64Encode(const uint8_t *in, uint16_t inLen, char *out, Base64ValToCharFunct valToCharFunct)
uint16_t
Base64Encode(const uint8_t *in, uint16_t inLen, char *out)
uint16_t
Base64Encode32(const uint8_t *in, uint32_t inLen, char *out, Base64ValToCharFunct valToCharFunct)
uint32_t
Base64Encode32(const uint8_t *in, uint32_t inLen, char *out)
uint32_t
Base64URLCharToVal(uint8_t c)
uint8_t
Base64URLDecode(const char *in, uint16_t inLen, uint8_t *out)
uint16_t
Base64URLEncode(const uint8_t *in, uint16_t inLen, char *out)
uint16_t
Base64URLValToChar(uint8_t val)
char
Base64ValToChar(uint8_t val)
char
CalendarDateToDaysSinceEpoch(uint16_t year, uint8_t month, uint8_t dayOfMonth, uint32_t & daysSinceEpoch)
bool
CalendarDateToOrdinalDate(uint16_t year, uint8_t month, uint8_t dayOfMonth, uint16_t & dayOfYear)
void
CalendarTimeToSecondsSinceEpoch(uint16_t year, uint8_t month, uint8_t dayOfMonth, uint8_t hour, uint8_t minute, uint8_t second, uint32_t & secondsSinceEpoch)
bool
ClearFlag(FlagsT & inFlags, const FlagT inFlag)
void
DateToManufacturingWeek(uint16_t year, uint8_t month, uint8_t day, uint16_t & mfgYear, uint8_t & mfgWeek)
void
DaysInMonth(uint16_t year, uint8_t month)
uint8_t
DaysSinceEpochToCalendarDate(uint32_t daysSinceEpoch, uint16_t & year, uint8_t & month, uint8_t & dayOfMonth)
void
DaysToMarch1(uint16_t year)
uint8_t
DeallocateDeserializedStructure(void *aStructureData, const SchemaFieldDescriptor *aFieldDescriptors, SerializationContext *aContext)
ErrorStr(int32_t err)
NL_DLL_EXPORT const char *
Esta rutina muestra una cadena C terminada en NULL y legible que describe el error proporcionado.
ExtractManufacturingDateFromSerialNumber(const char *serialNum, uint16_t & year, uint8_t & month, uint8_t & day)
FindNullifiedFieldsArray(void *aStructureData, const SchemaFieldDescriptor *aSchemaDescriptor, uint8_t *& aNullifiedFields)
Una función auxiliar para encontrar la ubicación del array de campos anulados ubicado al final del struct C.
FindStatusReportStr(uint32_t inProfileId, uint16_t inStatusCode)
const char *
FirstWeekdayOfYear(uint16_t year)
uint8_t
FormatError(char *buf, uint16_t bufSize, const char *subsys, int32_t err, const char *desc)
void
Genera una cadena C terminada en NULL y legible que describe el error proporcionado.
GetArrayElementSize(uint32_t & aOutSize, const FieldDescriptor *aFieldPtr, SerializedFieldType aType)
GetFlag(const FlagsT & inFlags, const FlagT inFlag)
bool
IsBase34NoIOChar(char ch)
bool
IsLeapYear(uint16_t year)
bool
IsValidFieldType(SerializedFieldType aType)
bool
IsValidSerialNumber(const char *serialNum)
bool
LogEvent(TEvent *aEvent)
nl::Weave::Profiles::DataManagement::event_id_t
LogEvent(TEvent *aEvent, const nl::Weave::Profiles::DataManagement::EventOptions & aOptions)
nl::Weave::Profiles::DataManagement::event_id_t
ManufacturingWeekToDate(uint16_t mfgYear, uint8_t mfgWeek, uint16_t & year, uint8_t & month, uint8_t & day)
void
MarchBasedDayOfYearToMonth(uint16_t dayOfYear)
uint8_t
MarchBasedMonthToDayOfYear(uint8_t month)
uint16_t
NullifyAllEventFields(TEvent *aEvent)
void
OrdinalDateToCalendarDate(uint16_t year, uint16_t dayOfYear, uint8_t & month, uint8_t & dayOfMonth)
void
ReadDataForType(TLVReader & aReader, void *aStructureData, const FieldDescriptor *& aFieldPtr, SerializedFieldType aType, bool aInArray, SerializationContext *aContext)
Una función de lector para leer una entrada específica del TLV basada en datos de estructura.
ReadNullableDataForType(TLVReader & aReader, void *aStructureData, const FieldDescriptor *& aFieldPtr, SerializedFieldType aType, bool & aIsNullified, SerializationContext *aContext)
Una función de lector para verificar si los datos son anulables o anulables antes de leerlos desde el TLV.
RegisterErrorFormatter(ErrorFormatter *errFormatter)
NL_DLL_EXPORT void
Agrega una nueva función de formateador de errores a la lista global de formateadores de errores.
SecondsSinceEpochToCalendarTime(uint32_t secondsSinceEpoch, uint16_t & year, uint8_t & month, uint8_t & dayOfMonth, uint8_t & hour, uint8_t & minute, uint8_t & second)
void
SerializedDataToTLVWriter(TLVWriter & aWriter, void *aStructureData, const SchemaFieldDescriptor *aFieldDescriptors)
Función de escritor para convertir una estructura de datos en una estructura de TLV.
SerializedDataToTLVWriterHelper(TLVWriter & aWriter, uint8_t aDataTag, void *aAppData)
Una función de escritor de wrapper que rodea SerializedDataToTLVWriter con un contenedor.
SetFlag(FlagsT & inFlags, const FlagT inFlag)
void
SetFlag(FlagsT & inFlags, const FlagT inFlag, const bool inValue)
void
StatusReportStr(uint32_t profileId, uint16_t statusCode)
const char *
TLVReaderToDeserializedData(nl::Weave::TLV::TLVReader & aReader, void *aStructureData, const SchemaFieldDescriptor *aFieldDescriptors, SerializationContext *aContext)
Función de lector para convertir un TLV en una estructura C.
TLVReaderToDeserializedDataHelper(nl::Weave::TLV::TLVReader & aReader, uint8_t aDataTag, void *aAppData, SerializationContext *aContext)
Una función auxiliar que deserializa un solo elemento de datos TLV.
WriteArrayData(TLVWriter & aWriter, void *aStructureData, const FieldDescriptor *aFieldPtr)
Una función de escritor que escribe una estructura de array.
WriteDataForType(TLVWriter & aWriter, void *aStructureData, const FieldDescriptor *& aFieldPtr, SerializedFieldType aType, bool aInArray)
Una función de escritor escribe una entrada específica en el TLV basada en datos de estructura.
WriteNullableDataForType(TLVWriter & aWriter, void *aStructureData, const FieldDescriptor *& aFieldPtr, SerializedFieldType aType, bool aIsNullified)
Una función de escritor para verificar si los datos son anulables o nulos antes de escribir en el TLV.
secondsToMilliseconds(uint32_t seconds)
uint32_t

Structs

nl::ArrayLengthAndBuffer

Es un asistente para unir un array con una longitud.

nl::ErrorFormatter
nl::FieldDescriptor

Estructura que describe un campo TLV en una estructura de esquema y lo conecta con datos en una c-struct.

nl::Administración de la memoria

Una c-struct de funciones de asignación/liberación de memoria.

nl::SchemaFieldDescriptor

Une un array de FieldDescriptors para describir la estructura de un esquema.

nl::SerializationContext

Es una estructura c que contiene cualquier contexto o estado que necesitemos para serializar o deserializar.

nl::SerializedByteString
nl::SerializedFieldTypeBoolean_array
nl::SerializedFieldTypeByteString_array
nl::SerializedFieldTypeFloatingPoint32_array
nl::SerializedFieldTypeFloatingPoint64_array
nl::SerializedFieldTypeInt16_array
nl::SerializedFieldTypeInt32_array
nl::SerializedFieldTypeInt64_array
nl::SerializedFieldTypeInt8_array
nl::SerializedFieldTypeUInt16_array
nl::SerializedFieldTypeUInt32_array
nl::SerializedFieldTypeUInt64_array
nl::SerializedFieldTypeUInt8_array
nl::SerializedFieldTypeUTF8String_array
nl::StructureSchemaPointerPair

Combinación de datos con una estructura c de datos y el StructureSchemaDescriptor para escribir una estructura de TLV basada en esos datos.

Espacios de nombres

nl::ArgParser
nl::Ble

Este espacio de nombres incluye todas las interfaces de Weave para Bluetooth de bajo consumo (BLE), también conocidas como Bluetooth Smart.

nl::Inet
nl::NestCerts

Este espacio de nombres incluye símbolos globales para certificados de infraestructura de claves públicas (PKI) de Nest Weave.

nl::PairingCode
nl::Tibio
nl::Weave

Enumeraciones

@357

 @357

@358

 @358

@359

 @359

@360

 @360

@361

 @361

SerializedFieldType

 SerializedFieldType

Una lista de tipos de TLV para escribir con un campo de TLV.

Propiedades
SerializedFieldTypeArray

Tipo de array.

SerializedFieldTypeBoolean

Tipo booleano.

SerializedFieldTypeByteString

Tipo de cadena de bytes.

SerializedFieldTypeFloatingPoint32

Tipo de número de punto flotante de 32 bits

SerializedFieldTypeFloatingPoint64

Tipo de número de punto flotante de 64 bits

SerializedFieldTypeInt16

Tipo de 16 bits con firma.

SerializedFieldTypeInt32

Tipo de 32 bits con firma.

SerializedFieldTypeInt64

Tipo de 64 bits con firma.

SerializedFieldTypeInt8

Tipo de 8 bits con firma.

SerializedFieldTypeStructure

Tipo de estructura definida por el usuario.

SerializedFieldTypeUInt16

Tipo de 16 bits sin signo.

SerializedFieldTypeUInt32

Tipo de 32 bits sin signo.

SerializedFieldTypeUInt64

Tipo de 64 bits sin signo.

SerializedFieldTypeUInt8

Tipo de 8 bits sin signo.

SerializedFieldTypeUTF8String

Tipo de cadena UTF-8.

SerializedFieldTypeBits

 SerializedFieldTypeBits

Campo de bits de SerializedFieldType.

SerializedFieldTypeMasks

 SerializedFieldTypeMasks

Máscaras para acceder a bits de SerializedFieldType.

Typedefs

Base64CharToValFunct

uint8_t(* Base64CharToValFunct)(uint8_t c)

Base64ValToCharFunct

char(* Base64ValToCharFunct)(uint8_t val)

MemoryAllocate

void *(* MemoryAllocate)(size_t size)

Punteros de función libre o asignación de memoria.

MemoryFree

void(* MemoryFree)(void *ptr)

MemoryReallocate

void *(* MemoryReallocate)(void *ptr, size_t size)

Variables

sASN1ErrorFormatter

const ErrorFormatter sASN1ErrorFormatter =
{
    nl::Weave::ASN1::FormatASN1Error,
    NULL
}

sElementSize

const uint8_t sElementSize[] =
{
    sizeof(bool),                   
    sizeof(uint8_t),                
    sizeof(uint16_t),               
    sizeof(uint32_t),               
    sizeof(uint64_t),               
    sizeof(int8_t),                 
    sizeof(int16_t),                
    sizeof(int32_t),                
    sizeof(int64_t),                
    sizeof(float),                  
    sizeof(double),                 
    sizeof(char *),                 
    sizeof(SerializedByteString),   
    sizeof(void *),                 
    sizeof(void *)                  
}

sErrorFormatterList

const ErrorFormatter * sErrorFormatterList = &sWeaveErrorFormatter

Lista vinculada de funciones de formateador de errores.

sErrorStr

char sErrorStr[WEAVE_CONFIG_ERROR_STR_SIZE]

Búfer estático para almacenar la cadena de error con formato.

sErrorStr

char sErrorStr[1024]

Esta rutina muestra una cadena C terminada en NULL que es legible por humanos que describe el código de estado proporcionado y asociado con el perfil especificado.

Detalles
Parámetros
[in] profileId
El identificador de perfil de Weave asociado con
[in] statusCode
El código de estado en profileId para proporcionar una string descriptiva.
Resultado que se muestra
Un puntero a una cadena C terminada en NULL que describe el código de estado proporcionado dentro del perfil especificado.
También:
WEAVE_CONFIG_SHORT_ERROR_STR

sWeaveErrorFormatter

const ErrorFormatter sWeaveErrorFormatter =
{
    nl::Weave::FormatWeaveError,
    &sASN1ErrorFormatter
}

Funciones

AdjustCalendarDate

void AdjustCalendarDate(
  uint16_t & year,
  uint8_t & month,
  uint8_t & dayOfMonth,
  int32_t relativeDays
)

Base64CharToVal

uint8_t Base64CharToVal(
  uint8_t c
)

Base64Decode

uint16_t Base64Decode(
  const char *in,
  uint16_t inLen,
  uint8_t *out,
  Base64CharToValFunct charToValFunct
)

Base64Decode

uint16_t Base64Decode(
  const char *in,
  uint16_t inLen,
  uint8_t *out
)

Base64Decode32

uint32_t Base64Decode32(
  const char *in,
  uint32_t inLen,
  uint8_t *out,
  Base64CharToValFunct charToValFunct
)

Base64Decode32

uint32_t Base64Decode32(
  const char *in,
  uint32_t inLen,
  uint8_t *out
)

Base64Encode

uint16_t Base64Encode(
  const uint8_t *in,
  uint16_t inLen,
  char *out,
  Base64ValToCharFunct valToCharFunct
)

Base64Encode

uint16_t Base64Encode(
  const uint8_t *in,
  uint16_t inLen,
  char *out
)

Base64Encode32

uint32_t Base64Encode32(
  const uint8_t *in,
  uint32_t inLen,
  char *out,
  Base64ValToCharFunct valToCharFunct
)

Base64Encode32

uint32_t Base64Encode32(
  const uint8_t *in,
  uint32_t inLen,
  char *out
)

Base64URLCarToVal

uint8_t Base64URLCharToVal(
  uint8_t c
)

Decodificación de URLs con Base64

uint16_t Base64URLDecode(
  const char *in,
  uint16_t inLen,
  uint8_t *out
)

Codificación de URL Base64

uint16_t Base64URLEncode(
  const uint8_t *in,
  uint16_t inLen,
  char *out
)

Base64URLValToChar

char Base64URLValToChar(
  uint8_t val
)

Base64ValToChar

char Base64ValToChar(
  uint8_t val
)

CalendarDateToDaysSinceEpoch

bool CalendarDateToDaysSinceEpoch(
  uint16_t year,
  uint8_t month,
  uint8_t dayOfMonth,
  uint32_t & daysSinceEpoch
)

CalendarDateToOrdinalDate

void CalendarDateToOrdinalDate(
  uint16_t year,
  uint8_t month,
  uint8_t dayOfMonth,
  uint16_t & dayOfYear
)

CalendarTimeToSecondsSinceEpoch

bool CalendarTimeToSecondsSinceEpoch(
  uint16_t year,
  uint8_t month,
  uint8_t dayOfMonth,
  uint8_t hour,
  uint8_t minute,
  uint8_t second,
  uint32_t & secondsSinceEpoch
)

ClearFlag

void ClearFlag(
  FlagsT & inFlags,
  const FlagT inFlag
)

DateToManufacturingWeek

void DateToManufacturingWeek(
  uint16_t year,
  uint8_t month,
  uint8_t day,
  uint16_t & mfgYear,
  uint8_t & mfgWeek
)

DaysInMonth

uint8_t DaysInMonth(
  uint16_t year,
  uint8_t month
)

DaysSinceEpochToCalendarDate

void DaysSinceEpochToCalendarDate(
  uint32_t daysSinceEpoch,
  uint16_t & year,
  uint8_t & month,
  uint8_t & dayOfMonth
)

DaysToMarch1

uint8_t DaysToMarch1(
  uint16_t year
)

DeallocateDeserializedStructure

WEAVE_ERROR DeallocateDeserializedStructure(
  void *aStructureData,
  const SchemaFieldDescriptor *aFieldDescriptors,
  SerializationContext *aContext
)

ErrorStr

NL_DLL_EXPORT const char * ErrorStr(
  int32_t err
)

Esta rutina muestra una cadena C terminada en NULL y legible que describe el error proporcionado.

Detalles
Parámetros
[in] err
El error relacionado con dar formato y describir.
Resultado que se muestra
Un puntero a una cadena C terminada en NULL que describe el error proporcionado.

ExtractManufacturingDateFromSerialNumber

WEAVE_ERROR ExtractManufacturingDateFromSerialNumber(
  const char *serialNum,
  uint16_t & year,
  uint8_t & month,
  uint8_t & day
)

FindNullifiedFieldsArray

WEAVE_ERROR FindNullifiedFieldsArray(
  void *aStructureData,
  const SchemaFieldDescriptor *aSchemaDescriptor,
  uint8_t *& aNullifiedFields
)

Una función auxiliar para encontrar la ubicación del array de campos anulados ubicado al final del struct C.

Se espera que el miembro nullified_fields de la estructura C se ubique directamente después del último miembro descrito en el array de FieldDescriptors. No está en la lista de descriptores de campo, ya que está diseñado para ser una utilidad oculta para los creadores y consumidores de eventos anulables. Este miembro de la estructura no existe para los eventos sin campos anulables. Sin embargo, al crear métodos set y métodos get, no deben producirse accesos fuera de los límites.

Detalles
Parámetros
[in] aStructureData
Es un puntero a la c-struct.
[in] aSchemaDescriptor
SchemaFieldDescriptors para describir la c struct.
[out] aNullifiedFields
Un puntero para el miembro nullified_fields de la estructura c.
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
WEAVE_ERROR_INVALID_ARGUMENT
Si el puntero del descriptor de campo es NULL.
WEAVE_ERROR_INCORRECT_STATE
Si el formato de los descriptores de campo no coincide con las expectativas.

FindStatusReportStr

const char * FindStatusReportStr(
  uint32_t inProfileId,
  uint16_t inStatusCode
)

FirstWeekdayOfYear

uint8_t FirstWeekdayOfYear(
  uint16_t year
)

FormatError

void FormatError(
  char *buf,
  uint16_t bufSize,
  const char *subsys,
  int32_t err,
  const char *desc
)

Genera una cadena C terminada en NULL y legible que describe el error proporcionado.

Detalles
Parámetros
[in] buf
Es el búfer en el que se colocará la cadena de error.
[in] bufSize
Tamaño del búfer proporcionado en bytes.
[in] subsys
Una cadena corta que describe el subsistema que originó el error, o NULL si el origen del error es desconocido o no está disponible. Esta cadena debe tener 10 caracteres o menos.
[in] err
El error al que se va a formatear.
[in] desc
Una cadena que describe la causa o el significado del error, o NULL si la información no está disponible.

GetArrayElementSize

WEAVE_ERROR GetArrayElementSize(
  uint32_t & aOutSize,
  const FieldDescriptor *aFieldPtr,
  SerializedFieldType aType
)

GetFlag

bool GetFlag(
  const FlagsT & inFlags,
  const FlagT inFlag
)

IsBase34NoIOChar

bool IsBase34NoIOChar(
  char ch
)

IsLeapYear

bool IsLeapYear(
  uint16_t year
)

IsValidFieldType

bool IsValidFieldType(
  SerializedFieldType aType
)

IsValidSerialNumber

bool IsValidSerialNumber(
  const char *serialNum
)

LogEvent

nl::Weave::Profiles::DataManagement::event_id_t LogEvent(
  TEvent *aEvent
)

LogEvent

nl::Weave::Profiles::DataManagement::event_id_t LogEvent(
  TEvent *aEvent,
  const nl::Weave::Profiles::DataManagement::EventOptions & aOptions
)

ManufacturingWeekToDate

void ManufacturingWeekToDate(
  uint16_t mfgYear,
  uint8_t mfgWeek,
  uint16_t & year,
  uint8_t & month,
  uint8_t & day
)

MarchBasedDayOfYearToMonth

uint8_t MarchBasedDayOfYearToMonth(
  uint16_t dayOfYear
)

MarchBasedMonthToDayOfYear

uint16_t MarchBasedMonthToDayOfYear(
  uint8_t month
)

NullifyAllEventFields

void NullifyAllEventFields(
  TEvent *aEvent
)

OrdinalDateToCalendarDate

void OrdinalDateToCalendarDate(
  uint16_t year,
  uint16_t dayOfYear,
  uint8_t & month,
  uint8_t & dayOfMonth
)

ReadDataForType

WEAVE_ERROR ReadDataForType(
  TLVReader & aReader,
  void *aStructureData,
  const FieldDescriptor *& aFieldPtr,
  SerializedFieldType aType,
  bool aInArray,
  SerializationContext *aContext
)

Una función de lector para leer una entrada específica del TLV basada en datos de estructura.

Detalles
Parámetros
[in] aReader
El lector que se usará para leer en la estructura
[in] aStructureData
Un puntero para los datos de la estructura C que se leerán
[in,out] aFieldPtr
FieldDescriptor para describir los campos y la etiqueta TLV. La función aumentará el puntero s.t. Apuntará al siguiente elemento del array FieldDescritor.
[in] aType
El SerializedFieldType del campo
[in] aInArray
Verdadero si leemos un array (usa una etiqueta anónima)
[in] aContext
Contexto de serialización que contiene cualquier estado requerido para la operación.
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros errores que puede devolver aReader.

ReadNullableDataForType

WEAVE_ERROR ReadNullableDataForType(
  TLVReader & aReader,
  void *aStructureData,
  const FieldDescriptor *& aFieldPtr,
  SerializedFieldType aType,
  bool & aIsNullified,
  SerializationContext *aContext
)

Una función de lector para verificar si los datos son anulables o anulables antes de leerlos desde el TLV.

Detalles
Parámetros
[in] aReader
El lector que se usará para leer en la estructura
[in] aStructureData
Un puntero para los datos de la estructura C que se leerán
[in,out] aFieldPtr
FieldDescriptor para describir los campos y la etiqueta TLV. La función aumentará el puntero s.t. apuntará al siguiente elemento del array FieldDescriptor.
[in] aType
El SerializedFieldType del campo
[out] aIsNullified
Se configura para indicar que un campo está anulado.
[in] aContext
Contexto de serialización que contiene cualquier estado requerido para la operación.
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
other
Errores de TLV durante la escritura.

RegisterErrorFormatter

NL_DLL_EXPORT void RegisterErrorFormatter(
  ErrorFormatter *errFormatter
)

Agrega una nueva función de formateador de errores a la lista global de formateadores de errores.

Detalles
Parámetros
[in] errFormatter
Una estructura ErrorFormatter que contiene un puntero a la nueva función de error. Ten en cuenta que la función retendrá un puntero a la estructura ErrorFormatter proporcionada. Por lo tanto, la memoria de la estructura debe permanecer reservada.

SecondsSinceEpochToCalendarTime

void SecondsSinceEpochToCalendarTime(
  uint32_t secondsSinceEpoch,
  uint16_t & year,
  uint8_t & month,
  uint8_t & dayOfMonth,
  uint8_t & hour,
  uint8_t & minute,
  uint8_t & second
)

SerializedDataToTLVWriter

WEAVE_ERROR SerializedDataToTLVWriter(
  TLVWriter & aWriter,
  void *aStructureData,
  const SchemaFieldDescriptor *aFieldDescriptors
)

Función de escritor para convertir una estructura de datos en una estructura de TLV.

Usa un SchemaFieldDescriptor para interpretar la estructura de los datos y escribir en el TLV.

Detalles
Parámetros
[in] aWriter
El escritor que se debe usar para escribir la estructura
[in] aStructureData
Un puntero para los datos de la estructura c que se escribirán en función del SchemaFieldDescriptor.
[in] aFieldDescriptors
SchemaFieldDescriptors para describir la c struct + TLV
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros errores que debe mostrar el aWriter

SerializedDataToTLVWriterHelper

WEAVE_ERROR SerializedDataToTLVWriterHelper(
  TLVWriter & aWriter,
  uint8_t aDataTag,
  void *aAppData
)

Una función de escritor de wrapper que rodea SerializedDataToTLVWriter con un contenedor.

También divide un StructureSchemaPointerPair en datos estructurados y descriptores que se pasarán.

Detalles
Parámetros
[in] aWriter
El escritor que se debe usar para escribir la estructura
[in] aDataTag
Etiqueta para escribir
[in] aAppData
StructureSchemaPointerPair que contiene un puntero para estructurar datos y descriptores de campo. nulo* debido al prototipo
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros errores que debe mostrar el aWriter

SetFlag

void SetFlag(
  FlagsT & inFlags,
  const FlagT inFlag
)

SetFlag

void SetFlag(
  FlagsT & inFlags,
  const FlagT inFlag,
  const bool inValue
)

StatusReportStr

const char * StatusReportStr(
  uint32_t profileId,
  uint16_t statusCode
)

TLVReaderToDeserializedData

WEAVE_ERROR TLVReaderToDeserializedData(
  nl::Weave::TLV::TLVReader & aReader,
  void *aStructureData,
  const SchemaFieldDescriptor *aFieldDescriptors,
  SerializationContext *aContext
)

Función de lector para convertir TLV en una estructura C.

Usa un SchemaFieldDescriptor para interpretar la estructura de datos.

Debe ser robusta tanto para recorrer campos desconocidos como para no encontrar un campo esperado.

Detalles
Parámetros
[in] aReader
El lector que se usará para leer los datos
[in] aStructureData
Un puntero a los datos de la estructura c de destino que leeremos en función del SchemaFieldDescriptor.
[in] aFieldDescriptors
SchemaFieldDescriptors para describir la c struct + TLV
[in] aContext
Contexto de serialización que contiene cualquier estado requerido para la operación.
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros errores que puede devolver aReader.

TLVReaderToDeserializedDataHelper

WEAVE_ERROR TLVReaderToDeserializedDataHelper(
  nl::Weave::TLV::TLVReader & aReader,
  uint8_t aDataTag,
  void *aAppData,
  SerializationContext *aContext
)

Una función auxiliar que deserializa un solo elemento de datos TLV.

La función divide StructureSchemaPointerPair en datos de estructura y descriptores para pasar a ReadDataForType.

Detalles
Parámetros
[in] aReader
El lector que contiene datos para deserializar
[in] aDataTag
Sin usar por el momento
[in] aAppData
StructureSchemaPointerPair que contiene un puntero para estructurar datos y descriptores de campo. nulo* debido al prototipo
[in] aContext
Contexto de serialización que contiene cualquier estado requerido para la operación.
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros errores que puede devolver aReader.

WriteArrayData

WEAVE_ERROR WriteArrayData(
  TLVWriter & aWriter,
  void *aStructureData,
  const FieldDescriptor *aFieldPtr
)

Una función de escritor que escribe una estructura de array.

Detalles
Parámetros
[in] aWriter
El escritor que se debe usar para escribir la estructura
[in] aStructureData
Un puntero para los datos de la estructura c que se escribirán según el FieldDescriptor.
[in] aFieldPtr
FieldDescriptor para describir la struct c del array + TLV
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros errores que debe mostrar el aWriter

WriteDataForType

WEAVE_ERROR WriteDataForType(
  TLVWriter & aWriter,
  void *aStructureData,
  const FieldDescriptor *& aFieldPtr,
  SerializedFieldType aType,
  bool aInArray
)

Una función de escritor escribe una entrada específica en el TLV basada en datos de estructura.

Detalles
Parámetros
[in] aWriter
El escritor que se debe usar para escribir la estructura
[in] aStructureData
Un puntero para los datos de la estructura C que se escribirán
[in,out] aFieldPtr
FieldDescriptor para describir los campos y la etiqueta TLV. La función aumentará el puntero s.t. Apuntará al siguiente elemento del array FieldDescritor.
[in] aType
El SerializedFieldType del campo
[in] aInArray
Verdadero si escribimos un array (usa una etiqueta anónima).
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros errores que debe mostrar el aWriter

WriteNullableDataForType

WEAVE_ERROR WriteNullableDataForType(
  TLVWriter & aWriter,
  void *aStructureData,
  const FieldDescriptor *& aFieldPtr,
  SerializedFieldType aType,
  bool aIsNullified
)

Una función de escritor para verificar si los datos son anulables o nulos antes de escribir en el TLV.

Detalles
Parámetros
[in] aWriter
El escritor que se debe usar para escribir la estructura
[in] aStructureData
Un puntero para los datos de la estructura C que se leerán
[in,out] aFieldPtr
FieldDescriptor para describir los campos y la etiqueta TLV. La función aumentará el puntero s.t. apuntará al siguiente elemento del array FieldDescriptor.
[in] aType
El SerializedFieldType del campo
[in] aIsNullified
La etiqueta de TLV se anulará si esto es verdadero.
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
other
Errores de TLV durante la escritura.

secondsToMilliseconds

uint32_t secondsToMilliseconds(
  uint32_t seconds
)