หน้านี้ได้รับการแปลโดย Cloud Translation API

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

Typedef
`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 }`	`const ErrorFormatter`
`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 }`	`const ErrorFormatter`

ฟังก์ชัน
`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)`	`WEAVE_ERROR`
`ErrorStr(int32_t err)`	`NL_DLL_EXPORT const char *` กิจวัตรนี้จะแสดงสตริง C สิ้นสุด NULL ที่มนุษย์อ่านได้ ซึ่งอธิบายถึงข้อผิดพลาดที่ระบุ
`ExtractManufacturingDateFromSerialNumber(const char *serialNum, uint16_t & year, uint8_t & month, uint8_t & day)`	`WEAVE_ERROR`
`FindNullifiedFieldsArray(void aStructureData, const SchemaFieldDescriptor aSchemaDescriptor, uint8_t *& aNullifiedFields)`	`WEAVE_ERROR` ฟังก์ชันตัวช่วยค้นหาตำแหน่งของอาร์เรย์ฟิลด์ที่ไม่มีข้อมูลซึ่งอยู่ที่ท้ายโครงสร้าง 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` สร้างสตริง C สิ้นสุด NULL ที่มนุษย์อ่านได้เพื่ออธิบายข้อผิดพลาดที่ระบุ
`GetArrayElementSize(uint32_t & aOutSize, const FieldDescriptor *aFieldPtr, SerializedFieldType aType)`	`WEAVE_ERROR`
`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)`	`WEAVE_ERROR` ฟังก์ชันเครื่องอ่านสำหรับอ่านรายการที่เจาะจงจาก TLV โดยอิงตามข้อมูลที่มีโครงสร้าง
`ReadNullableDataForType(TLVReader & aReader, void aStructureData, const FieldDescriptor & aFieldPtr, SerializedFieldType aType, bool & aIsNullified, SerializationContext *aContext)`	`WEAVE_ERROR` ฟังก์ชันเครื่องอ่านที่จะตรวจสอบว่าข้อมูลเป็นค่าว่าง/ค่าว่างหรือไม่ก่อนที่จะอ่านจาก 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)`	`WEAVE_ERROR` ฟังก์ชันนักเขียนสำหรับการแปลงโครงสร้างข้อมูลเป็นโครงสร้าง TLV
`SerializedDataToTLVWriterHelper(TLVWriter & aWriter, uint8_t aDataTag, void *aAppData)`	`WEAVE_ERROR` ฟังก์ชันของ 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)`	`WEAVE_ERROR` ฟังก์ชันเครื่องอ่านสำหรับแปลง TLV เป็นโครงสร้าง C
`TLVReaderToDeserializedDataHelper(nl::Weave::TLV::TLVReader & aReader, uint8_t aDataTag, void aAppData, SerializationContext aContext)`	`WEAVE_ERROR` ฟังก์ชันตัวช่วยที่จะดีซีเรียลไลซ์องค์ประกอบข้อมูล TLV เดียว
`WriteArrayData(TLVWriter & aWriter, void aStructureData, const FieldDescriptor aFieldPtr)`	`WEAVE_ERROR` ฟังก์ชันนักเขียนที่เขียนโครงสร้างอาร์เรย์
`WriteDataForType(TLVWriter & aWriter, void aStructureData, const FieldDescriptor & aFieldPtr, SerializedFieldType aType, bool aInArray)`	`WEAVE_ERROR` ฟังก์ชันนักเขียนจะเขียนรายการที่เจาะจงลงใน TLV โดยอิงตามข้อมูลที่มีโครงสร้าง
`WriteNullableDataForType(TLVWriter & aWriter, void aStructureData, const FieldDescriptor & aFieldPtr, SerializedFieldType aType, bool aIsNullified)`	`WEAVE_ERROR` ฟังก์ชันนักเขียนเพื่อตรวจสอบว่าข้อมูลแสดงเป็นโมฆะ/เป็นโมฆะหรือไม่ก่อนที่จะเขียนไปยัง TLV
`secondsToMilliseconds(uint32_t seconds)`	`uint32_t`

โครงสร้าง
nl::ArrayLengthAndBuffer	ตัวช่วยสำหรับการรวมอาร์เรย์ที่มีความยาว
nl::ErrorFormatter
nl::FieldDescriptor	โครงสร้างที่อธิบายช่อง TLV ในโครงสร้างสคีมา และเชื่อมต่อกับข้อมูลในโครงสร้าง C
nl::การจัดการหน่วยความจำ	โครงสร้าง c ของฟังก์ชันการจัดสรร/การประหยัดหน่วยความจำ
nl::SchemaFieldDescriptor	ล้อมรอบอาร์เรย์ของ FieldDescriptor เพื่ออธิบายโครงสร้าง/โครงสร้างของสคีมา
nl::SerializationContext	โครงสร้าง c ที่มีบริบทหรือสถานะที่เราต้องการสำหรับการทำให้เป็นอนุกรมหรือดีซีเรียลไลซ์
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 ของข้อมูลและ StructureSchemaDescriptor เพื่อเขียนโครงสร้าง TLV โดยอิงตามข้อมูลดังกล่าว

เนมสเปซ
nl::ArgParser
nl::Ble	เนมสเปซนี้มีอินเทอร์เฟซทั้งหมดภายใน Weave สำหรับบลูทูธพลังงานต่ำ (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`	ประเภท Float 32 บิต
`SerializedFieldTypeFloatingPoint64`	ประเภท Float 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

