nl

Forçages nlassert.h spécifiques à Weave.

Résumé

Énumérations

@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
Liste des types TLV à écrire avec un champ TLV.
SerializedFieldTypeBits enum
Champ de bits de SerializedFieldType.
SerializedFieldTypeMasks enum
Masques d'accès aux bits de SerializedFieldType.

Typedefs

Base64CharToValFunct)(uint8_t c) typedef
uint8_t(*
Base64ValToCharFunct)(uint8_t val) typedef
char(*
MemoryAllocate)(size_t size) typedef
void *(*
Pointeurs de fonction d'allocation/libre de mémoire.
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 *
Liste liée des fonctions de mise en forme des erreurs.
sErrorStr[WEAVE_CONFIG_ERROR_STR_SIZE]
char
Tampon statique pour stocker la chaîne d'erreur mise en forme.
sErrorStr[1024]
char
Cette routine renvoie une chaîne C lisible se terminant par une valeur NULL décrivant le code d'état fourni associé au profil spécifié.
sWeaveErrorFormatter = { nl::Weave::FormatWeaveError, &sASN1ErrorFormatter }

distantes

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 *
Cette routine renvoie une chaîne C lisible se terminant par une valeur NULL, décrivant l'erreur fournie.
ExtractManufacturingDateFromSerialNumber(const char *serialNum, uint16_t & year, uint8_t & month, uint8_t & day)
FindNullifiedFieldsArray(void *aStructureData, const SchemaFieldDescriptor *aSchemaDescriptor, uint8_t *& aNullifiedFields)
Fonction d'assistance permettant de trouver l'emplacement du tableau de champs nuls situé à la fin de la structure 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
Génère une chaîne C lisible se terminant par une valeur NULL décrivant l'erreur fournie.
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)
Fonction de lecteur permettant de lire une entrée spécifique du TLV en fonction des données de structure.
ReadNullableDataForType(TLVReader & aReader, void *aStructureData, const FieldDescriptor *& aFieldPtr, SerializedFieldType aType, bool & aIsNullified, SerializationContext *aContext)
Fonction de lecteur permettant de vérifier si les données peuvent être nulles ou nulles avant de les lire à partir du TLV.
RegisterErrorFormatter(ErrorFormatter *errFormatter)
NL_DLL_EXPORT void
Ajout d'une fonction de mise en forme des erreurs à la liste globale des outils de mise en forme des erreurs.
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)
Une fonction d'écriture permettant de convertir une structure de données en structure TLV.
SerializedDataToTLVWriterHelper(TLVWriter & aWriter, uint8_t aDataTag, void *aAppData)
Fonction de rédacteur de wrapper qui entoure le SerializedDataToTLVWriter d'un conteneur.
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)
Une fonction de lecteur permettant de convertir le TLV en une structure C.
TLVReaderToDeserializedDataHelper(nl::Weave::TLV::TLVReader & aReader, uint8_t aDataTag, void *aAppData, SerializationContext *aContext)
Fonction d'assistance qui désérialise un seul élément de données TLV.
WriteArrayData(TLVWriter & aWriter, void *aStructureData, const FieldDescriptor *aFieldPtr)
Fonction d'écriture qui écrit une structure de tableau.
WriteDataForType(TLVWriter & aWriter, void *aStructureData, const FieldDescriptor *& aFieldPtr, SerializedFieldType aType, bool aInArray)
Une fonction d'écriture écrit une entrée spécifique dans le TLV en fonction des données structurées.
WriteNullableDataForType(TLVWriter & aWriter, void *aStructureData, const FieldDescriptor *& aFieldPtr, SerializedFieldType aType, bool aIsNullified)
Une fonction d'écriture permettant de vérifier si les données peuvent être nulles ou nulles avant d'écrire dans le TLV.
secondsToMilliseconds(uint32_t seconds)
uint32_t

Structs

nl::ArrayLengthAndBuffer

Aide pour encapsuler un tableau avec une longueur.

nl::ErrorFormatter
nl::FieldDescriptor

Structure décrivant un champ TLV dans une structure de schéma et le connectant aux données d'une structure c-struct.

nl::MemoryManagement

