Halaman ini diterjemahkan oleh Cloud Translation API.

nl::Weave::Profil::DataManagement_Current::LoggingManagement

#include <src/lib/profiles/data-management/Current/LoggingManagement.h>

Class untuk mengelola log peristiwa di memori.

Ringkasan

Konstruktor dan Destruktor
`LoggingManagement(nl::Weave::WeaveExchangeManager inMgr, size_t inNumBuffers, const LogStorageResources const inLogStorageResources)` LoggingManagement.
`LoggingManagement(void)` Konstruktor default LoggingManagement.

Fungsi publik
`BlitEvent(EventLoadOutContext aContext, const EventSchema & inSchema, EventWriterFunct inEventWriter, void inAppData, const EventOptions *inOptions)`	`WEAVE_ERROR` Fungsi bantuan untuk menulis header dan data peristiwa sesuai dengan protokol logging peristiwa.
`CancelShutdownInProgress(void)`	`void` Menetapkan flag mShutdownInProgress ke false.
`CheckShouldRunWDM(void)`	`bool` Tentukan apakah akan memindahkan peristiwa berdasarkan jumlah byte dalam buffer peristiwa yang tidak terjadwal untuk upload.
`FetchEventsSince(nl::Weave::TLV::TLVWriter & ioWriter, ImportanceType inImportance, event_id_t & ioEventID)`	`WEAVE_ERROR` Fungsi untuk mengambil peristiwa penting yang ditentukan sejak ID peristiwa yang ditentukan.
`GetBytesWritten(void) const`	`uint32_t` Dapatkan jumlah total byte yang ditulis (di semua tingkat kepentingan peristiwa) ke log ini sejak pembuatan instance.
`GetEventReader(nl::Weave::TLV::TLVReader & ioReader, ImportanceType inImportance)`	`WEAVE_ERROR` Metode bantuan yang berguna untuk memeriksa buffer log dalam memori.
`GetFirstEventID(ImportanceType inImportance)`	`event_id_t` Ambil ID peristiwa pertama yang saat ini disimpan untuk tingkat nilai penting tertentu.
`GetLastEventID(ImportanceType inImportance)`	`event_id_t` Ambil ID terbaru yang diteruskan untuk tingkat kepentingan tertentu.
`IsShutdownInProgress(void)`	`bool` Periksa tanda mShutdownInProgress.
`IsValid(void)`	`bool` IsValid menampilkan apakah instance LoggingManagement valid.
`LoadEvents(TLVReader & reader)`	`WEAVE_ERROR` Peristiwa pemuatan Weave yang sebelumnya dipertahankan.
`LogEvent(const EventSchema & inSchema, EventWriterFunct inEventWriter, void inAppData, const EventOptions inOptions)`	`event_id_t` Membuat log peristiwa melalui callback, dengan opsi.
`MarkShutdownInProgress(void)`	`void` Menetapkan flag mShutdownInProgress ke true.
`NotifyEventsDelivered(ImportanceType inImportance, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID)`	`void`
`RegisterEventCallbackForImportance(ImportanceType inImportance, FetchExternalEventsFunct inFetchCallback, NotifyExternalEventsDeliveredFunct inNotifyCallback, NotifyExternalEventsEvictedFunct inEvictedCallback, size_t inNumEvents, event_id_t *outLastEventID)`	`WEAVE_ERROR` API publik untuk mendaftarkan serangkaian peristiwa yang disimpan secara eksternal.
`RegisterEventCallbackForImportance(ImportanceType inImportance, FetchExternalEventsFunct inFetchCallback, NotifyExternalEventsDeliveredFunct inNotifyCallback, size_t inNumEvents, event_id_t *outLastEventID)`	`WEAVE_ERROR` API publik untuk mendaftarkan serangkaian peristiwa yang disimpan secara eksternal.
`RegisterEventCallbackForImportance(ImportanceType inImportance, FetchExternalEventsFunct inFetchCallback, size_t inNumEvents, event_id_t *outLastEventID)`	`WEAVE_ERROR` API publik untuk mendaftarkan serangkaian peristiwa yang disimpan secara eksternal.
`ScheduleFlushIfNeeded(bool inFlushRequested)`	`WEAVE_ERROR` Menjadwalkan tugas penghapusan log.
`SerializeEvents(TLVWriter & writer)`	`WEAVE_ERROR` Lakukan serialisasi peristiwa Weave dari semua jenis nilai penting.
`SetBDXUploader(LogBDXUpload *inUploader)`	`void`
`SetExchangeManager(nl::Weave::WeaveExchangeManager *inMgr)`	`WEAVE_ERROR` Tetapkan WeaveExchangeManager agar digunakan dengan subsistem logging ini.
`SetLoggingEndpoint(event_id_t *inEventEndpoints, size_t inNumImportanceLevels, size_t & outLoggingPosition)`	`WEAVE_ERROR`
`SkipEvent(EventLoadOutContext *aContext)`	`void` Fungsi bantuan untuk melewati penulisan peristiwa yang sesuai dengan ID peristiwa yang dialokasikan.
`ThrottleLogger(void)`	`void` ThrottleLogger meningkatkan tingkat logging yang efektif ke tingkat Produksi.
`UnregisterEventCallbackForImportance(ImportanceType inImportance, event_id_t inEventID)`	`void` API publik untuk membatalkan pendaftaran kumpulan peristiwa yang disimpan secara eksternal.
`UnthrottleLogger(void)`	`void` UnthrottleLogger memulihkan tingkat logging yang efektif ke tingkat logging yang dikonfigurasi.