Typedef

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 ที่มีการสิ้นสุดเป็นค่าว่าง ซึ่งอธิบายถึงรหัสสถานะที่ให้ไว้ภายในโปรไฟล์ที่ระบุ

ดูเพิ่มเติม
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
)

แผนภูมิฐาน 64 แผนภูมิ

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
)

การถอดรหัส Base64 32

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

การถอดรหัส Base64 32

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
)

การเข้ารหัส Base64 32

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

การเข้ารหัส Base64 32

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

Base64URLแผนภูมิ

uint8_t Base64URLCharToVal(
  uint8_t c
)

ถอดรหัส Base64URL

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

การเข้ารหัส Base64URL

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 ที่มีการสิ้นสุดเป็นค่าว่างซึ่งอธิบายถึงข้อผิดพลาดที่ให้ไว้

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

สมาชิก nullified_fields ของโครงสร้าง C ควรจะอยู่หลังจากสมาชิกคนสุดท้ายที่อธิบายโดยอาร์เรย์ของ FieldDescriptors โดยจะไม่ได้อยู่ในรายการข้อบ่งชี้ช่อง เนื่องจากเป็นยูทิลิตีซ่อนเร้นสำหรับครีเอเตอร์และผู้บริโภคในเหตุการณ์ที่ไม่มีข้อมูล ไม่มีสมาชิกโครงสร้างนี้สำหรับเหตุการณ์ที่ไม่มีฟิลด์ที่เว้นว่างได้ อย่างไรก็ตาม เมื่อสร้างตัวตั้งค่าและ Getters แล้ว ไม่ควรมีการเข้าถึงนอกขอบเขต

รายละเอียด

พารามิเตอร์

`[in] aStructureData`	ตัวชี้ไปยังโครงสร้าง C
`[in] aSchemaDescriptor`	SchemaFieldDescriptor เพื่ออธิบายโครงสร้าง c
`[out] aNullifiedFields`	ตัวชี้ไปยังสมาชิก nullified_fields ของโครงสร้าง c

ผลลัพธ์

