nl

עקיפת nlassert.h ספציפיים ל-Weave.

סיכום

ספירות

@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)
רשימה של סוגי TLV שאפשר לכתוב עם השדה TLV.
SerializedFieldTypeBits טיפוסים בני מנייה (enum)
שדה Bitfield של SerializedFieldType.
SerializedFieldTypeMasks טיפוסים בני מנייה (enum)
מסכות לגישה לקטעים ב-SerializedFieldType.

ערכי דף

Base64CharToValFunct)(uint8_t c) typedef
uint8_t(*
Base64ValToCharFunct)(uint8_t val) typedef
char(*
MemoryAllocate)(size_t size) typedef
void *(*
הקצאת זיכרון/מצביעים של פונקציות חופשיות.
MemoryFree)(void *ptr) typedef
void(*
MemoryReallocate)(void *ptr, size_t size) typedef
void *(*

משתנים

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 *
רשימה מקושרת של פונקציות פורמט שגיאות.
sErrorStr[WEAVE_CONFIG_ERROR_STR_SIZE]
char
מאגר נתונים זמני כדי לאחסן את מחרוזת השגיאה בפורמט.
sErrorStr[1024]
char
התרחיש הזה מחזיר מחרוזת C שמסתיימת ב-NULL, שמתארת את קוד הסטטוס שסופק ומשויך לפרופיל שצוין.
sWeaveErrorFormatter = { nl::Weave::FormatWeaveError, &sASN1ErrorFormatter }

פונקציות

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 *
התרחיש הזה מחזיר מחרוזת C שמסתיימת ב-NULL, שמתארת את השגיאה שסופקה.
ExtractManufacturingDateFromSerialNumber(const char *serialNum, uint16_t & year, uint8_t & month, uint8_t & day)
FindNullifiedFieldsArray(void *aStructureData, const SchemaFieldDescriptor *aSchemaDescriptor, uint8_t *& aNullifiedFields)
פונקציית עזר לאיתור המיקום של מערך השדות המבוטלים, שנמצא בסוף ה-C struct.
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
יוצרת מחרוזת C קטועה מסוג NULL, שמתארת את השגיאה שסופקה.
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)
פונקציית קריאה לקריאת רשומה ספציפית מ-TLV על סמך נתוני מבנה.
ReadNullableDataForType(TLVReader & aReader, void *aStructureData, const FieldDescriptor *& aFieldPtr, SerializedFieldType aType, bool & aIsNullified, SerializationContext *aContext)
פונקציית קריאה שבודקת אם הנתונים הם ריקים או מבוטלים לפני קריאה מה-TLV.
RegisterErrorFormatter(ErrorFormatter *errFormatter)
NL_DLL_EXPORT void
הוספת פונקציה חדשה של מעצב שגיאות לרשימה הגלובלית של מעצבי שגיאות.
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)
פונקציית כתיבה להמרה של מבנה נתונים למבנה TLV.
SerializedDataToTLVWriterHelper(TLVWriter & aWriter, uint8_t aDataTag, void *aAppData)
פונקציית wrapper שמקיפה את SerializedDataToTLVWriter עם הקונטיינר.
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)
פונקציית קריאה להמרת טקסט TLV ל-C-struct.
TLVReaderToDeserializedDataHelper(nl::Weave::TLV::TLVReader & aReader, uint8_t aDataTag, void *aAppData, SerializationContext *aContext)
פונקציית מסייע שמבצעת פעולת deserialize של רכיב נתונים אחד של רמת פירוט גבוהה (TLV).
WriteArrayData(TLVWriter & aWriter, void *aStructureData, const FieldDescriptor *aFieldPtr)
פונקציית כתיבה שכותבת מבנה מערך.
WriteDataForType(TLVWriter & aWriter, void *aStructureData, const FieldDescriptor *& aFieldPtr, SerializedFieldType aType, bool aInArray)
פונקציית כתיבה כותבת רשומה ספציפית ל-TLV על סמך נתוני מבנה.
WriteNullableDataForType(TLVWriter & aWriter, void *aStructureData, const FieldDescriptor *& aFieldPtr, SerializedFieldType aType, bool aIsNullified)
פונקציית כתיבה שבודקת אם הנתונים הם ריקים או null לפני כתיבה ל-TLV.
secondsToMilliseconds(uint32_t seconds)
uint32_t

מבנים

nl::ArrayLengthAndBuffer

רכיב עזר לגלישת מערך עם אורך.

nl::ErrorFormatter
nl::FieldDescriptor

מבנה שמתאר שדה TLV במבנה של סכימה ומחבר אותו לנתונים ב-c-struct.

nl::MemoryManagement

c-struct של פונקציות הקצאת זיכרון/חופש.

