nl

Penggantian nlstatement.h khusus Weave.

Ringkasan

Enumerasi

@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
Daftar jenis TLV yang akan ditulis dengan kolom TLV.
SerializedFieldTypeBits enum
Bitfield dari SerializedFieldType.
SerializedFieldTypeMasks enum
Mask untuk mengakses bit SerializedFieldType.

Typedef

Base64CharToValFunct)(uint8_t c) typedef
uint8_t(*
Base64ValToCharFunct)(uint8_t val) typedef
char(*
MemoryAllocate)(size_t size) typedef
void *(*
Pointer fungsi bebas/alokasi memori.
MemoryFree)(void *ptr) typedef
void(*
MemoryReallocate)(void *ptr, size_t size) typedef
void *(*

Variabel

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 *
Daftar tertaut fungsi pemformat error.
sErrorStr[WEAVE_CONFIG_ERROR_STR_SIZE]
char
Buffering statis untuk menyimpan string error berformat.
sErrorStr[1024]
char
Rutinitas ini menampilkan string C yang dihentikan NULL dan dapat dibaca manusia, yang menjelaskan kode status yang diberikan yang terkait dengan profil yang ditentukan.
sWeaveErrorFormatter = { nl::Weave::FormatWeaveError, &sASN1ErrorFormatter }

Fungsi

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 *
Rutinitas ini menampilkan string C yang dihentikan NULL dan dapat dibaca manusia, yang menjelaskan error yang diberikan.
ExtractManufacturingDateFromSerialNumber(const char *serialNum, uint16_t & year, uint8_t & month, uint8_t & day)
FindNullifiedFieldsArray(void *aStructureData, const SchemaFieldDescriptor *aSchemaDescriptor, uint8_t *& aNullifiedFields)
Fungsi bantuan untuk menemukan lokasi array kolom null yang terletak di akhir struct C.
FindStatusReportStr(uint32_t inProfileId, uint16_t inStatusCode)
const char *
FirstWeekdayOfYear(uint16_t year)
uint8_t
FormatError(char *buf, uint16_t bufSize, const char *subsys, int32_t err, const char *desc)
void
Menghasilkan string C yang dihentikan NULL dan dapat dibaca manusia yang mendeskripsikan error yang disediakan.
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)
Fungsi pembaca untuk membaca entri tertentu dari TLV berdasarkan data struktur.
ReadNullableDataForType(TLVReader & aReader, void *aStructureData, const FieldDescriptor *& aFieldPtr, SerializedFieldType aType, bool & aIsNullified, SerializationContext *aContext)
Fungsi pembaca untuk memeriksa apakah data nullable/nullified sebelum membaca dari TLV.
RegisterErrorFormatter(ErrorFormatter *errFormatter)
NL_DLL_EXPORT void
Tambahkan fungsi pemformat error baru ke daftar global pemformat error.
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)
Fungsi penulis untuk mengonversi struktur data menjadi struktur TLV.
SerializedDataToTLVWriterHelper(TLVWriter & aWriter, uint8_t aDataTag, void *aAppData)
Fungsi penulis wrapper yang mengelilingi SerializedDataToTLVWriter dengan container.
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)
Fungsi pembaca untuk mengonversi TLV menjadi C-struct.
TLVReaderToDeserializedDataHelper(nl::Weave::TLV::TLVReader & aReader, uint8_t aDataTag, void *aAppData, SerializationContext *aContext)
Fungsi bantuan yang melakukan deserialisasi satu elemen data TLV.
WriteArrayData(TLVWriter & aWriter, void *aStructureData, const FieldDescriptor *aFieldPtr)
Fungsi penulis yang menulis struktur array.
WriteDataForType(TLVWriter & aWriter, void *aStructureData, const FieldDescriptor *& aFieldPtr, SerializedFieldType aType, bool aInArray)
Fungsi penulis menulis entri tertentu ke dalam TLV berdasarkan data struktur.
WriteNullableDataForType(TLVWriter & aWriter, void *aStructureData, const FieldDescriptor *& aFieldPtr, SerializedFieldType aType, bool aIsNullified)
Fungsi penulis untuk memeriksa apakah data nullable/nullified sebelum menulis ke TLV.
secondsToMilliseconds(uint32_t seconds)
uint32_t

Struct

nl::ArrayLengthAndBuffer

Helper untuk menggabungkan array dengan panjang.

nl::ErrorFormatter
nl::FieldDescriptor