c-struct des fonctions d'allocation de mémoire/libre de mémoire.

nl::SchemaFieldDescriptor

Encapsulez un tableau de descripteurs de champ pour décrire une structure/structure de schéma.

nl::SerializationContext

C-struct contenant tout contexte ou état dont nous avons besoin pour la sérialisation ou la désérialisation.

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

Paire de données avec une c-struct de données et le StructureSchemaDescriptor pour écrire une structure TLV basée sur ces données.

Espaces de noms

nl::ArgParser
nl::Ble

Cet espace de noms inclut toutes les interfaces de Weave pour la technologie BLE (Bluetooth basse consommation), également appelée Bluetooth Smart.

nl::Inet
nl::NestCerts

Cet espace de noms inclut les symboles globaux correspondant aux certificats d'infrastructure à clé publique (PKI) Nest Weave.

nl::PairingCode
nl::Chaud
nl::Weave

Énumérations

@357

 @357

@358

 @358

@359

 @359

@360

 @360

@361

 @361

SerializedFieldType

 SerializedFieldType

Liste des types TLV à écrire avec un champ TLV.

Propriétés
SerializedFieldTypeArray

Type de tableau

SerializedFieldTypeBoolean

Type booléen.

SerializedFieldTypeByteString

Type de chaîne d'octets.

SerializedFieldTypeFloatingPoint32

Type flottant 32 bits

SerializedFieldTypeFloatingPoint64

Type flottant 64 bits

SerializedFieldTypeInt16

Type signé 16 bits.

SerializedFieldTypeInt32

Type signé 32 bits.

SerializedFieldTypeInt64

Type signé 64 bits.

SerializedFieldTypeInt8

Type signé de 8 bits.

SerializedFieldTypeStructure

Type de structure défini par l'utilisateur.

SerializedFieldTypeUInt16

Type 16 bits non signé.

SerializedFieldTypeUInt32

Type 32 bits non signé.

SerializedFieldTypeUInt64

Type 64 bits non signé.

SerializedFieldTypeUInt8

Type 8 bits non signé.

SerializedFieldTypeUTF8String

Type de chaîne UTF-8.

SerializedFieldTypeBits

 SerializedFieldTypeBits

Champ de bits de SerializedFieldType.

SerializedFieldTypeMasks

 SerializedFieldTypeMasks

Masques d'accès aux bits de SerializedFieldType.

Typedefs

Base64CharToValFunct

uint8_t(* Base64CharToValFunct)(uint8_t c)

Base64ValToCharFunct

char(* Base64ValToCharFunct)(uint8_t val)

MemoryAllocate

void *(* MemoryAllocate)(size_t size)

Pointeurs de fonction d'allocation/libre de mémoire.

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

Liste liée des fonctions de mise en forme des erreurs.

sErrorStr

char sErrorStr[WEAVE_CONFIG_ERROR_STR_SIZE]

Tampon statique pour stocker la chaîne d'erreur mise en forme.

sErrorStr

char sErrorStr[1024]

Cette routine renvoie une chaîne C lisible se terminant par une valeur NULL décrivant le code d'état fourni associé au profil spécifié.

Détails
Paramètres
[in] profileId
Identifiant du profil Weave associé au
[in] statusCode
Code d'état dans profileId pour lequel une chaîne descriptive doit être fournie.
Renvoie
Pointeur vers une chaîne C se terminant par une valeur NULL décrivant le code d'état fourni dans le profil spécifié.
Voir aussi:
WEAVE_CONFIG_SHORT_ERROR_STR

sWeaveErrorFormatter

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

distantes

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
)

Base64URLCharToVal

uint8_t Base64URLCharToVal(
  uint8_t c
)

Décodage d'URL Base64

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

Encode d'URL Base64

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

URL Base64ValToChar

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
)

Cette routine renvoie une chaîne C lisible se terminant par une valeur NULL, décrivant l'erreur fournie.

Détails
Paramètres
[in] err
Erreur de mise en forme et de description.
Renvoie
Pointeur vers une chaîne C terminée en mode NULL décrivant l'erreur fournie.

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
)

Fonction d'assistance permettant de trouver l'emplacement du tableau de champs nuls situé à la fin de la structure C.