nl::SchemaFieldDescriptor

גלישת טקסט סביב מערך של FieldDescriptors כדי לתאר מבנה/מבנה של סכימה.

nl::SerializationContext

c-struct שמכיל את כל ההקשר או המצב שדרושים לנו לצורך סריאליזציה או פעולת deserialization.

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

שילוב נתונים עם c-struct של נתונים וה-StructureSchemaDescriptor כדי לכתוב מבנה TLV על סמך הנתונים האלה.

מרחבי שמות

nl::ArgParser
nl::Ble

מרחב השמות הזה כולל את כל הממשקים ב-Weave ל-Bluetooth עם צריכת אנרגיה נמוכה (BLE), המכונים גם Bluetooth Smart.

nl::Inet
nl::NestCerts

מרחב השמות הזה כולל סמלים גלובליים לאישורי תשתית מפתחות ציבוריים (PKI) של Nest Weave.

nl::PairingCode
nl::חם
nl::Weave

ספירות

@357

 @357

358@

 @358

@359

 @359

@360

 @360

@361

 @361

SerializedFieldType

 SerializedFieldType

רשימה של סוגי TLV שאפשר לכתוב עם השדה TLV.

תכונות
SerializedFieldTypeArray

סוג המערך.

SerializedFieldTypeBoolean

סוג בוליאני.

SerializedFieldTypeByteString

סוג מחרוזת בייט.

SerializedFieldTypeFloatingPoint32

סוג צף ב-32 סיביות

SerializedFieldTypeFloatingPoint64

סוג צף ב-64 סיביות

SerializedFieldTypeInt16

סוג 16 ביט חתום.

SerializedFieldTypeInt32

סוג 32 ביט חתום.

SerializedFieldTypeInt64

חתום מסוג 64 ביט.

SerializedFieldTypeInt8

סוג 8 ביט חתום.

SerializedFieldTypeStructure

סוג מבנה בהגדרת המשתמש.

SerializedFieldTypeUInt16

סוג 16 סיביות לא חתום.

SerializedFieldTypeUInt32

סוג 32 סיביות לא חתום.

SerializedFieldTypeUInt64

סוג 64 ביט ללא חתימה.

SerializedFieldTypeUInt8

סוג 8 סיביות לא חתום.

SerializedFieldTypeUTF8String

סוג מחרוזת UTF-8.

SerializedFieldTypeBits

 SerializedFieldTypeBits

שדה Bitfield של SerializedFieldType.

SerializedFieldTypeMasks

 SerializedFieldTypeMasks

מסכות לגישה לקטעים ב-SerializedFieldType.

ערכי דף

Base64CharToValFunct

uint8_t(* Base64CharToValFunct)(uint8_t c)

Base64ValToCharFunct

char(* Base64ValToCharFunct)(uint8_t val)

MemoryAllocate

void *(* MemoryAllocate)(size_t size)

הקצאת זיכרון/מצביעים של פונקציות חופשיות.

MemoryFree

void(* MemoryFree)(void *ptr)

MemoryReallocate

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

משתנים

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

רשימה מקושרת של פונקציות פורמט שגיאות.

sErrorStr

char sErrorStr[WEAVE_CONFIG_ERROR_STR_SIZE]

מאגר נתונים זמני כדי לאחסן את מחרוזת השגיאה בפורמט.

sErrorStr

char sErrorStr[1024]

התרחיש הזה מחזיר מחרוזת C שמסתיימת ב-NULL, שמתארת את קוד הסטטוס שסופק ומשויך לפרופיל שצוין.

פרטים
פרמטרים
[in] profileId
מזהה פרופיל Weave המשויך ל- .
[in] statusCode
קוד הסטטוס ב-profileId שיש לספק עבורו מחרוזת תיאורית.
החזרות
מצביע למחרוזת C שמסתיימת ב-NULL, שמתארת את קוד הסטטוס שסופק בפרופיל שצוין.
ראו גם:
WEAVE_CONFIG_SHORT_ERROR_STR

sWeaveErrorFormatter

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

פונקציות

AdjustCalendarDate

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

בסיס64CharToVal

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
)

בסיס64Encode32

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

בסיס64Encode32

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

Base64URLCharToVal

uint8_t Base64URLCharToVal(
  uint8_t c
)

פענוח בקידוד Base64URL

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
)

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
)

התרחיש הזה מחזיר מחרוזת C שמסתיימת ב-NULL, שמתארת את השגיאה שסופקה.

פרטים
פרמטרים
[in] err
השגיאה בפורמט ובתיאור.
החזרות
מצביע למחרוזת C שמסתיימת ב-NULL, שמתארת את השגיאה שסופקה.

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
)