Fungsi statis publik
`CreateLoggingManagement(nl::Weave::WeaveExchangeManager inMgr, size_t inNumBuffers, const LogStorageResources const inLogStorageResources)`	`void` Buat objek LoggingManagement dan inisialisasi subsistem pengelolaan logging dengan resource yang disediakan.
`DestroyLoggingManagement(void)`	`void` Lakukan tindakan yang diperlukan untuk menonaktifkan.
`GetInstance(void)`	`LoggingManagement &`

Fungsi publik

BlitEvent

WEAVE_ERROR BlitEvent(
  EventLoadOutContext *aContext,
  const EventSchema & inSchema,
  EventWriterFunct inEventWriter,
  void *inAppData,
  const EventOptions *inOptions
)

Fungsi bantuan untuk menulis header dan data peristiwa sesuai dengan protokol logging peristiwa.

Detail

Parameter

`[in,out] aContext`	EventLoadOutContext, diinisialisasi dengan informasi stateful untuk buffer tersebut. Status diperbarui dan dipertahankan oleh BlitEvent menggunakan konteks ini.
`[in] inSchema`	Skema yang menentukan nilai penting, ID profil, dan jenis struktur peristiwa ini.
`[in] inEventWriter`	Callback yang akan dipanggil untuk melakukan serialisasi data peristiwa.
`[in] inAppData`	Konteks aplikasi untuk callback.
`[in] inOptions`	EventOptions yang menjelaskan stempel waktu dan tag lainnya yang relevan dengan peristiwa ini.

Membatalkan Penonaktifan

void CancelShutdownInProgress(
  void
)

Menetapkan flag mShutdownInProgress ke false.

Check shouldRunWDM

bool CheckShouldRunWDM(
  void
)

Tentukan apakah akan memindahkan peristiwa berdasarkan jumlah byte dalam buffer peristiwa yang tidak terjadwal untuk upload.

Perilaku fungsi dikontrol melalui konstanta WEAVE_CONFIG_EVENT_LOGGING_BYTE_THRESHOLD. Jika sistem menulis lebih dari jumlah byte tersebut sejak terakhir kali Notifikasi WDM dikirim, fungsi tersebut akan menunjukkan bahwa sudah waktunya untuk memicu NotificationEngine.

Detail

Nilai yang Ditampilkan

`true`	Peristiwa harus dipindah muatannya
`false`	Atau

FetchEventsSince

WEAVE_ERROR FetchEventsSince(
  nl::Weave::TLV::TLVWriter & ioWriter,
  ImportanceType inImportance,
  event_id_t & ioEventID
)

Fungsi untuk mengambil peristiwa penting yang ditentukan sejak ID peristiwa yang ditentukan.

Mengingat nl::Weave::TLV::TLVWriter, jenis nilai penting, dan ID peristiwa, fungsi akan mengambil peristiwa dengan tingkat kepentingan yang ditentukan sejak peristiwa yang ditentukan. Fungsi ini akan terus mengambil peristiwa hingga kehabisan ruang di nl::Weave::TLV::TLVWriter atau di log. Fungsi ini akan menghentikan penulisan peristiwa pada batas peristiwa.

