nl

Anula nlAssert.h específico 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 de ubicación gratuita o 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 string de error con formato.
sErrorStr[1024]
char
Esta rutina muestra una string C terminada en NULL en lenguaje natural que describe el código de estado proporcionado asociado al perfil especificado.
sWeaveErrorFormatter = { nl::Weave::FormatWeaveError, &sASN1ErrorFormatter }

Functions
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 string C terminada por NULL en lenguaje natural 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 arreglo de campos anulados ubicado al final de la estructura 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 string C terminada en NULL en lenguaje natural 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)
Función de lector para leer una entrada específica del TLV según los 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 se pueden anular o anular antes de leer 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 TLV.
SerializedDataToTLVWriterHelper(TLVWriter & aWriter, uint8_t aDataTag, void *aAppData)
Una función de escritor de wrappers que rodea a 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 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 arreglo.
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 según los 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 se pueden anular o anular antes de escribir en el TLV.
secondsToMilliseconds(uint32_t seconds)
uint32_t

Structs
nl::ArrayLengthAndBuffer

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 la conecta a datos en una estructura c.

nl::Administración de memoria

Una estructura C de funciones de asignación de memoria o libres.

nl::SchemaFieldDescriptor

Rodea un array de FieldDescriptors para describir una estructura o estructura de esquema.

nl::SerializationContext

Una c-struct 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

Par de datos con una estructura c de datos y el StructureSchemaDescriptor para escribir una estructura 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 conocido como Bluetooth Smart.

nl::Inet
nl::NestCerts

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

nl::Código de vinculación
nl::Calidez
nl::Weave

Enumeraciones

@357

 @357

@358

 @358

@359

 @359

@360

 @360

@361

 @361

Tipo de serie de serie

 SerializedFieldType

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

Properties
SerializedFieldTypeArray

Tipo de arreglo.

SerializedFieldTypeBoolean

Tipo booleano.

SerializedFieldTypeByteString

Tipo de string de bytes

SerializedFieldTypeFloatingPoint32

Tipo flotante de 32 bits

SerializedFieldTypeFloatingPoint64

Tipo 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

Es el tipo de estructura definido por el usuario.

SerializedFieldTypeUInt16

Tipo de 16 bits sin firma.

SerializedFieldTypeUInt32

Tipo de 32 bits sin firma.

SerializedFieldTypeUInt64

Tipo de 64 bits sin firma.

SerializedFieldTypeUInt8

Tipo de 8 bits sin signo.

SerializedFieldTypeUTF8String

Es el tipo de string UTF-8.

Tipo de campo serializado

 SerializedFieldTypeBits

Campo de bits de SerializedFieldType.

Máscaras de tipo serializador de campos

 SerializedFieldTypeMasks

Máscaras para acceder a bits de SerializedFieldType.

Typedefs

Base64CharToValFunct

uint8_t(* Base64CharToValFunct)(uint8_t c)

Base64ValToCharFunct

char(* Base64ValToCharFunct)(uint8_t val)

Memoria asignada

void *(* MemoryAllocate)(size_t size)

Punteros de función de ubicación gratuita o memoria

Sin memoria

void(* MemoryFree)(void *ptr)

Asignación de memoria

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

Variables

sASN1ErrorFormatter.

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

Tamaño_sElemento

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 *)                  
}

ListaDeErrorFormato

const ErrorFormatter * sErrorFormatterList = &sWeaveErrorFormatter

Lista vinculada de funciones de formateador de errores.

Error

char sErrorStr[WEAVE_CONFIG_ERROR_STR_SIZE]

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

Error

char sErrorStr[1024]

Esta rutina muestra una string C terminada en NULL en lenguaje natural que describe el código de estado proporcionado asociado al perfil especificado.

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

ErrorErrorDeFormato

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

Functions

AjustarCalendario

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
)

Codifica en Base64

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

Codifica en Base64

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

Base64Codificación32

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

Base64Codificación32

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

Base64URLCharToVal

uint8_t Base64URLCharToVal(
  uint8_t c
)

Base64URLDecode

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

Base64URLEncode

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