Struktur yang menjelaskan kolom TLV dalam struktur skema dan menghubungkannya ke data dalam c-struct.

nl::MemoryManagement

Sebuah c-struct memori alokasi/fungsi bebas.

nl::SchemaFieldDescriptor

Wrapper di sekitar array FieldDescriptors untuk mendeskripsikan struktur/struktur skema.

nl::SerializationContext

C-struct yang berisi konteks atau status apa pun yang diperlukan untuk melakukan serialisasi atau deserialisasi.

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

Pasangan data dengan c-struct data dan StructureSchemaDescriptor untuk menulis struktur TLV berdasarkan data tersebut.

Namespace

nl::ArgParser
nl::Ble

Namespace ini mencakup semua antarmuka dalam Weave for Bluetooth Low Energy (BLE), yang juga dikenal sebagai Bluetooth Smart.

nl::Inet
nl::NestCerts

Namespace ini mencakup simbol global untuk sertifikat infrastruktur kunci publik (IKP) Nest Weave.

nl::PairingCode
nl::Hangat
nl::Weave

Enumerasi

@357

 @357

@358

 @358

@359

 @359

@360

 @360

@361

 @361

SerializedFieldType

 SerializedFieldType

Daftar jenis TLV yang akan ditulis dengan kolom TLV.

Properti
SerializedFieldTypeArray

Jenis array.

SerializedFieldTypeBoolean

Jenis Boolean.

SerializedFieldTypeByteString

Jenis string byte.

SerializedFieldTypeFloatingPoint32

Jenis float 32-bit

SerializedFieldTypeFloatingPoint64

Jenis float 64-bit

SerializedFieldTypeInt16

Jenis 16-bit yang ditandatangani.

SerializedFieldTypeInt32

Jenis 32-bit yang ditandatangani.

SerializedFieldTypeInt64

Jenis 64-bit yang ditandatangani.

SerializedFieldTypeInt8

Jenis 8-bit yang ditandatangani.

SerializedFieldTypeStructure

Jenis struktur yang ditentukan pengguna.

SerializedFieldTypeUInt16

Jenis 16-bit tanpa tanda tangan.

SerializedFieldTypeUInt32

Jenis 32-bit tanpa tanda tangan.

SerializedFieldTypeUInt64

Jenis 64-bit tanpa tanda tangan.

SerializedFieldTypeUInt8

Jenis 8-bit tanpa tanda tangan.

SerializedFieldTypeUTF8String

Jenis string UTF-8.

SerializedFieldTypeBits

 SerializedFieldTypeBits

Bitfield dari SerializedFieldType.

SerializedFieldTypeMasks

 SerializedFieldTypeMasks

Mask untuk mengakses bit SerializedFieldType.

Typedef

Base64CharToValFunct

uint8_t(* Base64CharToValFunct)(uint8_t c)

Base64ValToCharFunct

char(* Base64ValToCharFunct)(uint8_t val)

MemoryAllocate

void *(* MemoryAllocate)(size_t size)

Pointer fungsi bebas/alokasi memori.

MemoryFree

void(* MemoryFree)(void *ptr)

MemoryReallocate

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

Variabel

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

Daftar tertaut fungsi pemformat error.

sErrorStr

char sErrorStr[WEAVE_CONFIG_ERROR_STR_SIZE]

Buffering statis untuk menyimpan string error berformat.

sErrorStr

char sErrorStr[1024]

Rutinitas ini menampilkan string C yang dihentikan NULL dan dapat dibaca manusia, yang menjelaskan kode status yang diberikan yang terkait dengan profil yang ditentukan.

Detail
Parameter
[in] profileId
Pengidentifikasi profil Weave yang terkait dengan .
[in] statusCode
Kode status di profileId yang akan diberikan string deskriptif.
Hasil
Pointer ke string C yang dihentikan NULL yang menjelaskan kode status yang disediakan dalam profil yang ditetapkan.
Lihat juga:
WEAVE_CONFIG_SHORT_ERROR_STR

sWeaveErrorFormatter

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

Fungsi

AdjustCalendarDate

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

Basis64CharToVal

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
)

Basis64Dekode32

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

Basis64Dekode32

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
)

Base64URLDecode

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

Encode Base64URL

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

Basis64URLValToChar

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
)

Rutinitas ini menampilkan string C yang dihentikan NULL dan dapat dibaca manusia, yang menjelaskan error yang diberikan.