Detail

Parameter

`[in] ioWriter`	Penulis akan digunakan untuk penyimpanan peristiwa
`[in] inImportance`	Pentingnya acara yang akan diambil
`[in,out] ioEventID`	Pada input, ID peristiwa tepat sebelum ID yang kami ambil. Setelah selesai, ID peristiwa terakhir diambil.

Nilai yang Ditampilkan

`WEAVE_END_OF_TLV`	Fungsi telah mencapai akhir entri log yang tersedia pada tingkat kepentingan yang ditentukan
`WEAVE_ERROR_NO_MEMORY`	Fungsi kehabisan ruang di ioWriter, tersedia lebih banyak peristiwa di log.
`WEAVE_ERROR_BUFFER_TOO_SMALL`	Fungsi kehabisan ruang di ioWriter, tersedia lebih banyak peristiwa di log.

GetBytesWritten

uint32_t GetBytesWritten(
  void
) const

Dapatkan jumlah total byte yang ditulis (di semua tingkat kepentingan peristiwa) ke log ini sejak pembuatan instance.

Detail
Menampilkan	Jumlah byte yang ditulis ke log.

GetEventReader

WEAVE_ERROR GetEventReader(
  nl::Weave::TLV::TLVReader & ioReader,
  ImportanceType inImportance
)

Metode bantuan yang berguna untuk memeriksa buffer log dalam memori.

Detail

Parameter

`[in,out] ioReader`	Referensi ke pembaca yang akan diinisialisasi dengan penyimpanan cadangan dari log aktivitas
`[in] inImportance`	Nilai penting awal bagi pembaca. Perhatikan bahwa dalam kasus ini, tingkat kepentingan awal agak intuitif: peristiwa yang lebih penting berbagi buffer dengan peristiwa yang kurang penting, selain buffer khusus. Hasilnya, pembaca akan membaca data paling sedikit saat nilai penting Debug diteruskan.

Menampilkan

WEAVE_NO_ERROR Tanpa syarat.

ID GetFirstEventID

event_id_t GetFirstEventID(
  ImportanceType inImportance
)

Ambil ID peristiwa pertama yang saat ini disimpan untuk tingkat nilai penting tertentu.

Detail

Parameter

inImportance

Tingkat kepentingan

Menampilkan

event_id_t ID peristiwa yang pertama kali disimpan untuk nilai penting peristiwa tersebut

ID LastEventID

event_id_t GetLastEventID(
  ImportanceType inImportance
)

Ambil ID terbaru yang diteruskan untuk tingkat kepentingan tertentu.

Detail

Parameter

inImportance

Tingkat kepentingan

Menampilkan

event_id_t ID peristiwa terbaru untuk nilai penting peristiwa tersebut

IsShutdownInProgress

bool IsShutdownInProgress(
  void
)

Periksa tanda mShutdownInProgress.

Valid

bool IsValid(
  void
)

IsValid menampilkan apakah instance LoggingManagement valid.

Detail

Nilai yang Ditampilkan

`true`	Instance ini valid (diinisialisasi dengan backup store yang sesuai)
`false`	Atau

PeristiwaPemuatan

WEAVE_ERROR LoadEvents(
  TLVReader & reader
)

Peristiwa pemuatan Weave yang sebelumnya dipertahankan.

PeristiwaLog

event_id_t LogEvent(
  const EventSchema & inSchema,
  EventWriterFunct inEventWriter,
  void *inAppData,
  const EventOptions *inOptions
)

Membuat log peristiwa melalui callback, dengan opsi.

Fungsi mencatat log peristiwa yang direpresentasikan sebagai EventWriterFunct dan konteks appData khusus aplikasi. Fungsi ini 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 dicatat dalam log jika nilai penting skema melebihi nilai minimum logging yang ditentukan dalam 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 pemanggilan ini memungkinkan pemanggil untuk menetapkan kombinasi EventOptions:

