nl::
Namespace ini mencakup semua antarmuka dalam Weave untuk profil Weave Data Management (WDM) yang saat ini didukung untuk penggunaan produksi.
Ringkasan
Typedef |
|
|---|---|
CommandFlags
|
typedef |
DataVersion
|
typedefuint64_t
|
EventProcessor
|
typedefvoid *
|
EventWriterFunct)(nl::Weave::TLV::TLVWriter &ioWriter, uint8_t inDataTag, void *appData)
|
typedef Fungsi yang menyediakan elemen eventData untuk subsistem logging peristiwa. |
FetchExternalEventsFunct)(EventLoadOutContext *aContext)
|
typedef Prototipe fungsi untuk callback platform yang mengambil data peristiwa. |
GenericTraitSinkCatalog
|
typedef |
GenericTraitSourceCatalog
|
typedef |
ImportanceType
|
typedef Pentingnya entri log. |
IteratorCallback)(void *aTraitInstance, TraitDataHandle aHandle, void *aContext)
|
typedefvoid(*
Iterator penanganan Trait. |
LoggingBufferHandler)(void *inAppState, PacketBuffer *inBuffer)
|
typedef |
NotifyExternalEventsDeliveredFunct)(ExternalEvents *inEv, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID)
|
typedefvoid(*
Prototipe fungsi untuk callback yang dipanggil saat peristiwa eksternal dikirimkan ke pelanggan jarak jauh. |
NotifyExternalEventsEvictedFunct)(ExternalEvents *inEv)
|
typedefvoid(*
Prototipe fungsi untuk callback yang dipanggil saat peristiwa eksternal dikeluarkan dari buffer. |
PropertyDictionaryKey
|
typedefuint16_t
|
PropertyPathHandle
|
typedefuint32_t
PropertyPathHandle adalah hash numerik 32-bit unik dari jalur WDM yang terkait dengan root instance trait. |
PropertySchemaHandle
|
typedefuint16_t
|
SchemaVersion
|
typedefuint16_t
|
SingleResourceSinkTraitCatalog
|
typedef |
SingleResourceSourceTraitCatalog
|
typedef |
TimestampType
|
typedef Validitas dan jenis stempel waktu disertakan dalam EventOptions. |
TraitDataHandle
|
typedefuint16_t
|
duration_t
|
nl::Weave::Profiles::DataManagement_Current::duration_tuint32_t
Jenis yang digunakan untuk mendeskripsikan durasi, dalam milidetik. |
event_id_t
|
nl::Weave::Profiles::DataManagement_Current::event_id_tuint32_t
Jenis ID peristiwa. |
timestamp_t
|
nl::Weave::Profiles::DataManagement_Current::timestamp_tuint32_t
Jenis yang digunakan untuk mendeskripsikan stempel waktu dalam milidetik. |
utc_timestamp_t
|
nl::Weave::Profiles::DataManagement_Current::utc_timestamp_tuint64_t
Jenis yang digunakan untuk mendeskripsikan stempel waktu UTC dalam milidetik. |
Variabel |
|
|---|---|
sInstance
|
|
sLogFileName = "topazlog"[]
|
char
|
Fungsi |
|
|---|---|
BdxErrorHandler(nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer, WEAVE_ERROR aErrorCode)
|
void
|
BdxGetBlockHandler(nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer, uint64_t *aLength, uint8_t **aDataBlock, bool *aIsLastBlock)
|
void
|
BdxRejectHandler(nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer, nl::Weave::Profiles::StatusReporting::StatusReport *aReport)
|
void
|
BdxSendAcceptHandler(nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer, nl::Weave::Profiles::BulkDataTransfer::SendAccept *aSendAcceptMsg)
|
|
BdxXferDoneHandler(nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer)
|
void
|
BdxXferErrorHandler(nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer, nl::Weave::Profiles::StatusReporting::StatusReport *aXferError)
|
void
|
CreatePropertyPathHandle(PropertySchemaHandle aPropertyPathSchemaId, PropertyDictionaryKey aPropertyPathDictionaryKey)
|
|
EventWriterTLVCopy(TLVWriter & ioWriter, uint8_t inDataTag, void *appData)
|
Fungsi bantuan yang menerjemahkan elemen eventdata yang sudah diserialisasi ke dalam buffer peristiwa.
|
GetPropertyDictionaryKey(PropertyPathHandle aHandle)
|
PropertyDictionaryKey
|
GetPropertySchemaHandle(PropertyPathHandle aHandle)
|
PropertySchemaHandle
|
IsNullPropertyPathHandle(PropertyPathHandle aHandle)
|
bool
|
IsRootPropertyPathHandle(PropertyPathHandle aHandle)
|
bool
|
IsVersionNewer(const DataVersion & aVersion, const DataVersion & aReference)
|
bool
Ini adalah implementasi algoritma yang dioptimalkan untuk membandingkan versi.
|
IsVersionNewerOrEqual(const DataVersion & aVersion, const DataVersion & aReference)
|
bool
|
Locate(TraitDataHandle aTraitDataHandle, const TraitCatalogBase< TraitDataSink > *aDataSinkCatalog)
|
Fungsi utilitas yang menemukan TraitUpdatableDataSink dalam katalog TraitDataSink.
|
LogEvent(const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData)
|
Catat peristiwa dari formulir yang telah diserialisasi.
|
LogEvent(const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData, const EventOptions *inOptions)
|
Catat peristiwa dari formulir yang telah diserialisasi, dengan opsi tambahan.
|
LogEvent(const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData)
|
Catat peristiwa melalui callback.
|
LogEvent(const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData, const EventOptions *inOptions)
|
Catat peristiwa melalui callback, dengan opsi.
|
LogFreeform(ImportanceType inImportance, const char *inFormat, ...)
|
LogFreeform memancarkan string bentuk bebas ke aliran peristiwa default.
|
LookForElementWithTag(const nl::Weave::TLV::TLVReader & aSrcReader, const uint64_t aTagInApiForm, nl::Weave::TLV::TLVReader *apDstReader)
|
|
PlainTextWriter(TLVWriter & ioWriter, uint8_t inDataTag, void *appData)
|
Fungsi bantuan untuk memunculkan teks bentuk bebas sebagai peristiwa debug.
|
PlainTextWriter(::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData)
|
Fungsi bantuan untuk memunculkan teks bentuk bebas sebagai peristiwa debug.
|
operator!=(const ResourceIdentifier & lhs, const ResourceIdentifier & rhs)
|
bool
|
operator==(const ResourceIdentifier & lhs, const ResourceIdentifier & rhs)
|
bool
|
Serikat |
|
|---|---|
|
nl:: |
Gabungan yang menyediakan sistem set aplikasi atau stempel waktu UTC. |
Enumerasi
@100
@100
Tag untuk kNestDebug_StringLogEntryEvent.
| Properti | |
|---|---|
kTag_Message
|
String yang berisi pesan debug sebenarnya. |
kTag_Region
|
Elemen 32-bit yang tidak ditandatangani menunjukkan region log, yaitu modul yang terkait dengan pesan log. |
@101
@101
Tag untuk kNestDebug_TokenizedLogEntryEvent.
| Properti | |
|---|---|
kTag_Args
|
Array argumen yang akan dikirim bersama pesan token. |
kTag_Token
|
Nilai tanpa tanda tangan 32-bit yang sesuai dengan token. |
@102
@102
Tag untuk mempertahankan peristiwa.
@104
@104
Jenis pesan profil WDM.
Nilai-nilai ini disebut dalam spesifikasi manajemen data.
@105
@105
Kode status khusus WDM.
@147
@147
@95
@95
Tag Setelan Logging.
| Properti | |
|---|---|
kTag_CurrentImportance
|
Tingkat kepentingan logging saat ini, nilainya adalah jenis ImportanceType. |
kTag_ImportanceExpiration
|
Waktu, dalam detik UTC saat setelan logging yang ditingkatkan saat ini kembali ke nilai default. |
kTag_LoggingDestination
|
URL yang menunjukkan tujuan upload log. |
kTag_MaximumLogUploadInterval
|
Durasi maksimum, dalam detik, antara upaya upload log yang dipicu otomatis. |
kTag_MinimumLogUploadInterval
|
Durasi minimal, dalam detik, antara upaya upload log yang dipicu otomatis. |
kTag_TraitLoggingImportance
|
Array opsional yang secara selektif memetakan profil yang dipilih ke tingkat logging yang lebih tinggi. Setiap elemen dalam array mengambil bentuk (profil,jalur,loggingpenting) untuk meningkatkan logging secara selektif dari subset sistem. Prioritas logging profil yang ditingkatkan hanya akan penting jika prioritas logging melebihi prioritas currentImportance dan tunduk pada waktu habis masa berlaku yang sama dengan currentImportance. |
@96
@96
Tag untuk kemampuan logging.
| Properti | |
|---|---|
kTag_LogBufferingCapacity
|
Bilangan bulat 32-bit tanpa tanda tangan yang menjelaskan kapasitas buffering log dalam kB. |
kTag_LoggingVolume
|
Bilangan bulat 32-bit tanpa tanda tangan yang menjelaskan volume logging yang diharapkan dalam kB/hari. |
kTag_SupportedLogTransports
|
Array mekanisme transpor log yang didukung. |
kTag_SupportsNonVolatileStorage
|
Boolean yang menunjukkan apakah perangkat mendukung penyimpanan log nonvolatil. |
kTag_SupportsPerTraitVerbosity
|
Boolean yang menunjukkan apakah perangkat mendukung setelan panjang per karakteristik. |
kTag_SupportsStreaming
|
Boolean yang menunjukkan apakah perangkat mendukung log streaming. |
@97
@97
Tag untuk metadata peristiwa.
Untuk semantik lengkap nilai tag, lihat Spesifikasi Desain Peristiwa.
| Properti | |
|---|---|
kTag_EventData
|
Opsional. Data peristiwa itu sendiri. Jika kosong, defaultnya adalah struktur kosong. |
kTag_EventDeltaSystemTime
|
Tag internal WDM, perbedaan waktu dari peristiwa sebelumnya dalam encoding. |
kTag_EventDeltaUTCTime
|
Tag internal WDM, perbedaan waktu dari peristiwa sebelumnya dalam encoding. |
kTag_EventID
|
Nomor urut peristiwa, dinyatakan sebagai kuantitas 64-bit yang tidak ditandatangani. Harus berurutan, lompatan dalam urutan menunjukkan celah peristiwa. |
kTag_EventImportance
|
Pentingnya peristiwa. |
kTag_EventResourceID
|
Opsional. Nilainya adalah ID resource yang terkait dengan peristiwa. Jika dihilangkan, nilainya sama dengan nilai kTag_EventSource |
kTag_EventSource
|
NodeID perangkat yang menghasilkan peristiwa. |
kTag_EventSystemTimestamp
|
Opsional. Stempel waktu sistem untuk peristiwa dalam milidetik. |
kTag_EventTraitInstanceID
|
Opsional, instance fitur yang menghasilkan peristiwa. |
kTag_EventTraitProfileID
|
Wajib. Bilangan bulat 32-bit tanpa tanda tangan yang sama dengan ProfileID karakteristik. |
kTag_EventType
|
Wajib. Bilangan bulat 16-bit tanpa tanda yang sama dengan wdl.event.id untuk jenis peristiwa ini. |
kTag_EventUTCTimestamp
|
Opsional. Stempel waktu UTC peristiwa dalam milidetik. |
kTag_ExternalEventStructure
|
Tag internal untuk peristiwa eksternal. Tidak pernah ditransmisikan melalui kabel, tidak boleh digunakan di luar library Weave. |
kTag_RelatedEventID
|
Opsional. ID Peristiwa yang terkait dengan peristiwa ini. Jika dihilangkan, nilainya sama dengan nilai kTag_EventID. |
kTag_RelatedEventImportance
|
Opsional. Pentingnya peristiwa terkait. Jika dihilangkan, nilainya sama dengan nilai kTag_EventImportance. |
@98
@98
Definisi profil untuk fitur debug.
@99
@99
Jenis peristiwa untuk karakteristik Nest Debug.
| Properti | |
|---|---|
kNestDebug_StringLogEntryEvent
|
Peristiwa untuk pesan debug string bentuk bebas. |
kNestDebug_TokenizedHeaderEntryEvent
|
Peristiwa untuk menyampaikan informasi header berupa token. |
kNestDebug_TokenizedLogEntryEvent
|
Peristiwa untuk pesan debug dengan token. |
CommandFlags
CommandFlags
| Properti | |
|---|---|
kCommandFlag_ActionTimeValid
|
Tetapkan kapan waktu tindakan valid. |
kCommandFlag_ExpiryTimeValid
|
Tetapkan kapan masa berlaku valid. |
kCommandFlag_InitiationTimeValid
|
Tetapkan kapan waktu init valid. |
kCommandFlag_IsOneWay
|
Menetapkan perintah satu arah. |
kCommandFlag_MustBeVersionValid
|
Tetapkan kapan kolom versi valid. |
ImportanceType
ImportanceType
Pentingnya entri log.
Tingkat kepentingan digunakan sebagai cara untuk memfilter peristiwa sebelum benar-benar dikeluarkan ke dalam log. Setelah peristiwa tersebut ada di log, kami tidak membuat ketentuan lebih lanjut untuk menghapusnya dari log. Tingkat kepentingan berfungsi untuk memprioritaskan penyimpanan peristiwa. Jika peristiwa yang sangat penting ditambahkan ke buffer penuh, peristiwa akan dihapus sesuai urutan kepentingannya (dan usia) untuk mengakomodasinya. Dengan demikian, tingkat kepentingan hanya memiliki nilai relatif. Jika sistem hanya menggunakan satu tingkat kepentingan, peristiwa hanya akan dihapus sesuai urutan usia, seperti buffer ring.
| Properti | |
|---|---|
Debug
|
Tingkat kepentingan debug menunjukkan entri log yang diperlukan oleh developer sistem dan terutama digunakan dalam tahap pengembangan. Log tingkat kepentingan debug tidak diperhitungkan dalam anggaran bandwidth atau daya perangkat terbatas; akibatnya, harus digunakan hanya dalam rentang waktu yang terbatas dalam sistem produksi. |
Info
|
Tingkat kepentingan info menunjukkan entri log yang memberikan insight dan diagnostik tambahan ke dalam sistem yang berjalan. Level logging info dapat digunakan selama jangka waktu yang lebih lama dalam sistem produksi, atau dapat digunakan sebagai level log default dalam uji coba lapangan. Pada perangkat terbatas, entri yang dicatat dalam log dengan tingkat Info harus diperhitungkan dalam anggaran memori dan bandwidth, tetapi tidak dalam anggaran daya. |
Production
|
Tingkat kepentingan produksi menunjukkan entri log yang digunakan dalam pemantauan dan pemeliharaan berkelanjutan ekosistem Nest. Pada perangkat terbatas, entri yang dicatat dalam log dengan tingkat kepentingan Produksi harus diperhitungkan dalam anggaran daya dan memori, karena entri tersebut diharapkan selalu dicatat dalam log dan dialihkan dari perangkat. |
ProductionCritical
|
Tingkat kepentingan Penting Produksi menunjukkan peristiwa yang kehilangannya akan secara langsung berdampak pada fitur yang ditampilkan kepada pelanggan. Aplikasi dapat menggunakan hilangnya peristiwa Penting Produksi untuk menunjukkan kegagalan sistem. Pada perangkat terbatas, entri yang dicatat dalam log dengan tingkat kepentingan Penting Produksi harus diperhitungkan dalam anggaran daya dan memori, karena entri tersebut diharapkan selalu dicatat dalam log dan dialihkan dari perangkat. |
LoggingManagementStates
LoggingManagementStates
| Properti | |
|---|---|
kLoggingManagementState_Holdoff
|
Pemindahan log telah selesai; kita tidak memulai ulang log sampai penangguhan berakhir. |
kLoggingManagementState_Idle
|
Tidak ada pengurangan beban log yang sedang berlangsung, pengurangan beban log dapat dimulai tanpa batasan apa pun. |
kLoggingManagementState_InProgress
|
Pemindahan log sedang berlangsung. |
kLoggingManagementState_Shutdown
|
Tidak mampu melakukan operasi logging apa pun. |
Typedef
CommandFlags
enum nl::Weave::Profiles::DataManagement_Current::CommandFlags CommandFlags
DataVersion
uint64_t DataVersion
EventProcessor
void * EventProcessor
EventWriterFunct
WEAVE_ERROR(* EventWriterFunct)(nl::Weave::TLV::TLVWriter &ioWriter, uint8_t inDataTag, void *appData)
Fungsi yang menyediakan elemen eventData untuk subsistem logging peristiwa.
Fungsi jenis ini diharapkan menyediakan elemen eventData untuk subsistem logging peristiwa. Fungsi jenis ini dipanggil setelah subsistem peristiwa membuat semua metadata peristiwa yang diperlukan. Fungsi ini dipanggil dengan objek nl::Weave::TLV::TLVWriter yang akan menghasilkan satu elemen TLV yang diberi tag kTag_EventData; nilai elemen tersebut HARUS berupa struktur yang berisi data peristiwa. Data peristiwa itu sendiri harus disusun menggunakan tag konteks.
| Detail | |||||||
|---|---|---|---|---|---|---|---|
| Parameter |
|
||||||
| Nilai yang Ditampilkan |
|
||||||
PlainTextWriter
EventWriterTLVCopy
FetchExternalEventsFunct
WEAVE_ERROR(* FetchExternalEventsFunct)(EventLoadOutContext *aContext)
Prototipe fungsi untuk callback platform yang mengambil data peristiwa.
Serupa dengan FetchEventsSejak, fungsi pengambilan ini menampilkan semua peristiwa dari EventLoadOutContext.mStartingEventID melalui ExternalEvents.mLastEventID.
Pointer konteks adalah jenis FetchExternalEventsContext. Ini mencakup EventLoadOutContext, dengan beberapa variabel helper untuk format TLV. Panggilan ini juga menyertakan pointer ke struct ExternalEvents yang dibuat saat pendaftaran callback. Ini menentukan rentang ID peristiwa untuk callback.
Saat kembali dari fungsi, EventLoadOutContext.mCurrentEventID harus mencerminkan ID peristiwa pertama yang belum berhasil ditulis ke buffer TLV. Platform harus menulis header dan data peristiwa ke penulis TLV dalam format yang benar, yang ditentukan oleh protokol EventLogging. Platform juga harus menjaga keunikan peristiwa dan stempel waktu.
Semua error TLV harus disebarkan ke tingkat yang lebih tinggi. Misalnya, kehabisan ruang di buffer akan memicu pesan terkirim, diikuti oleh panggilan lain ke callback dengan ID peristiwa mana pun yang tersisa.
| Detail | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Nilai yang Ditampilkan |
|
||||||||
GenericTraitSinkCatalog
GenericTraitCatalogImpl< TraitDataSink > GenericTraitSinkCatalog
GenericTraitSourceCatalog
GenericTraitCatalogImpl< TraitDataSource > GenericTraitSourceCatalog
ImportanceType
enum nl::Weave::Profiles::DataManagement_Current::ImportanceType ImportanceType
Pentingnya entri log.
Tingkat kepentingan digunakan sebagai cara untuk memfilter peristiwa sebelum benar-benar dikeluarkan ke dalam log. Setelah peristiwa tersebut ada di log, kami tidak membuat ketentuan lebih lanjut untuk menghapusnya dari log. Tingkat kepentingan berfungsi untuk memprioritaskan penyimpanan peristiwa. Jika peristiwa yang sangat penting ditambahkan ke buffer penuh, peristiwa akan dihapus sesuai urutan kepentingannya (dan usia) untuk mengakomodasinya. Dengan demikian, tingkat kepentingan hanya memiliki nilai relatif. Jika sistem hanya menggunakan satu tingkat kepentingan, peristiwa hanya akan dihapus sesuai urutan usia, seperti buffer ring.
IteratorCallback
void(* IteratorCallback)(void *aTraitInstance, TraitDataHandle aHandle, void *aContext)
Iterator penanganan Trait.
LoggingBufferHandler
WEAVE_ERROR(* LoggingBufferHandler)(void *inAppState, PacketBuffer *inBuffer)
NotifyExternalEventsDeliveredFunct
void(* NotifyExternalEventsDeliveredFunct)(ExternalEvents *inEv, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID)
Prototipe fungsi untuk callback yang dipanggil saat peristiwa eksternal dikirimkan ke pelanggan jarak jauh.
Saat peristiwa eksternal dikirimkan ke pelanggan jarak jauh, mesin akan memberikan notifikasi kepada penyedia peristiwa eksternal. Callback berisi peristiwa ID terakhir yang dikirim, dan ID pelanggan yang menerima peristiwa tersebut.
| Detail | |||||||
|---|---|---|---|---|---|---|---|
| Parameter |
|
||||||
NotifyExternalEventsEvictedFunct
void(* NotifyExternalEventsEvictedFunct)(ExternalEvents *inEv)
Prototipe fungsi untuk callback yang dipanggil saat peristiwa eksternal dikeluarkan dari buffer.
Saat objek peristiwa eksternal dikeluarkan dari buffer pesan keluar, mesin akan memberikan notifikasi kepada penyedia peristiwa eksternal. Callback berisi peristiwa eksternal yang akan dikeluarkan.
| Detail | |||
|---|---|---|---|
| Parameter |
|
||
PropertyDictionaryKey
uint16_t PropertyDictionaryKey
PropertyPathHandle
uint32_t PropertyPathHandle
PropertyPathHandle adalah hash numerik 32-bit unik dari jalur WDM yang terkait dengan root instance trait.
Ada dua bagian di dalamnya:
- Angka 16-bit yang lebih rendah yang memetakan ke bagian statis skema.
- Di mana 16-bit bawah mengacu pada jalur dalam elemen kamus, ada angka 16-bit atas yang mewakili kunci kamus yang terkait dengan elemen tersebut. Jika 16-bit bawah mengacu pada elemen non dictionary, maka 16-bit atas harus 0.
Beberapa karakteristik:
- Setiap karakteristik memiliki ruang penanganan jalur propertinya sendiri.
- Setiap jalur sub-jalur WDM yang unik akan memiliki PropertyPathHandle yang juga unik.
- PropertyPathHandles dihasilkan secara otomatis (dilakukan secara manual untuk saat ini) oleh compiler trait dari IDL dan direpresentasikan sebagai daftar enumeran dalam file header trait yang sesuai.
- Dengan konstruksi ini, logika aplikasi tidak perlu menangani jalur WDM secara langsung. Sebaliknya, interaksi mereka dengan WDM dilakukan secara eksklusif melalui nama sebutan channel ini.
- Ada dua nilai yang dicadangkan untuk tuas jalur yang memiliki arti tertentu:
- 0 menunjukkan 'NULL' akun
- 1 menunjukkan handle yang mengarah ke root instance karakteristik.
PropertySchemaHandle
uint16_t PropertySchemaHandle
SchemaVersion
uint16_t SchemaVersion
SingleResourceSinkTraitCatalog
SingleResourceTraitCatalog< TraitDataSink > SingleResourceSinkTraitCatalog
SingleResourceSourceTraitCatalog
SingleResourceTraitCatalog< TraitDataSource > SingleResourceSourceTraitCatalog
TimestampType
enum nl::Weave::Profiles::DataManagement_Current::TimestampType TimestampType
Validitas dan jenis stempel waktu disertakan dalam EventOptions.
TraitDataHandle
uint16_t TraitDataHandle
duration_t
uint32_t duration_t
Jenis yang digunakan untuk mendeskripsikan durasi, dalam milidetik.
event_id_t
uint32_t event_id_t
Jenis ID peristiwa.
timestamp_t
uint32_t timestamp_t
Jenis yang digunakan untuk mendeskripsikan stempel waktu dalam milidetik.
utc_timestamp_t
uint64_t utc_timestamp_t
Jenis yang digunakan untuk mendeskripsikan stempel waktu UTC dalam milidetik.
Variabel
sInstance
LoggingManagement sInstance
sLogFileName
char sLogFileName[] = "topazlog"
Fungsi
BdxErrorHandler
void BdxErrorHandler( nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer, WEAVE_ERROR aErrorCode )
BdxGetBlockHandler
void BdxGetBlockHandler( nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer, uint64_t *aLength, uint8_t **aDataBlock, bool *aIsLastBlock )
BdxRejectHandler
void BdxRejectHandler( nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer, nl::Weave::Profiles::StatusReporting::StatusReport *aReport )
BdxSendAcceptHandler
WEAVE_ERROR BdxSendAcceptHandler( nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer, nl::Weave::Profiles::BulkDataTransfer::SendAccept *aSendAcceptMsg )
BdxXferDoneHandler
void BdxXferDoneHandler( nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer )
BdxXferErrorHandler
void BdxXferErrorHandler( nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer, nl::Weave::Profiles::StatusReporting::StatusReport *aXferError )
CreatePropertyPathHandle
PropertyPathHandle CreatePropertyPathHandle( PropertySchemaHandle aPropertyPathSchemaId, PropertyDictionaryKey aPropertyPathDictionaryKey )
EventWriterTLVCopy
WEAVE_ERROR EventWriterTLVCopy( TLVWriter & ioWriter, uint8_t inDataTag, void *appData )
Fungsi bantuan yang menerjemahkan elemen eventdata yang sudah diserialisasi ke dalam buffer peristiwa.
| Detail | |||||||
|---|---|---|---|---|---|---|---|
| Parameter |
|
||||||
| Nilai yang Ditampilkan |
|
||||||
GetPropertyDictionaryKey
PropertyDictionaryKey GetPropertyDictionaryKey( PropertyPathHandle aHandle )
GetPropertySchemaHandle
PropertySchemaHandle GetPropertySchemaHandle( PropertyPathHandle aHandle )
IsNullPropertyPathHandle
bool IsNullPropertyPathHandle( PropertyPathHandle aHandle )
IsRootPropertyPathHandle
bool IsRootPropertyPathHandle( PropertyPathHandle aHandle )
IsVersionNewer
bool IsVersionNewer( const DataVersion & aVersion, const DataVersion & aReference )
Ini adalah implementasi algoritma yang dioptimalkan untuk membandingkan versi.
Di sisi klien, versi yang diterima dari layanan selalu merupakan versi terbaru.
IsVersionNewerOrEqual
bool IsVersionNewerOrEqual( const DataVersion & aVersion, const DataVersion & aReference )
Temukan
TraitUpdatableDataSink * Locate( TraitDataHandle aTraitDataHandle, const TraitCatalogBase< TraitDataSink > *aDataSinkCatalog )
Fungsi utilitas yang menemukan TraitUpdatableDataSink dalam katalog TraitDataSink.
| Detail | |||||
|---|---|---|---|---|---|
| Parameter |
|
||||
| Hasil |
Pointer ke TraitUpdatableDataSink; NULL jika handle tidak ada atau mengarah ke TraitDataSink yang tidak dapat diperbarui.
|
||||
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData )
Catat peristiwa dari formulir yang telah diserialisasi.
Fungsi ini mencatat peristiwa yang direpresentasikan sebagai nl::Weave::TLV::TLVReader. Ini menyiratkan bahwa representasi data peristiwa sudah diserialisasi dalam penyimpanan yang mendasari nl::Weave::TLV::TLVReader. Elemen nl::Weave::TLV::TLVReader diharapkan berisi setidaknya satu elemen data, elemen tersebut harus berupa struktur. Elemen pertama yang dibacakan dari pembaca diperlakukan sebagai data peristiwa dan disimpan di log peristiwa. Data peristiwa HARUS berisi tag konteks yang akan ditafsirkan dalam skema yang diidentifikasi oleh inProfileID dan inEventType. Tag elemen pertama akan diabaikan; sistem logging peristiwa akan menggantinya dengan tag eventData.
Peristiwa ini akan dicatat jika inImportance melebihi batas logging yang ditentukan di LoggingConfiguration. Jika nilai penting peristiwa tidak memenuhi nilai minimum saat ini, peristiwa tersebut akan dihapus dan fungsi akan menampilkan 0 sebagai ID peristiwa yang dihasilkan.
Varian pemanggilan ini secara implisit menentukan semua opsi peristiwa default:
- peristiwa diberi stempel waktu dengan waktu saat ini pada titik panggilan,
- peristiwa ditandai sebagai berkaitan dengan perangkat yang melakukan panggilan,
- peristiwa itu berdiri sendiri, tidak terkait dengan peristiwa lain,
- peristiwa ditandai sebagai tidak mendesak,
| Detail | |||||
|---|---|---|---|---|---|
| Parameter |
|
||||
| Hasil |
event_id_t ID peristiwa jika peristiwa ditulis ke log, 0 jika tidak.
|
||||
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData, const EventOptions *inOptions )
Catat peristiwa dari formulir yang telah diserialisasi, dengan opsi tambahan.
Fungsi ini mencatat peristiwa yang direpresentasikan sebagai nl::Weave::TLV::TLVReader. Ini menyiratkan bahwa representasi data peristiwa sudah diserialisasi dalam penyimpanan yang mendasari nl::Weave::TLV::TLVReader. Elemen nl::Weave::TLV::TLVReader diharapkan berisi setidaknya satu elemen data, elemen tersebut harus berupa struktur. Elemen pertama yang dibacakan dari pembaca diperlakukan sebagai data peristiwa dan disimpan di log peristiwa. Data peristiwa HARUS berisi tag konteks yang akan ditafsirkan dalam skema yang diidentifikasi oleh inProfileID dan inEventType. Tag elemen pertama akan diabaikan; sistem logging peristiwa akan menggantinya dengan tag eventData.
Peristiwa ini akan dicatat jika inImportance melebihi batas logging yang ditentukan di LoggingConfiguration. Jika nilai penting peristiwa tidak memenuhi nilai minimum saat ini, peristiwa tersebut akan dihapus dan fungsi akan menampilkan 0 sebagai ID peristiwa yang dihasilkan.
Varian pemanggilan ini memungkinkan pemanggil menetapkan kombinasi apa pun dari EventOptions:
- stempel waktu, ketika 0 secara {i>default<i} ke waktu saat ini pada titik panggilan,
- "akar" bagian sumber peristiwa (sumber peristiwa dan ID trait); jika NULL, defaultnya adalah perangkat saat ini. peristiwa ditandai sebagai berkaitan dengan perangkat yang melakukan panggilan,
- ID peristiwa terkait untuk mengelompokkan ID peristiwa; jika ID peristiwa terkait adalah 0, peristiwa ditandai sebagai tidak terkait dengan peristiwa lainnya,
- urgensi; secara default tidak mendesak.
| Detail | |||||||
|---|---|---|---|---|---|---|---|
| Parameter |
|
||||||
| Hasil |
event_id_t ID peristiwa jika peristiwa ditulis ke log, 0 jika tidak.
|
||||||
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData )
Catat peristiwa melalui callback.
Fungsi ini mencatat peristiwa yang direpresentasikan sebagai EventWriterFunct ke dalam log dan konteks appData khusus aplikasi. Fungsi tersebut menulis metadata peristiwa dan memanggil inEventWriter dengan referensi nl::Weave::TLV::TLVWriter dan konteks inAppData sehingga kode pengguna dapat memunculkan data peristiwa langsung ke log peristiwa. Bentuk logging peristiwa ini meminimalkan konsumsi memori karena data peristiwa diserialisasi langsung ke buffer target. Data peristiwa HARUS berisi tag konteks yang akan ditafsirkan dalam skema yang diidentifikasi oleh inProfileID dan inEventType. Tag elemen pertama akan diabaikan; sistem logging peristiwa akan menggantinya dengan tag eventData.
Peristiwa ini akan dicatat jika inImportance melebihi batas logging yang ditentukan di LoggingConfiguration. Jika nilai penting peristiwa tidak memenuhi nilai minimum saat ini, peristiwa tersebut akan dihapus dan fungsi akan menampilkan 0 sebagai ID peristiwa yang dihasilkan.
Varian pemanggilan ini secara implisit menentukan semua opsi peristiwa default:
- peristiwa diberi stempel waktu dengan waktu saat ini pada titik panggilan,
- peristiwa ditandai sebagai berkaitan dengan perangkat yang melakukan panggilan,
- peristiwa itu berdiri sendiri, tidak terkait dengan peristiwa lain,
- peristiwa ditandai sebagai tidak mendesak,
| Detail | |||||||
|---|---|---|---|---|---|---|---|
| Parameter |
|
||||||
| Hasil |
event_id_t ID peristiwa jika peristiwa ditulis ke log, 0 jika tidak.
|
||||||
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData, const EventOptions *inOptions )
Catat peristiwa melalui callback, dengan opsi.
Fungsi ini mencatat peristiwa yang direpresentasikan sebagai EventWriterFunct ke dalam log dan konteks appData khusus aplikasi. Fungsi tersebut menulis metadata peristiwa dan memanggil inEventWriter dengan referensi nl::Weave::TLV::TLVWriter dan konteks inAppData sehingga kode pengguna dapat memunculkan data peristiwa langsung ke log peristiwa. Bentuk logging peristiwa ini meminimalkan konsumsi memori karena data peristiwa diserialisasi langsung ke buffer target. Data peristiwa HARUS berisi tag konteks yang akan ditafsirkan dalam skema yang diidentifikasi oleh inProfileID dan inEventType. Tag elemen pertama akan diabaikan; sistem logging peristiwa akan menggantinya dengan tag eventData.
Peristiwa ini akan dicatat jika inImportance melebihi batas logging yang ditentukan di LoggingConfiguration. Jika nilai penting peristiwa tidak memenuhi nilai minimum saat ini, peristiwa tersebut akan dihapus dan fungsi akan menampilkan 0 sebagai ID peristiwa yang dihasilkan.
Varian pemanggilan ini memungkinkan pemanggil menetapkan kombinasi apa pun dari EventOptions:
- stempel waktu, ketika 0 secara {i>default<i} ke waktu saat ini pada titik panggilan,
- "akar" bagian sumber peristiwa (sumber peristiwa dan ID trait); jika NULL, defaultnya adalah perangkat saat ini. peristiwa ditandai sebagai berkaitan dengan perangkat yang melakukan panggilan,
- ID peristiwa terkait untuk mengelompokkan ID peristiwa; jika ID peristiwa terkait adalah 0, peristiwa ditandai sebagai tidak terkait dengan peristiwa lainnya,
- urgensi; secara default tidak mendesak.
| Detail | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Parameter |
|
||||||||
| Hasil |
event_id_t ID peristiwa jika peristiwa ditulis ke log, 0 jika tidak.
|
||||||||
LogFreeform
event_id_t LogFreeform( ImportanceType inImportance, const char *inFormat, ... )
LogFreeform memancarkan string bentuk bebas ke aliran peristiwa default.
String akan digabungkan dalam struktur peristiwa debug, yang secara struktural identik dengan string lain yang dicatat dalam log. ID profil peristiwa adalah peristiwa Nest Debug, dan jenis peristiwanya adalah kNestDebug_StringLogEntryEvent.
| Detail | |||||
|---|---|---|---|---|---|
| Parameter |
|
||||
| Hasil |
event_id_t ID peristiwa jika peristiwa ditulis ke log, 0 jika tidak.
|
||||
LookForElementWithTag
WEAVE_ERROR LookForElementWithTag( const nl::Weave::TLV::TLVReader & aSrcReader, const uint64_t aTagInApiForm, nl::Weave::TLV::TLVReader *apDstReader )
PlainTextWriter
WEAVE_ERROR PlainTextWriter( TLVWriter & ioWriter, uint8_t inDataTag, void *appData )
Fungsi bantuan untuk memunculkan teks bentuk bebas sebagai peristiwa debug.
Peristiwa debug adalah struktur dengan logregion dan teks bentuk bebas.
| Detail | |||||||
|---|---|---|---|---|---|---|---|
| Parameter |
|
||||||
| Nilai yang Ditampilkan |
|
||||||
PlainTextWriter
WEAVE_ERROR PlainTextWriter( ::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData )
Fungsi bantuan untuk memunculkan teks bentuk bebas sebagai peristiwa debug.
Peristiwa debug adalah struktur dengan logregion dan teks bentuk bebas.
| Detail | |||||||
|---|---|---|---|---|---|---|---|
| Parameter |
|
||||||
| Nilai yang Ditampilkan |
|
||||||