Detail
Parameter
[in] err
Kesalahan untuk memformat dan menjelaskan.
Hasil
Pointer ke string C yang dihentikan NULL yang menjelaskan error yang disediakan.

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
)

Fungsi bantuan untuk menemukan lokasi array kolom null yang terletak di akhir struct C.

Anggota nullified_fields dari struct C diharapkan berada langsung setelah anggota terakhir yang dijelaskan oleh array FieldDescriptors. ID ini tidak ada dalam daftar deskriptor kolom, karena dimaksudkan sebagai utilitas tersembunyi bagi kreator dan konsumen peristiwa nullable. Anggota struct ini tidak ada untuk peristiwa tanpa kolom nullable, tetapi dengan membuat penyetel dan pengambil, tidak boleh ada akses yang melebihi batas.

Detail
Parameter
[in] aStructureData
Pointer ke c-struct.
[in] aSchemaDescriptor
SchemaFieldDescriptors untuk mendeskripsikan struct c.
[out] aNullifiedFields
Pointer ke anggota nullified_fields dari c struct.
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
WEAVE_ERROR_INVALID_ARGUMENT
Jika pointer deskriptor kolom adalah NULL.
WEAVE_ERROR_INCORRECT_STATE
Jika format deskriptor kolom tidak sesuai dengan harapan.

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
)

Menghasilkan string C yang dihentikan NULL dan dapat dibaca manusia yang mendeskripsikan error yang disediakan.

Detail
Parameter
[in] buf
Buffer tempat string error akan ditempatkan.
[in] bufSize
Ukuran buffer yang diberikan dalam byte.
[in] subsys
String pendek yang menjelaskan subsistem yang menghasilkan error, atau NULL jika asal error tidak diketahui/tidak tersedia. String ini harus terdiri dari 10 karakter atau kurang.
[in] err
Error yang akan diformat.
[in] desc
String yang menjelaskan penyebab atau makna error, atau NULL jika informasi tersebut tidak tersedia.

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
)

Fungsi pembaca untuk membaca entri tertentu dari TLV berdasarkan data struktur.

Detail
Parameter
[in] aReader
Pembaca yang digunakan untuk membaca dalam struktur
[in] aStructureData
Pointer ke data c-structure untuk dibaca
[in,out] aFieldPtr
FieldDescriptor untuk mendeskripsikan kolom dan tag TLV. Fungsi ini akan menambah s.t. pointer akan menunjuk ke elemen berikutnya di array FieldDescritor
[in] aType
SerializedFieldType kolom
[in] aInArray
True jika kita membaca array (gunakan tag anonim)
[in] aContext
Konteks serialisasi yang berisi status apa pun yang diperlukan untuk operasi.
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
other
Error lain yang mungkin ditampilkan dari aReader.

ReadNullableDataForType

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

Fungsi pembaca untuk memeriksa apakah data nullable/nullified sebelum membaca dari TLV.

Detail
Parameter
[in] aReader
Pembaca yang digunakan untuk membaca dalam struktur
[in] aStructureData
Pointer ke data c-structure untuk dibaca
[in,out] aFieldPtr
FieldDescriptor untuk mendeskripsikan kolom dan tag TLV. Fungsi ini akan menambah s.t. pointer akan menunjuk ke elemen berikutnya dalam array FieldDescriptor.
[in] aType
SerializedFieldType kolom
[out] aIsNullified
Ditetapkan untuk menunjukkan bahwa kolom dibatalkan.
[in] aContext
Konteks serialisasi yang berisi status apa pun yang diperlukan untuk operasi.
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
other
Error TLV saat menulis.

RegisterErrorFormatter

NL_DLL_EXPORT void RegisterErrorFormatter(
  ErrorFormatter *errFormatter
)

Tambahkan fungsi pemformat error baru ke daftar global pemformat error.

Detail
Parameter
[in] errFormatter
Struktur ErrorFormatter yang berisi pointer ke fungsi error baru. Perhatikan bahwa pointer ke struktur ErrorFormatter yang disediakan akan dipertahankan oleh fungsi. Dengan demikian, memori untuk struktur harus tetap dicadangkan.

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
)

Fungsi penulis untuk mengonversi struktur data menjadi struktur TLV.

Menggunakan SchemaFieldDescriptor untuk menafsirkan struktur data dan menulis ke TLV.