stempel waktu, saat 0 ditetapkan secara default ke waktu saat ini pada titik panggilan,
"root" dari sumber peristiwa (sumber peristiwa dan ID fitur); jika NULL, setelan default perangkat saat ini akan ditandai. Peristiwa ditandai sebagai terkait dengan perangkat yang membuat panggilan,
ID peristiwa terkait untuk mengelompokkan ID peristiwa; jika ID peristiwa terkait adalah 0, peristiwa akan ditandai sebagai tidak terkait dengan peristiwa lainnya,
urgensi; secara default tidak mendesak.

Detail

Parameter

`[in] inSchema`	Skema yang menentukan nilai penting, ID profil, dan jenis struktur peristiwa ini.
`[in] inEventWriter`	Callback yang akan dipanggil untuk benar-benar menserialisasikan data peristiwa
`[in] inAppData`	Konteks aplikasi untuk callback.
`[in] inOptions`	Opsi untuk metadata peristiwa. Mungkin NULL.

Menampilkan

event_id_t ID peristiwa jika peristiwa ditulis ke log, 0 jika tidak.

Pengelolaan Logging

 LoggingManagement(
  nl::Weave::WeaveExchangeManager *inMgr,
  size_t inNumBuffers,
  const LogStorageResources *const inLogStorageResources
)

LoggingManagement.

Inisialisasi LoggingManagement dengan array LogStorageResources. Array harus menyediakan resource untuk setiap tingkat kepentingan yang valid, elemen array harus dalam peningkatan nilai numerik nilai penting (dan dalam nilai penting yang menurun); elemen pertama dalam array sesuai dengan sumber daya yang dialokasikan untuk peristiwa yang paling penting, dan elemen terakhir harus sesuai dengan peristiwa yang paling tidak penting.

Detail

Parameter

`[in] inMgr`	WeaveExchangeManager untuk digunakan dengan subsistem logging ini
`[in] inNumBuffers`	Jumlah elemen dalam array inLogStorageResources
`[in] inLogStorageResources`	Array LogStorageResources untuk setiap tingkat kepentingan.

Pengelolaan Logging

 LoggingManagement(
  void
)

Konstruktor default LoggingManagement.

Disediakan terutama untuk membuat compiler senang.

Detail
Menampilkan	Pengelolaan Logging

MarkShutdownDalam Proses

void MarkShutdownInProgress(
  void
)

Menetapkan flag mShutdownInProgress ke true.

NotifyEventsTerkirim

void NotifyEventsDelivered(
  ImportanceType inImportance,
  event_id_t inLastDeliveredEventID,
  uint64_t inRecipientNodeID
)

RegisterEventCallbackForImportant

WEAVE_ERROR RegisterEventCallbackForImportance(
  ImportanceType inImportance,
  FetchExternalEventsFunct inFetchCallback,
  NotifyExternalEventsDeliveredFunct inNotifyCallback,
  NotifyExternalEventsEvictedFunct inEvictedCallback,
  size_t inNumEvents,
  event_id_t *outLastEventID
)

API publik untuk mendaftarkan serangkaian peristiwa yang disimpan secara eksternal.

Daftarkan callback formulir FetchExternalEventsFunct. API ini mengharuskan platform mengetahui jumlah peristiwa pada pendaftaran. Cara kerja internal juga mengharuskan angka ini konstan. Karena API ini tidak mengizinkan platform untuk mendaftarkan ID peristiwa tertentu, hal ini akan mencegah platform menyimpan penyimpanan peristiwa (setidaknya dengan ID peristiwa unik).

Callback akan dipanggil setiap kali pelanggan mencoba untuk mengambil ID peristiwa dalam rentang berapa kali hingga pendaftaran dibatalkan.

Varian fungsi ini harus digunakan saat penyedia eksternal ingin diberi tahu saat peristiwa telah dikirim ke pelanggan dan jika objek peristiwa eksternal dikeluarkan.

Saat peristiwa dikirim, penyedia eksternal akan diberi tahu tentang hal tersebut bersama dengan ID node penerima dan id peristiwa terakhir yang dikirim ke penerima tersebut. Perhatikan bahwa penyedia eksternal mungkin diberi tahu beberapa kali untuk ID acara yang sama. Tidak ada batasan khusus pada pengendali, khususnya, pengendali dapat membatalkan pendaftaran ID peristiwa eksternal.

