nl :: Menenun:: Profil :: DataManagement_Current
Namespace ini mencakup semua antarmuka dalam profil Weave for the Weave Data Management (WDM) yang saat ini didukung untuk penggunaan produksi.
Ringkasan
Typedefs | |
---|---|
CommandFlags | typedef |
DataVersion | typedefuint64_t |
EventProcessor | typedefvoid * |
EventWriterFunct )(nl::Weave::TLV::TLVWriter &ioWriter, uint8_t inDataTag, void *appData) | typedefWEAVE_ERROR (* Sebuah fungsi yang memasok elemen eventData untuk subsistem pencatatan kejadian. |
FetchExternalEventsFunct )(EventLoadOutContext *aContext) | typedefWEAVE_ERROR (* 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(* Trait handle iterator. |
LoggingBufferHandler )(void *inAppState, PacketBuffer *inBuffer) | typedefWEAVE_ERROR (* |
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 kejadian eksternal dikeluarkan dari buffer. |
PropertyDictionaryKey | typedefuint16_t |
PropertyPathHandle | typedefuint32_t PropertyPathHandle adalah hash numerik 32-bit unik dari jalur WDM yang berhubungan dengan akar dari sebuah contoh sifat. |
PropertySchemaHandle | typedefuint16_t |
SchemaVersion | typedefuint16_t |
SingleResourceSinkTraitCatalog | typedef |
SingleResourceSourceTraitCatalog | typedef |
TimestampType | typedef Validitas dan jenis stempel waktu yang disertakan dalam EventOptions . |
TraitDataHandle | typedefuint16_t |
duration_t | nl :: Weave :: Profiles :: DataManagement_Current :: durasi_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 Ketik 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 helper yang menerjemahkan elemen eventdata yang sudah berseri ke dalam buffer acara. |
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 acara dari formulir pra-serial. |
LogEvent (const EventSchema & inSchema,nl::Weave::TLV::TLVReader & inData, const EventOptions *inOptions) | Catat acara dari formulir pra-serial, dengan opsi tambahan. |
LogEvent (const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData) | Catat peristiwa melalui panggilan balik. |
LogEvent (const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData, const EventOptions *inOptions) | Catat peristiwa melalui panggilan balik, dengan opsi. |
LogFreeform ( ImportanceType inImportance, const char *inFormat, ...) | LogFreeform memancarkan string bentuk bebas ke aliran acara default. |
LookForElementWithTag (constnl::Weave::TLV::TLVReader & aSrcReader, const uint64_t aTagInApiForm,nl::Weave::TLV::TLVReader *apDstReader) | |
PlainTextWriter (TLVWriter & ioWriter, uint8_t inDataTag, void *appData) | Fungsi pembantu untuk memancarkan teks bentuk bebas sebagai acara debug. |
PlainTextWriter (::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData) | Fungsi pembantu untuk memancarkan teks bentuk bebas sebagai acara debug. |
operator!= (const ResourceIdentifier & lhs, const ResourceIdentifier & rhs) | bool |
operator== (const ResourceIdentifier & lhs, const ResourceIdentifier & rhs) | bool |
Serikat pekerja | |
---|---|
nl :: Weave :: Profiles :: DataManagement_Current :: Timestamp | Gabungan yang menyediakan sistem set aplikasi atau stempel waktu UTC. |
Pencacahan
@ 100
@100
@ 101
@101
@ 102
@102
Tag untuk acara yang ada.
@ 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 Pengaturan Logging .
@ 96
@96
Tag untuk kemampuan logging.
@ 97
@97
Tag untuk metadata acara.
Untuk semantik lengkap dari nilai tag, lihat Spesifikasi Desain Peristiwa.
Properti | |
---|---|
kTag_EventData | Pilihan. Data acara itu sendiri. Jika kosong, defaultnya adalah struktur kosong. |
kTag_EventDeltaSystemTime | Tag internal WDM, perbedaan waktu dari peristiwa sebelumnya dalam pengkodean. |
kTag_EventDeltaUTCTime | Tag internal WDM, perbedaan waktu dari peristiwa sebelumnya dalam pengkodean. |
kTag_EventID | Nomor urutan peristiwa, dinyatakan sebagai kuantitas unsigned 64-bit. Harus berurutan, lompatan dalam urutan menunjukkan celah acara. |
kTag_EventImportance | Pentingnya acara tersebut. |
kTag_EventResourceID | Pilihan. Nilai adalah ID sumber daya yang terkait dengan peristiwa tersebut. Jika dihilangkan, nilainya sama dengan nilai kTag_EventSource |
kTag_EventSource | NodeID perangkat yang menghasilkan acara. |
kTag_EventSystemTimestamp | Pilihan. Stempel Waktu Sistem peristiwa dalam milidetik. |
kTag_EventTraitInstanceID | Opsional, contoh sifat yang menghasilkan acara tersebut. |
kTag_EventTraitProfileID | Wajib. Integer 32-bit unsigned yang sama dengan ProfileID dari ciri tersebut. |
kTag_EventType | Wajib. Integer 16-bit unsigned yang sama dengan wdl.event.id untuk jenis acara ini. |
kTag_EventUTCTimestamp | Pilihan. UTC Timestamp acara dalam milidetik. |
kTag_ExternalEventStructure | Tag internal untuk acara eksternal. Jangan pernah dikirim melalui kabel, tidak boleh digunakan di luar perpustakaan Weave. |
kTag_RelatedEventID | Pilihan. ID Peristiwa yang terkait dengan peristiwa ini. Jika dihilangkan, nilainya sama dengan nilai kTag_EventID. |
kTag_RelatedEventImportance | Pilihan. Pentingnya acara terkait. Jika dihilangkan, nilainya sama dengan nilai kTag_EventImportance. |
@ 98
@98
Definisi profil untuk sifat debug.
@ 99
@99
Jenis peristiwa untuk sifat Nest Debug.
CommandFlags
CommandFlags
ImportanceType
ImportanceType.dll
Pentingnya entri log.
Kepentingan digunakan sebagai cara untuk memfilter peristiwa sebelum benar-benar dipancarkan ke dalam log. Setelah peristiwa ada di log, kami tidak membuat ketentuan lebih lanjut untuk menghapusnya dari log. Tingkat kepentingan berfungsi untuk memprioritaskan penyimpanan acara. Jika peristiwa yang sangat penting ditambahkan ke buffer penuh, peristiwa dihapus dalam urutan kepentingan (dan usia) untuk menampungnya. Dengan demikian, tingkat kepentingan hanya memiliki nilai relatif. Jika sistem hanya menggunakan satu tingkat kepentingan, peristiwa hanya dijatuhkan dalam urutan usia, seperti buffer cincin.
LoggingManagementStates
LoggingManagementStates
Typedefs
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)
Sebuah fungsi yang memasok elemen eventData untuk subsistem pencatatan kejadian.
Fungsi jenis ini diharapkan menyediakan elemen eventData untuk subsistem pencatatan kejadian. Fungsi jenis ini dipanggil setelah peristiwa subsistem telah menghasilkan semua metadata peristiwa yang diperlukan. Fungsi ini dipanggil dengan objeknl :: Weave :: TLV :: TLVWriter yang akan memancarkan satu elemen TLV yang diberi tag kTag_EventData; nilai elemen itu HARUS berupa struktur yang berisi data peristiwa. Data peristiwa itu sendiri harus disusun menggunakan tag konteks.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
| ||||||
Kembalikan Nilai |
|
PlainTextWriter
EventWriterTLVCopy
FetchExternalEventsFunct
WEAVE_ERROR(* FetchExternalEventsFunct)(EventLoadOutContext *aContext)
Prototipe fungsi untuk callback platform yang mengambil data peristiwa.
Mirip dengan FetchEventsSince, fungsi pengambilan ini mengembalikan semua peristiwa dari EventLoadOutContext.mStartingEventID melalui ExternalEvents.mLastEventID .
Penunjuk konteks berjenis FetchExternalEventsContext. Ini termasuk EventLoadOutContext , dengan beberapa variabel pembantu untuk format TLV . Ini juga mencakup penunjuk 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 peristiwa dan data ke penulis TLV dalam format yang benar, yang ditentukan oleh protokol EventLogging. Platform juga harus menjaga keunikan acara dan cap waktu.
Semua kesalahan 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 yang tersisa.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Kembalikan Nilai |
|
GenericTraitSinkCatalog
GenericTraitCatalogImpl< TraitDataSink > GenericTraitSinkCatalog
GenericTraitSourceCatalog
GenericTraitCatalogImpl< TraitDataSource > GenericTraitSourceCatalog
ImportanceType
enum nl::Weave::Profiles::DataManagement_Current::ImportanceType ImportanceType
Pentingnya entri log.
Kepentingan digunakan sebagai cara untuk memfilter peristiwa sebelum benar-benar dipancarkan ke dalam log. Setelah peristiwa ada di log, kami tidak membuat ketentuan lebih lanjut untuk menghapusnya dari log. Tingkat kepentingan berfungsi untuk memprioritaskan penyimpanan acara. Jika peristiwa yang sangat penting ditambahkan ke buffer penuh, peristiwa dihapus dalam urutan kepentingan (dan usia) untuk menampungnya. Dengan demikian, tingkat kepentingan hanya memiliki nilai relatif. Jika sistem hanya menggunakan satu tingkat kepentingan, peristiwa hanya dijatuhkan dalam urutan usia, seperti buffer cincin.
IteratorCallback
void(* IteratorCallback)(void *aTraitInstance, TraitDataHandle aHandle, void *aContext)
Trait handle iterator.
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 dikirim ke pelanggan jarak jauh, mesin akan memberikan pemberitahuan ke penyedia peristiwa eksternal. Callback berisi peristiwa ID terakhir yang dikirimkan, dan ID pelanggan yang menerima peristiwa tersebut.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
NotifyExternalEventsEvictedFunct
void(* NotifyExternalEventsEvictedFunct)(ExternalEvents *inEv)
Prototipe fungsi untuk callback yang dipanggil saat kejadian eksternal dikeluarkan dari buffer.
Saat objek peristiwa eksternal dikeluarkan dari buffer pesan keluar, mesin akan memberikan pemberitahuan ke penyedia peristiwa eksternal. Callback berisi peristiwa eksternal yang akan diusir.
Detail | |||
---|---|---|---|
Parameter |
|
PropertyDictionaryKey
uint16_t PropertyDictionaryKey
PropertyPathHandle
uint32_t PropertyPathHandle
PropertyPathHandle adalah hash numerik 32-bit unik dari jalur WDM yang berhubungan dengan akar dari sebuah contoh sifat.
Ini memiliki dua bagian:
- Angka 16-bit lebih rendah yang memetakan ke bagian statis skema.
- Jika 16-bit yang lebih rendah merujuk ke jalur dalam elemen kamus, terdapat angka 16-bit atas yang mewakili kunci kamus yang terkait dengan elemen itu. Jika 16-bit yang lebih rendah merujuk ke elemen non-kamus, maka 16-bit atas harus 0.
Beberapa karakteristik:
- Setiap sifat memiliki ruang pegangan jalur propertinya sendiri.
- Setiap jalur sub-jalur WDM unik akan memiliki PropertyPathHandle unik yang serupa.
- PropertyPathHandles dibuat secara otomatis (untuk saat ini dilakukan dengan tangan) oleh kompiler sifat dari IDL dan direpresentasikan sebagai daftar enumerant dalam file header dari sifat tersebut.
- Dengan konstruksi ini, logika aplikasi tidak pernah berurusan dengan jalur WDM secara langsung. Sebaliknya, interaksi mereka dengan WDM dilakukan secara eksklusif melalui pegangan ini.
- Ada dua nilai yang dipesan untuk tuas jalur yang memiliki arti khusus:
- 0 menunjukkan pegangan 'NULL'
- 1 menunjukkan pegangan yang menunjuk ke akar dari contoh sifat.
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 yang disertakan dalam EventOptions .
TraitDataHandle
uint16_t TraitDataHandle
durasi_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
Ketik 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 helper yang menerjemahkan elemen eventdata yang sudah berseri ke dalam buffer acara.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
| ||||||
Kembalikan Nilai |
|
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 yang terbaru.
IsVersionNewerOrEqual
bool IsVersionNewerOrEqual( const DataVersion & aVersion, const DataVersion & aReference )
Menemukan
TraitUpdatableDataSink * Locate( TraitDataHandle aTraitDataHandle, const TraitCatalogBase< TraitDataSink > *aDataSinkCatalog )
Fungsi utilitas yang menemukan TraitUpdatableDataSink dalam katalog TraitDataSink .
Detail | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembali | Sebuah pointer ke TraitUpdatableDataSink ; NULL jika pegangan tidak ada atau menunjuk ke TraitDataSink yang tidak dapat diperbarui . |
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData )
Catat acara dari formulir pra-serial.
Fungsi mencatat peristiwa yang direpresentasikan sebagainl :: Weave :: TLV :: TLVReader . Ini menyiratkan bahwa representasi data peristiwa sudah diserialkan dalam penyimpanan yang mendasarinl :: Weave :: TLV :: TLVReader .Nl :: Weave :: TLV :: TLVReader diharapkan berisi setidaknya satu elemen data, elemen itu harus berupa struktur. Elemen pertama yang dibaca dari pembaca diperlakukan sebagai data peristiwa dan disimpan di log peristiwa. Data peristiwa HARUS berisi tag konteks untuk ditafsirkan dalam skema yang diidentifikasi oleh inProfileID dan inEventType. Tag dari elemen pertama akan diabaikan; sistem pencatatan peristiwa akan menggantikannya dengan tag eventData.
Peristiwa dicatat jika inImportance melebihi ambang logging yang ditentukan di LoggingConfiguration . Jika kepentingan acara tidak memenuhi ambang saat ini, itu akan dihapus dan fungsi mengembalikan 0
sebagai ID acara yang dihasilkan.
Varian pemanggilan ini secara implisit menentukan semua opsi acara default:
- acara tersebut diberi stempel waktu dengan waktu saat ini pada saat melakukan panggilan,
- acara tersebut ditandai sebagai terkait dengan perangkat yang melakukan panggilan,
- acara tersebut berdiri sendiri, tidak terkait dengan acara lainnya,
- acara tersebut ditandai sebagai tidak mendesak,
Detail | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembali | event_id_t ID peristiwa jika peristiwa itu ditulis ke log, 0 sebaliknya. |
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData, const EventOptions *inOptions )
Catat acara dari formulir pra-serial, dengan opsi tambahan.
Fungsi mencatat peristiwa yang direpresentasikan sebagainl :: Weave :: TLV :: TLVReader . Ini menyiratkan bahwa representasi data peristiwa sudah diserialkan dalam penyimpanan yang mendasarinl :: Weave :: TLV :: TLVReader .Nl :: Weave :: TLV :: TLVReader diharapkan berisi setidaknya satu elemen data, elemen itu harus berupa struktur. Pembacaan elemen pertama dari pembaca diperlakukan sebagai data peristiwa dan disimpan di log peristiwa. Data peristiwa HARUS berisi tag konteks untuk ditafsirkan dalam skema yang diidentifikasi oleh inProfileID dan inEventType. Tag dari elemen pertama akan diabaikan; sistem pencatatan peristiwa akan menggantinya dengan tag eventData.
Peristiwa dicatat jika inImportance melebihi ambang logging yang ditentukan di LoggingConfiguration . Jika kepentingan acara tidak memenuhi ambang saat ini, itu akan dihapus dan fungsi mengembalikan 0
sebagai ID acara yang dihasilkan.
Varian pemanggilan ini memungkinkan pemanggil untuk menyetel kombinasi EventOptions
:
- stempel waktu, ketika 0 default ke waktu saat ini pada saat panggilan,
- bagian "root" dari sumber peristiwa (sumber peristiwa dan ID sifat); jika NULL, defaultnya ke perangkat saat ini. acara tersebut ditandai sebagai terkait dengan perangkat yang melakukan panggilan,
- ID acara terkait untuk mengelompokkan ID acara; ketika ID peristiwa terkait adalah 0, peristiwa tersebut ditandai sebagai tidak terkait dengan peristiwa lain,
- urgensi; secara default tidak mendesak.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
| ||||||
Kembali | event_id_t ID peristiwa jika peristiwa itu ditulis ke log, 0 sebaliknya. |
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData )
Catat peristiwa melalui panggilan balik.
Fungsi mencatat peristiwa yang direpresentasikan sebagai EventWriterFunct dan konteks appData
khusus appData
. Fungsi tersebut menulis metadata peristiwa dan memanggil inEventWriter
dengan inEventWriter
nl :: Weave :: TLV :: TLVWriter dan konteks inAppData
sehingga kode pengguna dapat mengirimkan data peristiwa langsung ke dalam log peristiwa. Bentuk pencatatan peristiwa ini meminimalkan konsumsi memori, karena data peristiwa diserialkan langsung ke buffer target. Data peristiwa HARUS berisi tag konteks untuk ditafsirkan dalam skema yang diidentifikasi oleh inProfileID
dan inEventType
. Tag dari elemen pertama akan diabaikan; sistem pencatatan peristiwa akan menggantikannya dengan tag eventData.
Peristiwa dicatat jika inImportance-nya melebihi ambang logging yang ditentukan di LoggingConfiguration . Jika kepentingan acara tidak memenuhi ambang saat ini, itu akan dihapus dan fungsi mengembalikan 0
sebagai ID acara yang dihasilkan.
Varian pemanggilan ini secara implisit menentukan semua opsi acara default:
- acara tersebut diberi stempel waktu dengan waktu saat ini pada saat melakukan panggilan,
- acara tersebut ditandai sebagai terkait dengan perangkat yang melakukan panggilan,
- acara tersebut berdiri sendiri, tidak terkait dengan acara lainnya,
- acara tersebut ditandai sebagai tidak mendesak,
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
| ||||||
Kembali | event_id_t ID peristiwa jika peristiwa itu ditulis ke log, 0 sebaliknya. |
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData, const EventOptions *inOptions )
Catat peristiwa melalui panggilan balik, dengan opsi.
Fungsi mencatat peristiwa yang direpresentasikan sebagai EventWriterFunct dan konteks appData
khusus appData
. Fungsi tersebut menulis metadata peristiwa dan memanggil inEventWriter
dengan inEventWriter
nl :: Weave :: TLV :: TLVWriter dan konteks inAppData
sehingga kode pengguna dapat mengirimkan data peristiwa langsung ke dalam log peristiwa. Bentuk pencatatan peristiwa ini meminimalkan konsumsi memori, karena data peristiwa diserialkan langsung ke buffer target. Data peristiwa HARUS berisi tag konteks untuk ditafsirkan dalam skema yang diidentifikasi oleh inProfileID
dan inEventType
. Tag dari elemen pertama akan diabaikan; sistem pencatatan peristiwa akan menggantinya dengan tag eventData.
Peristiwa dicatat jika inImportance melebihi ambang logging yang ditentukan dalam LoggingConfiguration . Jika kepentingan acara tidak memenuhi ambang saat ini, itu akan dihapus dan fungsi mengembalikan 0
sebagai ID acara yang dihasilkan.
Varian pemanggilan ini memungkinkan pemanggil untuk menyetel kombinasi EventOptions
:
- stempel waktu, ketika 0 default ke waktu saat ini pada saat panggilan,
- bagian "root" dari sumber peristiwa (sumber peristiwa dan ID sifat); jika NULL, defaultnya ke perangkat saat ini. acara tersebut ditandai sebagai terkait dengan perangkat yang melakukan panggilan,
- ID acara terkait untuk mengelompokkan ID acara; ketika ID peristiwa terkait adalah 0, peristiwa tersebut ditandai sebagai tidak terkait dengan peristiwa lain,
- urgensi; secara default tidak mendesak.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||
Kembali | event_id_t ID peristiwa jika peristiwa itu ditulis ke log, 0 sebaliknya. |
LogFreeform
event_id_t LogFreeform( ImportanceType inImportance, const char *inFormat, ... )
LogFreeform memancarkan string bentuk bebas ke aliran acara default.
String tersebut akan dienkapsulasi dalam struktur peristiwa debug, yang secara struktural identik dengan string yang dicatat lainnya. ID profil peristiwa adalah peristiwa Nest Debug, dan jenis peristiwa adalah kNestDebug_StringLogEntryEvent
.
Detail | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembali | event_id_t ID peristiwa jika peristiwa itu ditulis ke log, 0 sebaliknya. |
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 pembantu untuk memancarkan teks bentuk bebas sebagai acara debug.
Peristiwa debug adalah struktur dengan logregion dan teks bentuk bebas.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
| ||||||
Kembalikan Nilai |
|
PlainTextWriter
WEAVE_ERROR PlainTextWriter( ::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData )
Fungsi pembantu untuk memancarkan teks bentuk bebas sebagai acara debug.
Peristiwa debug adalah struktur dengan logregion dan teks bentuk bebas.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
| ||||||
Kembalikan Nilai |
|
operator! =
bool operator!=( const ResourceIdentifier & lhs, const ResourceIdentifier & rhs )
operator ==
bool operator==( const ResourceIdentifier & lhs, const ResourceIdentifier & rhs )