`WEAVE_NO_ERROR`	สำเร็จแล้ว
`WEAVE_ERROR_INVALID_ARGUMENT`	หากเคอร์เซอร์ตัวบอกช่องเป็นค่าว่าง
`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`	สตริงสั้นๆ ที่อธิบายระบบย่อยที่ทำให้เกิดข้อผิดพลาด หรือไม่มีข้อมูลหากไม่ทราบที่มาของข้อผิดพลาด/ไม่พร้อมใช้งาน โดยสตริงนี้ควรมีอักขระไม่เกิน 10 ตัว
`[in] err`	ข้อผิดพลาดที่จะจัดรูปแบบ
`[in] desc`	สตริงที่อธิบายสาเหตุหรือความหมายของข้อผิดพลาด หรือไม่มีข้อมูลหากไม่มีข้อมูลดังกล่าว

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 ที่จะอ่าน
`[in,out] aFieldPtr`	FieldDescriptor เพื่ออธิบายช่องและแท็ก TLV ฟังก์ชันนี้จะเพิ่มค่าตัวชี้ s.t. ระบบจะชี้ไปยังองค์ประกอบถัดไปในอาร์เรย์ FieldDescritor
`[in] aType`	SerializedFieldType ของฟิลด์
`[in] aInArray`	เป็นจริงถ้าเรากำลังอ่านอาร์เรย์ (ใช้แท็กที่ไม่ระบุตัวตน)
`[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 ที่จะอ่าน
`[in,out] aFieldPtr`	FieldDescriptor เพื่ออธิบายช่องและแท็ก TLV ฟังก์ชันนี้จะเพิ่มค่าตัวชี้ S.t. ระบบจะชี้ไปยังองค์ประกอบถัดไปในอาร์เรย์ FieldDescriptor
`[in] aType`	SerializedFieldType ของฟิลด์
`[out] aIsNullified`	ตั้งค่าเพื่อระบุว่าฟิลด์เป็นโมฆะ
`[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 + 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 ที่มีตัวชี้ไปยังข้อมูลที่มีโครงสร้างและข้อบ่งชี้ช่อง เป็นโมฆะ* เนื่องจากต้นแบบ

ผลลัพธ์

`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

ใช้ SchemaFieldDescriptor เพื่อตีความโครงสร้างข้อมูล

ซึ่งต้องมีประสิทธิภาพทั้งในการเข้ารหัสฟิลด์ที่ไม่รู้จักและป้องกันฟิลด์ที่ต้องการ

รายละเอียด

พารามิเตอร์

`[in] aReader`	เครื่องอ่านที่ใช้สำหรับอ่านข้อมูล
`[in] aStructureData`	ตัวชี้ไปยังข้อมูล c-structure ปลายทางที่เราจะอ่านโดยอิงตาม SchemaFieldDescriptor
`[in] aFieldDescriptors`	SchemaFieldDescriptor เพื่ออธิบายโครงสร้าง c + TLV
`[in] aContext`	บริบทการทำให้เป็นอนุกรมซึ่งมีสถานะที่จำเป็นสำหรับการดำเนินการ

ผลลัพธ์

`WEAVE_NO_ERROR`	สำเร็จแล้ว
`other`	ข้อผิดพลาดอื่นๆ ที่อาจส่งคืนจาก aReader

TLVReaderToDeserializedDataHelper

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

ฟังก์ชันตัวช่วยที่จะดีซีเรียลไลซ์องค์ประกอบข้อมูล TLV เดียว

ฟังก์ชันนี้จะแยก StructureSchemaPointerPair เป็นข้อมูลที่มีโครงสร้างและข้อบ่งชี้ที่จะส่งผ่านไปยัง ReadDataForType

รายละเอียด

พารามิเตอร์

`[in] aReader`	เครื่องอ่านที่มีข้อมูลที่จะดีซีเรียลไลซ์
`[in] aDataTag`	ไม่ได้ใช้งานในตอนนี้
`[in] aAppData`	StructureSchemaPointerPair ที่มีตัวชี้ไปยังข้อมูลที่มีโครงสร้างและข้อบ่งชี้ช่อง เป็นโมฆะ* เนื่องจากต้นแบบ
`[in] aContext`	บริบทการทำให้เป็นอนุกรมซึ่งมีสถานะที่จำเป็นสำหรับการดำเนินการ

ผลลัพธ์

`WEAVE_NO_ERROR`	สำเร็จแล้ว
`other`	ข้อผิดพลาดอื่นๆ ที่อาจส่งคืนจาก aReader

WriteArrayData

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

ฟังก์ชันนักเขียนที่เขียนโครงสร้างอาร์เรย์

รายละเอียด

พารามิเตอร์

`[in] aWriter`	ผู้เขียนที่จะใช้เขียนโครงสร้าง
`[in] aStructureData`	ตัวชี้ไปยังข้อมูล C-structure ที่จะเขียนตาม 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 ที่จะเขียน
`[in,out] aFieldPtr`	FieldDescriptor เพื่ออธิบายช่องและแท็ก TLV ฟังก์ชันนี้จะเพิ่มค่าตัวชี้ S.t. ระบบจะชี้ไปยังองค์ประกอบถัดไปในอาร์เรย์ FieldDescritor
`[in] aType`	SerializedFieldType ของฟิลด์
`[in] aInArray`	เป็นจริงถ้าเรากำลังเขียนอาร์เรย์ (ใช้แท็กที่ไม่ระบุตัวตน)

ผลลัพธ์

`WEAVE_NO_ERROR`	สำเร็จแล้ว
`other`	ข้อผิดพลาดอื่นๆ ที่อาจส่งคืนจาก aWriter

WriteNullableDataForType

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

ฟังก์ชันนักเขียนเพื่อตรวจสอบว่าข้อมูลเป็นค่าว่าง/เป็นโมฆะหรือไม่ก่อนที่จะเขียนไปยัง TLV

รายละเอียด

พารามิเตอร์

`[in] aWriter`	ผู้เขียนที่จะใช้เขียนโครงสร้าง
`[in] aStructureData`	ตัวชี้ไปยังข้อมูลโครงสร้าง C ที่จะอ่าน
`[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
)

nl

สรุป

การแจงนับ

Typedef

ตัวแปร

ฟังก์ชัน

โครงสร้าง

เนมสเปซ

การแจงนับ

@357

@358

@359

@360

@361

SerializedFieldType

SerializedFieldTypeBits

SerializedFieldTypeMasks

Typedef

Base64CharToValFunct

Base64ValToCharFunct

MemoryAllocate

MemoryFree

MemoryReallocate

ตัวแปร

sASN1ErrorFormatter

sElementSize

sErrorFormatterList

sErrorStr

sErrorStr

sWeaveErrorFormatter

ฟังก์ชัน

AdjustCalendarDate

แผนภูมิฐาน 64 แผนภูมิ

Base64Decode

Base64Decode

การถอดรหัส Base64 32

การถอดรหัส Base64 32

Base64Encode

Base64Encode

การเข้ารหัส Base64 32

การเข้ารหัส Base64 32

Base64URLแผนภูมิ

ถอดรหัส Base64URL

การเข้ารหัส Base64URL

Base64URLValToChar

Base64ValToChar

CalendarDateToDaysSinceEpoch

CalendarDateToOrdinalDate

CalendarTimeToSecondsSinceEpoch

ClearFlag

DateToManufacturingWeek

DaysInMonth

DaysSinceEpochToCalendarDate

DaysToMarch1

DeallocateDeserializedStructure

ErrorStr

ExtractManufacturingDateFromSerialNumber

FindNullifiedFieldsArray

FindStatusReportStr

FirstWeekdayOfYear

FormatError

GetArrayElementSize

GetFlag

IsBase34NoIOChar

IsLeapYear

IsValidFieldType

IsValidSerialNumber

LogEvent

LogEvent

ManufacturingWeekToDate

MarchBasedDayOfYearToMonth

MarchBasedMonthToDayOfYear

NullifyAllEventFields

OrdinalDateToCalendarDate

ReadDataForType

ReadNullableDataForType

RegisterErrorFormatter

SecondsSinceEpochToCalendarTime

SerializedDataToTLVWriter

SerializedDataToTLVWriterHelper