Jika objek peristiwa eksternal dikeluarkan dari buffer log, penyedia eksternal akan diberi tahu bersama dengan salinan objek peristiwa eksternal.

Pointer ke struct ExternalEvents akan menjadi NULL jika gagal, atau akan diisi dengan ID peristiwa awal dan akhir yang ditetapkan ke callback. Pointer ini harus digunakan untuk membatalkan pendaftaran kumpulan peristiwa.

Lihat dokumentasi untuk FetchExternalEventsFunct untuk detail tentang apa yang harus diimplementasikan oleh callback.

Detail

Parameter

`[in] inImportance`	Tingkat kepentingan
`[in] inFetchCallback`	Callback untuk mendaftar guna mengambil peristiwa eksternal
`[in] inNotifyCallback`	Callback untuk pendaftaran notifikasi pengiriman
`[in] inEvictedCallback`	Callback untuk notifikasi penggusuran
`[in] inNumEvents`	Jumlah peristiwa dalam kumpulan ini
`[out] outLastEventID`	Pointer ke event_id_t; saat pendaftaran peristiwa eksternal berhasil, fungsi akan menyimpan ID peristiwa yang sesuai dengan ID peristiwa terakhir blok peristiwa eksternal. Parameternya mungkin NULL.

Nilai yang Ditampilkan

`WEAVE_ERROR_NO_MEMORY`	Jika tidak ada lagi slot callback yang tersedia.
`WEAVE_ERROR_INVALID_ARGUMENT`	Callback fungsi null atau tidak ada peristiwa untuk didaftarkan.
`WEAVE_NO_ERROR`	Jika berhasil.

RegisterEventCallbackForImportant

WEAVE_ERROR RegisterEventCallbackForImportance(
  ImportanceType inImportance,
  FetchExternalEventsFunct inFetchCallback,
  NotifyExternalEventsDeliveredFunct inNotifyCallback,
  size_t inNumEvents,
  event_id_t *outLastEventID
)

API publik untuk mendaftarkan serangkaian peristiwa yang disimpan secara eksternal.

Callback akan dipanggil setiap kali pelanggan mencoba untuk mengambil ID peristiwa dalam rentang berapa kali hingga pendaftaran dibatalkan.

Varian fungsi ini harus digunakan saat penyedia eksternal ingin diberi tahu saat peristiwa telah dikirim ke pelanggan, tetapi tidak saat objek peristiwa eksternal dikeluarkan. Saat peristiwa dikirim, penyedia eksternal akan diberi tahu tentang hal tersebut bersama dengan ID node penerima dan id peristiwa terakhir yang dikirim ke penerima tersebut. Perhatikan bahwa penyedia eksternal mungkin diberi tahu beberapa kali untuk ID acara yang sama. Tidak ada batasan khusus pada pengendali, khususnya, pengendali dapat membatalkan pendaftaran ID peristiwa eksternal.

Lihat dokumentasi untuk FetchExternalEventsFunct untuk detail tentang apa yang harus diimplementasikan oleh callback.

Detail

Parameter

`[in] inImportance`	Tingkat kepentingan
`[in] inCallback`	Callback untuk mendaftar guna mengambil peristiwa eksternal
`[in] inNotifyCallback`	Callback untuk pendaftaran notifikasi pengiriman
`[in] inNumEvents`	Jumlah peristiwa dalam kumpulan ini
`[out] outLastEventID`	Pointer ke event_id_t; saat pendaftaran peristiwa eksternal berhasil, fungsi akan menyimpan ID peristiwa yang sesuai dengan ID peristiwa terakhir blok peristiwa eksternal. Parameternya mungkin NULL.

Nilai yang Ditampilkan

`WEAVE_ERROR_NO_MEMORY`	Jika tidak ada lagi slot callback yang tersedia.
`WEAVE_ERROR_INVALID_ARGUMENT`	Callback fungsi null atau tidak ada peristiwa untuk didaftarkan.
`WEAVE_NO_ERROR`	Jika berhasil.

RegisterEventCallbackForImportant

WEAVE_ERROR RegisterEventCallbackForImportance(
  ImportanceType inImportance,
  FetchExternalEventsFunct inFetchCallback,
  size_t inNumEvents,
  event_id_t *outLastEventID
)

API publik untuk mendaftarkan serangkaian peristiwa yang disimpan secara eksternal.