Base64URLValToChar

char Base64URLValToChar(
  uint8_t val
)

Base64ValToChar

char Base64ValToChar(
  uint8_t val
)

Fecha del calendario hasta el día de cierre

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

Fecha del calendario o fecha ordinal

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

Tiempo de calendario al segundo desde el comienzo

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

Borrar bandera

void ClearFlag(
  FlagsT & inFlags,
  const FlagT inFlag
)

FechaToManufactureWeek

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

Días en el mes

uint8_t DaysInMonth(
  uint16_t year,
  uint8_t month
)

DíasDesde EpochToCalendarDate

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

Días hasta marzo1

uint8_t DaysToMarch1(
  uint16_t year
)

DealLOcateDeserializedStructure

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

Error

NL_DLL_EXPORT const char * ErrorStr(
  int32_t err
)

Esta rutina muestra una string C terminada por NULL en lenguaje natural que describe el error proporcionado.

Detalles
Parámetros
[in] err
El error de formato y descripción.
Qué muestra
Un puntero para una string de C terminada en NULL y en la que se describe el error proporcionado.

ExtraerManufactureDateFromSerialNumber

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 arreglo de campos anulados ubicado al final de la estructura C.

Se espera que el miembro nullified_fields de la estructura C se ubique directamente después del último miembro descrito por el arreglo de FieldDescriptors. No se encuentra en la lista de descriptores de campo, ya que es una utilidad oculta para creadores y consumidores de eventos anulables. Este miembro del struct no existe para los eventos sin campos anulables. Sin embargo, mediante la construcción de métodos set y get, no debería ocurrir ningún acceso fuera de los límites.

Detalles
Parámetros
[in] aStructureData
Un puntero para la estructura c.
[in] aSchemaDescriptor
SchemaFieldDescriptors para describir la estructura c.
[out] aNullifiedFields
Un puntero para el miembro nullified_fields de la estructura c.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación se realiza correctamente
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 cumple con la expectativa.

FindStatusReportStr

const char * FindStatusReportStr(
  uint32_t inProfileId,
  uint16_t inStatusCode
)

Primer día de la semana

uint8_t FirstWeekdayOfYear(
  uint16_t year
)

Error de formato

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

Genera una string C terminada en NULL en lenguaje natural que describe el error proporcionado.

Detalles
Parámetros
[in] buf
Es el búfer en el que se colocará la string de error.
[in] bufSize
Tamaño del búfer proporcionado en bytes.
[in] subsys
Una string corta que describe el subsistema que originó el error, o NULL si el origen del error es desconocido o no está disponible. Esta string debe tener 10 caracteres o menos.
[in] err
El error al que se le debe aplicar formato.
[in] desc
Una string que describe la causa o el significado del error, o NULL si tal 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
)

año bisiesto

bool IsLeapYear(
  uint16_t year
)

Tipo de campo válido

bool IsValidFieldType(
  SerializedFieldType aType
)

Número de serie válido

bool IsValidSerialNumber(
  const char *serialNum
)

Evento de registro

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

Evento de registro

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

Semana de fabricación

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

Día_marzodelAño

uint8_t MarchBasedDayOfYearToMonth(
  uint16_t dayOfYear
)

Mes en base a marzo

uint16_t MarchBasedMonthToDayOfYear(
  uint8_t month
)

NullifyAllEventFields

void NullifyAllEventFields(
  TEvent *aEvent
)

Fecha ordinal del calendario

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

TipoDeDatosDeDatosDeLectura

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

Función de lector para leer una entrada específica del TLV según los datos de estructura.

Detalles
Parámetros
[in] aReader
Lector que se usará para leer en la estructura
[in] aStructureData
Un puntero para los datos de la estructura C a fin de leer
[in,out] aFieldPtr
FieldDescriptor para describir los campos y la etiqueta TLV. La función aumentará el puntero s.t. que hará que apunte al siguiente elemento en el array FieldDescritor
[in] aType
El campo SerializedFieldType del campo
[in] aInArray
Verdadero si estamos leyendo un array (usamos la etiqueta anónima)
[in] aContext
Contexto de serialización que contiene cualquier estado necesario para la operación.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación se realiza correctamente
other
Otros errores que se muestran en aReader.