פונקציית עזר לאיתור המיקום של מערך השדות המבוטלים, שנמצא בסוף ה-C struct.

האיבר nullified_fields ב-struct C צריך להיות ממוקם ממש אחרי האיבר האחרון המתואר על ידי המערך FieldDescriptors. הוא לא נמצא ברשימת מתארי השדות, כי הוא אמור לשמש ככלי נסתר ליוצרים ולצרכנים של אירועים null. חבר המבנה הזה לא קיים לאירועים ללא שדות null, אבל כשיוצרים ממירים ומקבלים לא צריכה להתרחש גישה מחוץ לתחום.

פרטים
פרמטרים
[in] aStructureData
מצביע אל ה-c-struct.
[in] aSchemaDescriptor
SchemaFieldDescriptors לתיאור ה-c struct.
[out] aNullifiedFields
מצביע על כך לחבר nullified_fields ב-c struct.
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
WEAVE_ERROR_INVALID_ARGUMENT
אם המצביע לתיאור השדה הוא NULL.
WEAVE_ERROR_INCORRECT_STATE
הפורמט של מתארי השדות לא תואם לציפיות.

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
)

יוצרת מחרוזת C קטועה מסוג NULL, שמתארת את השגיאה שסופקה.

פרטים
פרמטרים
[in] buf
מאגר הנתונים הזמני שאליו תוצב מחרוזת השגיאה.
[in] bufSize
גודל מאגר הנתונים הזמני שסופק בבייטים.
[in] subsys
מחרוזת קצרה שמתארת את מערכת המשנה שממנה הגיעה השגיאה, או NULL אם מקור השגיאה לא ידוע/לא זמין. המחרוזת צריכה להיות באורך 10 תווים לכל היותר.
[in] err
השגיאה שיש לעצב.
[in] desc
מחרוזת שמתארת את הגורם לשגיאה או המשמעות שלה, או NULL אם אין מידע זמין.

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
)

פונקציית קריאה לקריאת רשומה ספציפית מ-TLV על סמך נתוני מבנה.

פרטים
פרמטרים
[in] aReader
קורא לשימוש לקריאה במבנה
[in] aStructureData
הצבעה לנתונים ב-c-structure לצורך קריאה
[in,out] aFieldPtr
FieldDescriptor כדי לתאר את השדות ואת תג ה-TLV. הפונקציה תגדיל את מצביע s.t. היא תצביע לרכיב הבא במערך FieldDescritor
[in] aType
ה-SerializedFieldType של השדה
[in] aInArray
True אם אנחנו קוראים מערך (יש להשתמש בתג אנונימי)
[in] aContext
ההקשר של העריכה בסדרה שמכיל את כל המצבים הנדרשים לפעולה.
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
other
שגיאות אחרות שמוחזרות מה-aReader.

ReadNullableDataForType

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

פונקציית קריאה שבודקת אם הנתונים הם ריקים או מבוטלים לפני קריאה מה-TLV.

פרטים
פרמטרים
[in] aReader
קורא לשימוש לקריאה במבנה
[in] aStructureData
הצבעה לנתונים ב-c-structure לצורך קריאה
[in,out] aFieldPtr
FieldDescriptor כדי לתאר את השדות ואת תג ה-TLV. הפונקציה תגדיל את מצביע ה-s.t. היא תפנה אל הרכיב הבא במערך FieldDescriptor
[in] aType
ה-SerializedFieldType של השדה
[out] aIsNullified
הגדרה זו מציינת ששדה הוא null.
[in] aContext
ההקשר של העריכה בסדרה שמכיל את כל המצבים הנדרשים לפעולה.
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
other
שגיאות TLV בזמן הכתיבה.

RegisterErrorFormatter

NL_DLL_EXPORT void RegisterErrorFormatter(
  ErrorFormatter *errFormatter
)

הוספת פונקציה חדשה של מעצב שגיאות לרשימה הגלובלית של מעצבי שגיאות.

פרטים
פרמטרים
[in] errFormatter
מבנה של ErrorFormatter שמכיל מצביע לפונקציית השגיאה החדשה. שים לב שהפונקציה תשמור על מצביע למבנה ErrorFormatter שסופק. כך הזיכרון של המבנה צריך להישאר שמור.

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
)

פונקציית כתיבה להמרה של מבנה נתונים למבנה TLV.

משתמש ב-SchemaFieldDescriptor כדי לפרש את מבנה הנתונים ולכתוב ב-TLV.

פרטים
פרמטרים
[in] aWriter
הכותב שישמש לכתיבת המבנה
[in] aStructureData
מצביע על הנתונים של c-structure כדי לכתוב אותם על סמך SchemaFieldDescriptor
[in] aFieldDescriptors
מאפייני SchemaFieldDescriptor לתיאור ה-c struct + TLV
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
other
שגיאות אחרות שמחזירות מה-aWriter.