Callback akan dipanggil setiap kali pelanggan mencoba untuk mengambil ID peristiwa dalam rentang berapa kali hingga pendaftaran dibatalkan.

Varian fungsi ini harus digunakan saat penyedia eksternal meminta notifikasi saat peristiwa eksternal telah dikirim atau saat objek peristiwa eksternal dikeluarkan.

Lihat dokumentasi untuk FetchExternalEventsFunct untuk detail tentang apa yang harus diimplementasikan oleh callback.

Detail

Parameter

`[in] inImportance`	Tingkat kepentingan
`[in] inCallback`	Callback untuk mendaftar guna mengambil peristiwa eksternal
`[in] inNumEvents`	Jumlah peristiwa dalam kumpulan ini
`[out] outLastEventID`	Pointer ke event_id_t; saat pendaftaran peristiwa eksternal berhasil, fungsi akan menyimpan ID peristiwa yang sesuai dengan ID peristiwa terakhir blok peristiwa eksternal. Parameternya mungkin NULL.

Nilai yang Ditampilkan

`WEAVE_ERROR_NO_MEMORY`	Jika tidak ada lagi slot callback yang tersedia.
`WEAVE_ERROR_INVALID_ARGUMENT`	Callback fungsi null atau tidak ada peristiwa untuk didaftarkan.
`WEAVE_NO_ERROR`	Jika berhasil.

MenjadwalkanFlushIfNeeded

WEAVE_ERROR ScheduleFlushIfNeeded(
  bool inFlushRequested
)

Menjadwalkan tugas penghapusan log.

Fungsi ini memutuskan apakah akan menjadwalkan proses offload tugas, dan jika demikian, fungsi akan menjadwalkan LoggingFlushHandler agar dijalankan secara asinkron di thread Weave.

Keputusan untuk menjadwalkan flush bergantung pada tiga faktor:

permintaan eksplisit untuk membersihkan buffer

status buffer peristiwa dan jumlah data yang belum disinkronkan dengan konsumen peristiwa

apakah sudah ada peristiwa permintaan penghapusan yang tertunda.

Permintaan eksplisit untuk menjadwalkan flush diteruskan melalui parameter input.

Pembersihan otomatis biasanya dijadwalkan saat buffer peristiwa berisi cukup data untuk memulai penggantian baru. Pemicu tambahan seperti waktu minimum dan maksimum antar-offload juga dapat dipertimbangkan, tergantung pada strategi offload.

Status tertunda untuk log aktivitas ditunjukkan oleh variabel mUploadRequested. Karena fungsi ini dapat dipanggil oleh beberapa thread, mUploadRequested harus dibaca dan disetel secara atomik, agar penjadwalan LoggingFlushHandler tidak berlebihan sebelum notifikasi dikirim.

Detail

Parameter

inRequestFlush

Nilai boolean yang menunjukkan apakah flush harus dijadwalkan, terlepas dari kebijakan pengelolaan buffer internal.

Nilai yang Ditampilkan

`WEAVE_ERROR_INCORRECT_STATE`	Modul LoggingManagement tidak diinisialisasi sepenuhnya.
`WEAVE_NO_ERROR`	Jika berhasil.

Serialisasi

WEAVE_ERROR SerializeEvents(
  TLVWriter & writer
)

Lakukan serialisasi peristiwa Weave dari semua jenis nilai penting.

Melakukan serialisasi peristiwa di WeaveCircularTLVBuffer dan status terkait ke buffer yang diberikan.

Metode ini dimaksudkan untuk digunakan oleh perangkat yang tidak mempertahankan RAM saat tidur, yang memungkinkannya mempertahankan peristiwa sebelum tidur dan dengan demikian mencegah hilangnya peristiwa

SetBDXUploader

void SetBDXUploader(
  LogBDXUpload *inUploader
)

SetExchangeManager

WEAVE_ERROR SetExchangeManager(
  nl::Weave::WeaveExchangeManager *inMgr
)

Tetapkan WeaveExchangeManager agar digunakan dengan subsistem logging ini.

Di beberapa platform, hal ini mungkin perlu dilakukan secara terpisah dari CreateLoggingManagement() di atas.

Detail

Parameter

[in] inMgr

WeaveExchangeManager untuk digunakan dengan subsistem logging ini