Le membre nullified_fields de la structure C doit se trouver directement après le dernier membre décrit par le tableau de FieldDescriptors. Elle ne figure pas dans la liste des descripteurs de champ, car elle est destinée à être un utilitaire caché pour les créateurs et les consommateurs d'événements pouvant avoir une valeur nulle. Ce membre struct n'existe pas pour les événements sans champ pouvant avoir une valeur nulle. Toutefois, en construisant des setters et des getters, aucun accès hors limites ne devrait se produire.

Détails
Paramètres
[in] aStructureData
Pointeur vers c-struct.
[in] aSchemaDescriptor
SchemaFieldDescripteurs pour décrire la structure c.
[out] aNullifiedFields
Pointeur vers le membre nullified_fields de la structure c.struct.
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
WEAVE_ERROR_INVALID_ARGUMENT
Si le pointeur de descripteur de champ est NULL.
WEAVE_ERROR_INCORRECT_STATE
Si le format des descripteurs de champ ne correspond pas aux attentes.

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
)

Génère une chaîne C lisible se terminant par une valeur NULL décrivant l'erreur fournie.

Détails
Paramètres
[in] buf
Tampon dans lequel la chaîne d'erreur sera placée.
[in] bufSize
Taille du tampon fourni, en octets.
[in] subsys
Courte chaîne décrivant le sous-système à l'origine de l'erreur, ou valeur NULL si l'origine de l'erreur est inconnue/indisponible. Cette chaîne ne doit pas comporter plus de 10 caractères.
[in] err
Erreur à formater.
[in] desc
Chaîne décrivant la cause ou la signification de l'erreur, ou valeur NULL si aucune information de ce type n'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
)

Fonction de lecteur permettant de lire une entrée spécifique du TLV en fonction des données de structure.

Détails
Paramètres
[in] aReader
Lecteur à utiliser pour lire la structure
[in] aStructureData
Un pointeur vers les données de structure c à lire
[in,out] aFieldPtr
FieldDescriptor pour décrire les champs et la balise TLV. La fonction incrémente le pointeur jusqu'à atteindre l'élément suivant du tableau FieldDescritor
[in] aType
SerializedFieldType du champ.
[in] aInArray
"True" si nous lisons un tableau (utilisez une balise anonyme)
[in] aContext
Contexte de sérialisation contenant tout état requis pour l'opération.
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
other
Autres erreurs susceptibles d'être renvoyées par l'objet aReader.

ReadNullableDataForType

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

Fonction de lecteur permettant de vérifier si les données peuvent être nulles ou nulles avant de les lire à partir du TLV.

Détails
Paramètres
[in] aReader
Lecteur à utiliser pour lire la structure
[in] aStructureData
Un pointeur vers les données de structure c à lire
[in,out] aFieldPtr
FieldDescriptor pour décrire les champs et la balise TLV. La fonction incrémente le pointeur jusqu'à atteindre l'élément suivant du tableau FieldDescriptor
[in] aType
SerializedFieldType du champ.
[out] aIsNullified
Défini pour indiquer qu'un champ est nul.
[in] aContext
Contexte de sérialisation contenant tout état requis pour l'opération.
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
other
Erreurs TLV lors de l'écriture.

RegisterErrorFormatter

NL_DLL_EXPORT void RegisterErrorFormatter(
  ErrorFormatter *errFormatter
)

Ajout d'une fonction de mise en forme des erreurs à la liste globale des outils de mise en forme des erreurs.

Détails
Paramètres
[in] errFormatter
Structure ErrorFormatter contenant un pointeur vers la nouvelle fonction d'erreur. Notez qu'un pointeur vers la structure ErrorFormatter fournie sera conservé par la fonction. Ainsi, la mémoire de la structure doit rester réservée.

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
)

Une fonction d'écriture permettant de convertir une structure de données en structure TLV.

Utilise un SchemaFieldDescriptor pour interpréter la structure de données et écrire dans le TLV.