LeeNullableDataForType

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 se pueden anular o anular antes de leer desde el TLV

Detalles
Parámetros
[in] aReader
Lector que se usará para leer en la estructura
[in] aStructureData
Un puntero para los datos de la estructura C a fin de leer
[in,out] aFieldPtr
FieldDescriptor para describir los campos y la etiqueta TLV. La función aumentará el puntero s.t. que hará que apunte al siguiente elemento en el array FieldDescriptor
[in] aType
El campo SerializedFieldType del campo
[out] aIsNullified
Se establece para indicar que un campo está anulado.
[in] aContext
Contexto de serialización que contiene cualquier estado necesario para la operación.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación se realiza correctamente
other
Errores de TLV mientras se escribe.

RegistrarErrorFormatter

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.

Segundos a partir del momento del calendario

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 TLV.

Usa un SchemaFieldDescriptor para interpretar la estructura de 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 para escribir en función del SchemaFieldDescriptor
[in] aFieldDescriptors
SchemaFieldDescriptors para describir la estructura c + TLV
Valores que se muestran
WEAVE_NO_ERROR
Si la operación se realiza correctamente
other
Otros errores que se pueden mostrar desde aWriter

SerializedDataToTLVWriterHelper

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

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

También divide un StructureSchemaPointerPair en datos de estructura y descriptores para pasar.

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. void* debido al prototipo.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación se realiza correctamente
other
Otros errores que se pueden mostrar desde aWriter

Marcar

void SetFlag(
  FlagsT & inFlags,
  const FlagT inFlag
)

Marcar

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

InformeDeEstadoDeEstado

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 robusto para incluir campos desconocidos y no encontrar un campo esperado.

Detalles
Parámetros
[in] aReader
Lector que se usará para leer los datos
[in] aStructureData
Un puntero para los datos de estructura c de destino en los que se leerá según el SchemaFieldDescriptor
[in] aFieldDescriptors
SchemaFieldDescriptors para describir la estructura c + TLV
[in] aContext
Contexto de serialización que contiene cualquier estado necesario para la operación.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación se realiza correctamente
other
Otros errores que se pueden mostrar desde 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 los datos que se deserializarán
[in] aDataTag
No utilizado por el momento
[in] aAppData
StructureSchemaPointerPair que contiene un puntero para estructurar datos y descriptores de campo. void* debido al prototipo.
[in] aContext
Contexto de serialización que contiene cualquier estado necesario para la operación.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación se realiza correctamente
other
Otros errores que se muestran en aReader.

WriteArrayData

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

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

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 para escribir en función del FieldDescriptor
[in] aFieldPtr
FieldDescriptor para describir el struct c + TLV del array
Valores que se muestran
WEAVE_NO_ERROR
Si la operación se realiza correctamente
other
Otros errores que se pueden mostrar desde aWriter

Escribir en DataForType

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 según los 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 a fin de escribir
[in,out] aFieldPtr
FieldDescriptor para describir los campos y la etiqueta TLV. La función aumentará el puntero s.t. que hará que apunte al siguiente elemento en el array FieldDescritor
[in] aType
El campo SerializedFieldType del campo
[in] aInArray
Verdadero si se escribe un array (usar una etiqueta anónima)
Valores que se muestran
WEAVE_NO_ERROR
Si la operación se realiza correctamente
other
Otros errores que se pueden mostrar desde 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 se pueden anular o anular 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 a fin de leer
[in,out] aFieldPtr
FieldDescriptor para describir los campos y la etiqueta TLV. La función aumentará el puntero s.t. que hará que apunte al siguiente elemento en el array FieldDescriptor
[in] aType
El campo SerializedFieldType del campo
[in] aIsNullified
Se anulará la etiqueta TLV si es verdadero.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación se realiza correctamente
other
Errores de TLV mientras se escribe.

segundosAMilisegundos

uint32_t secondsToMilliseconds(
  uint32_t seconds
)