SetLoggingEndpoint

WEAVE_ERROR SetLoggingEndpoint(
  event_id_t *inEventEndpoints,
  size_t inNumImportanceLevels,
  size_t & outLoggingPosition
)

SkipEvent

void SkipEvent(
  EventLoadOutContext *aContext
)

Fungsi bantuan untuk melewati penulisan peristiwa yang sesuai dengan ID peristiwa yang dialokasikan.

Detail

Parameter

[in,out] aContext

EventLoadOutContext, diinisialisasi dengan informasi stateful untuk buffer tersebut. Status diperbarui dan dipertahankan oleh BlitEvent menggunakan konteks ini.

Penjepit ThrottleLogger

void ThrottleLogger(
  void
)

ThrottleLogger meningkatkan tingkat logging yang efektif ke tingkat Produksi.

UnregisterEventCallbackForTingkat Penting

void UnregisterEventCallbackForImportance(
  ImportanceType inImportance,
  event_id_t inEventID
)

API publik untuk membatalkan pendaftaran kumpulan peristiwa yang disimpan secara eksternal.

Membatalkan pendaftaran callback akan mencegah LoggingManagement memanggil callback untuk serangkaian peristiwa. LoggingManagement tidak akan lagi mengirimkan ID peristiwa tersebut kepada pelanggan.

Intent ini adalah untuk satu fungsi untuk menyajikan kumpulan peristiwa dalam satu waktu. Jika sekumpulan peristiwa baru perlu didaftarkan menggunakan fungsi yang sama, callback harus dibatalkan pendaftarannya terlebih dahulu, lalu didaftarkan lagi. Artinya, kumpulan peristiwa asli tidak dapat diambil lagi.

Fungsi ini berhasil tanpa syarat. Jika callback tidak pernah terdaftar atau sudah tidak terdaftar, berarti tidak ada operasi.

Detail

Parameter

`[in] inImportance`	Tingkat kepentingan
`[in] inEventID`	ID peristiwa yang sesuai dengan peristiwa apa pun dalam blok peristiwa eksternal yang akan dibatalkan pendaftarannya.

Pembatalan Pencatatan Log

void UnthrottleLogger(
  void
)

UnthrottleLogger memulihkan tingkat logging yang efektif ke tingkat logging yang dikonfigurasi.

Fungsi statis publik

CreateLoggingManagement

void CreateLoggingManagement(
  nl::Weave::WeaveExchangeManager *inMgr,
  size_t inNumBuffers,
  const LogStorageResources *const inLogStorageResources
)

Buat objek LoggingManagement dan inisialisasi subsistem pengelolaan logging dengan resource yang disediakan.

Detail

Parameter

`[in] inMgr`	WeaveExchangeManager untuk digunakan dengan subsistem logging ini
`[in] inNumBuffers`	Jumlah elemen dalam array inLogStorageResources
`[in] inLogStorageResources`	Array LogStorageResources untuk setiap tingkat kepentingan.

MenghancurkanPengelolaan

void DestroyLoggingManagement(
  void
)

Lakukan tindakan yang diperlukan untuk menonaktifkan.

GetInstance

LoggingManagement & GetInstance(
  void
)

nl::Weave::Profil::DataManagement_Current::LoggingManagement

Ringkasan

Konstruktor dan Destruktor

Fungsi publik

Fungsi statis publik

Fungsi publik

BlitEvent

Membatalkan Penonaktifan

Check shouldRunWDM

FetchEventsSince

GetBytesWritten

GetEventReader

ID GetFirstEventID

ID LastEventID

IsShutdownInProgress

Valid

PeristiwaPemuatan

PeristiwaLog

Pengelolaan Logging

Pengelolaan Logging

MarkShutdownDalam Proses

NotifyEventsTerkirim

RegisterEventCallbackForImportant

RegisterEventCallbackForImportant

RegisterEventCallbackForImportant

MenjadwalkanFlushIfNeeded

Serialisasi

SetBDXUploader

SetExchangeManager

SetLoggingEndpoint

SkipEvent

Penjepit ThrottleLogger

UnregisterEventCallbackForTingkat Penting

Pembatalan Pencatatan Log

Fungsi statis publik

CreateLoggingManagement

MenghancurkanPengelolaan

GetInstance