Détails
Paramètres
[in] aWriter
L'auteur à utiliser pour rédiger la structure
[in] aStructureData
Pointeur vers les données de structure c à écrire en fonction de SchemaFieldDescriptor
[in] aFieldDescriptors
SchemaFieldDescripteurs pour décrire la structure c + TLV
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
other
Autres erreurs pouvant être renvoyées par aWriter.

SerializedDataToTLVWriterHelper

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

Fonction de rédacteur de wrapper qui entoure le SerializedDataToTLVWriter d'un conteneur.

Divise également un StructureSchemaPointerPair en données de structure et en descripteurs à transmettre.

Détails
Paramètres
[in] aWriter
L'auteur à utiliser pour rédiger la structure
[in] aDataTag
Tag à écrire
[in] aAppData
StructureSchemaPointerPair qui contient un pointeur vers les descripteurs de champ et les données de structure. vide* en raison du prototype
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
other
Autres erreurs pouvant être renvoyées par 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
)

Une fonction de lecteur permettant de convertir le TLV en une structure C.

Utilise un SchemaFieldDescriptor pour interpréter la structure des données.

Elle doit être fiable à la fois pour encourager les champs inconnus et ne pas rencontrer de champ attendu.

Détails
Paramètres
[in] aReader
Le lecteur à utiliser pour lire les données
[in] aStructureData
Pointeur vers les données de structure c de destination que nous lireons en fonction de SchemaFieldDescriptor
[in] aFieldDescriptors
SchemaFieldDescripteurs pour décrire la structure c + TLV
[in] aContext
Contexte de sérialisation contenant tout état requis pour l'opération.
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
other
Autres erreurs pouvant être renvoyées par aReader.

TLVReaderToDeserializedDataHelper

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

Fonction d'assistance qui désérialise un seul élément de données TLV.

La fonction divise StructureSchemaPointerPair en données de structure et en descripteurs à transmettre à ReadDataForType.

Détails
Paramètres
[in] aReader
Lecteur contenant les données à désérialiser
[in] aDataTag
Non utilisée pour le moment
[in] aAppData
StructureSchemaPointerPair qui contient un pointeur vers les descripteurs de champ et les données de structure. vide* en raison du prototype
[in] aContext
Contexte de sérialisation contenant tout état requis pour l'opération.
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
other
Autres erreurs susceptibles d'être renvoyées par l'objet aReader.

WriteArrayData

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

Fonction d'écriture qui écrit une structure de tableau.

Détails
Paramètres
[in] aWriter
L'auteur à utiliser pour rédiger la structure
[in] aStructureData
Pointeur vers les données de structure c à écrire en fonction de FieldDescriptor
[in] aFieldPtr
FieldDescriptor pour décrire le tableau "c struct + TLV"
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
other
Autres erreurs pouvant être renvoyées par aWriter.

WriteDataForType

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

Une fonction d'écriture écrit une entrée spécifique dans le TLV en fonction des données structurées.

Détails
Paramètres
[in] aWriter
L'auteur à utiliser pour rédiger la structure
[in] aStructureData
Un pointeur vers les données de structure c à écrire
[in,out] aFieldPtr
FieldDescriptor pour décrire les champs et la balise TLV. La fonction incrémente le pointeur jusqu'à atteindre l'élément suivant du tableau FieldDescritor
[in] aType
SerializedFieldType du champ.
[in] aInArray
"True" si nous écrivons un tableau (utiliser une balise anonyme)
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
other
Autres erreurs pouvant être renvoyées par aWriter.

WriteNullableDataForType

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

Une fonction d'écriture permettant de vérifier si les données peuvent être nulles ou nulles avant d'écrire dans le TLV.

Détails
Paramètres
[in] aWriter
L'auteur à utiliser pour rédiger la structure
[in] aStructureData
Un pointeur vers les données de structure c à lire
[in,out] aFieldPtr
FieldDescriptor pour décrire les champs et la balise TLV. La fonction incrémente le pointeur jusqu'à atteindre l'élément suivant du tableau FieldDescriptor
[in] aType
SerializedFieldType du champ.
[in] aIsNullified
Si la valeur est "true", la balise TLV est nulle.
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
other
Erreurs TLV lors de l'écriture.

secondsToMilliseconds

uint32_t secondsToMilliseconds(
  uint32_t seconds
)