SerializedDataToTLVWriterHelper

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

פונקציית wrapper שמקיפה את SerializedDataToTLVWriter עם הקונטיינר.

הפונקציה מפצלת גם את הפרמטר StructureSchemaPointerPair לנתוני מבנה ולמתארים להעברה.

פרטים
פרמטרים
[in] aWriter
הכותב שישמש לכתיבת המבנה
[in] aDataTag
תג לכתיבה
[in] aAppData
StructureSchemaPointerPair שמכיל מצביע למבנה הנתונים ולתיאורי השדות. void* עקב אב-טיפוס
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
other
שגיאות אחרות שמחזירות מה-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
)

פונקציית קריאה להמרת טקסט TLV ל-C-struct.

המערכת משתמשת ב-SchemaFieldDescriptor כדי לפרש את מבנה הנתונים.

הוא חייב להיות חזק גם כדי לקלוט שדות לא ידועים וגם כדי לא להיתקל בשדה צפוי.

פרטים
פרמטרים
[in] aReader
הקורא לשימוש לצורך קריאה בנתונים
[in] aStructureData
מצביעה על נתוני היעד של מבנה c שאליהם נקרא על סמך SchemaFieldDescriptor
[in] aFieldDescriptors
מאפייני SchemaFieldDescriptor לתיאור ה-c struct + TLV
[in] aContext
ההקשר של העריכה בסדרה שמכיל את כל המצבים הנדרשים לפעולה.
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
other
שגיאות אחרות שייתכן שיוחזרו מה-aReader.

TLVReaderToDeserializedDataHelper

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

פונקציית מסייע שמבצעת פעולת deserialize של רכיב נתונים אחד של רמת פירוט גבוהה (TLV).

הפונקציה מפצלת את StructureSchemaPointerPair לנתוני מבנה ולמתארים כדי להעביר אותם אל ReadDataForType.

פרטים
פרמטרים
[in] aReader
הקורא שמכיל נתונים לביצוע פעולת deserialize
[in] aDataTag
לא בשימוש כרגע
[in] aAppData
StructureSchemaPointerPair שמכיל מצביע למבנה הנתונים ולתיאורי השדות. void* עקב אב-טיפוס
[in] aContext
ההקשר של העריכה בסדרה שמכיל את כל המצבים הנדרשים לפעולה.
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
other
שגיאות אחרות שמוחזרות מה-aReader.

WriteArrayData

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

פונקציית כתיבה שכותבת מבנה מערך.

פרטים
פרמטרים
[in] aWriter
הכותב שישמש לכתיבת המבנה
[in] aStructureData
מצביע על הנתונים של c-structor כדי לכתוב אותם על סמך ה-FieldDescriptor
[in] aFieldPtr
FieldDescriptor לתיאור המערך c struct + TLV
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
other
שגיאות אחרות שמחזירות מה-aWriter.

WriteDataForType

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

פונקציית כתיבה כותבת רשומה ספציפית ל-TLV על סמך נתוני מבנה.

פרטים
פרמטרים
[in] aWriter
הכותב שישמש לכתיבת המבנה
[in] aStructureData
מצביע אל הנתונים ב-c-structure כדי לכתוב
[in,out] aFieldPtr
FieldDescriptor כדי לתאר את השדות ואת תג ה-TLV. הפונקציה תגדיל את מצביע s.t. היא תצביע לרכיב הבא במערך FieldDescritor
[in] aType
ה-SerializedFieldType של השדה
[in] aInArray
True אם אנחנו כותבים מערך (יש להשתמש בתג אנונימי)
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
other
שגיאות אחרות שמחזירות מה-aWriter.

WriteNullableDataForType

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

פונקציית כתיבה שבודקת אם הנתונים הם ריקים או null לפני כתיבה ל-TLV.

פרטים
פרמטרים
[in] aWriter
הכותב שישמש לכתיבת המבנה
[in] aStructureData
הצבעה לנתונים ב-c-structure לצורך קריאה
[in,out] aFieldPtr
FieldDescriptor כדי לתאר את השדות ואת תג ה-TLV. הפונקציה תגדיל את מצביע ה-s.t. היא תפנה אל הרכיב הבא במערך FieldDescriptor
[in] aType
ה-SerializedFieldType של השדה
[in] aIsNullified
אם הערך הזה נכון, תג ה-TLV יבוטל.
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
other
שגיאות TLV בזמן הכתיבה.

secondsToMilliseconds

uint32_t secondsToMilliseconds(
  uint32_t seconds
)