Detail
Parameter
[in] aWriter
yang digunakan penulis untuk menulis struktur
[in] aStructureData
Pointer ke data c-structure yang akan ditulis berdasarkan SchemaFieldDescriptor
[in] aFieldDescriptors
SchemaFieldDescriptors untuk menjelaskan c struct + TLV
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
other
Error lain yang mungkin ditampilkan dari aWriter.

SerializedDataToTLVWriterHelper

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

Fungsi penulis wrapper yang mengelilingi SerializedDataToTLVWriter dengan container.

Selain itu, membagi StructureSchemaPointerPair menjadi data struktur dan deskriptor untuk diteruskan.

Detail
Parameter
[in] aWriter
yang digunakan penulis untuk menulis struktur
[in] aDataTag
Beri tag untuk menulis
[in] aAppData
StructureSchemaPointerPair yang berisi pointer untuk membuat struktur data dan deskriptor kolom. void* karena prototipe
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
other
Error lain yang mungkin ditampilkan dari 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
)

Fungsi pembaca untuk mengonversi TLV menjadi C-struct.

Menggunakan SchemaFieldDescriptor untuk menafsirkan struktur data.

Aplikasi harus canggih untuk menjelajahi kolom yang tidak diketahui dan tidak menemukan kolom yang diharapkan.

Detail
Parameter
[in] aReader
Pembaca yang digunakan untuk membaca data
[in] aStructureData
Pointer ke data struktur c tujuan yang akan dibaca berdasarkan SchemaFieldDescriptor
[in] aFieldDescriptors
SchemaFieldDescriptors untuk menjelaskan c struct + TLV
[in] aContext
Konteks serialisasi yang berisi status apa pun yang diperlukan untuk operasi.
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
other
Error lain yang mungkin ditampilkan dari aReader.

TLVReaderToDeserializedDataHelper

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

Fungsi bantuan yang melakukan deserialisasi satu elemen data TLV.

Fungsi ini membagi StructureSchemaPointerPair menjadi data struktur dan deskripsi untuk diteruskan ke ReadDataForType.

Detail
Parameter
[in] aReader
Pembaca yang berisi data yang akan dideserialisasi
[in] aDataTag
Tidak digunakan untuk saat ini
[in] aAppData
StructureSchemaPointerPair yang berisi pointer untuk membuat struktur data dan deskriptor kolom. void* karena prototipe
[in] aContext
Konteks serialisasi yang berisi status apa pun yang diperlukan untuk operasi.
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
other
Error lain yang mungkin ditampilkan dari aReader.

WriteArrayData

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

Fungsi penulis yang menulis struktur array.

Detail
Parameter
[in] aWriter
yang digunakan penulis untuk menulis struktur
[in] aStructureData
Pointer ke data c-structure yang akan ditulis berdasarkan FieldDescriptor
[in] aFieldPtr
FieldDescriptor untuk mendeskripsikan array c struct + TLV
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
other
Error lain yang mungkin ditampilkan dari aWriter.

WriteDataForType

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

Fungsi penulis menulis entri tertentu ke dalam TLV berdasarkan data struktur.

Detail
Parameter
[in] aWriter
yang digunakan penulis untuk menulis struktur
[in] aStructureData
Pointer ke data c-structure untuk ditulis
[in,out] aFieldPtr
FieldDescriptor untuk mendeskripsikan kolom dan tag TLV. Fungsi ini akan menambah s.t. pointer akan menunjuk ke elemen berikutnya di array FieldDescritor
[in] aType
SerializedFieldType kolom
[in] aInArray
True jika kita menulis array (gunakan tag anonim)
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
other
Error lain yang mungkin ditampilkan dari aWriter.

WriteNullableDataForType

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

Fungsi penulis untuk memeriksa apakah data nullable/nullified sebelum menulis ke TLV.

Detail
Parameter
[in] aWriter
yang digunakan penulis untuk menulis struktur
[in] aStructureData
Pointer ke data c-structure untuk dibaca
[in,out] aFieldPtr
FieldDescriptor untuk mendeskripsikan kolom dan tag TLV. Fungsi ini akan menambah s.t. pointer akan menunjuk ke elemen berikutnya dalam array FieldDescriptor.
[in] aType
SerializedFieldType kolom
[in] aIsNullified
Tag TLV akan dibatalkan jika hal ini benar.
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
other
Error TLV saat menulis.

secondsToMilliseconds

uint32_t secondsToMilliseconds(
  uint32_t seconds
)