nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine

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

Ini adalah singleton yang menghosting semua langganan WDM Next, baik dari sisi klien maupun penayang.

Ringkasan

Konstruktor dan Destruktor
SubscriptionEngine(void)

Jenis publik
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
Menetapkan fungsi dan pointer kembali pada peristiwa ke objek status terkait untuk panggilan balik khusus SubscriptionEngine.
EventID enum
Peristiwa yang dibuat langsung dari komponen ini.

Fungsi statis publik
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
Ini adalah pengendali peristiwa default yang akan dipanggil oleh lapisan aplikasi untuk setiap peristiwa yang diabaikan atau tidak dikenali.
GetInstance(void)
Mengambil Subscription Engine singleton.

Fungsi publik
GetExchangeManager(void) const
GetMinEventLogPosition(size_t & outLogPosition) const
Mengambil posisi relatif minimum titik offload peristiwa dari semua pengendali langganan yang aktif.
Init(nl::Weave::WeaveExchangeManager *const apExchangeMgr, void *const aAppState, const EventCallback aEventCallback)
SetEventCallback(void *const aAppState, const EventCallback aEventCallback)
void
Menetapkan fungsi dan pointer kembali pada peristiwa ke objek status terkait untuk panggilan balik khusus SubscriptionEngine.

Serikat
nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine::InEventParam

Parameter masuk yang dikirim dengan peristiwa yang dihasilkan langsung dari komponen ini.

nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine::OutEventParam

Parameter keluar yang dikirim dengan peristiwa yang dihasilkan langsung dari komponen ini.

Jenis publik

EventCallback

void(* EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)

Menetapkan fungsi dan pointer kembali pada peristiwa ke objek status terkait untuk panggilan balik khusus SubscriptionEngine.

Detail
Parameter
[in] aAppState
Pointer ke objek status yang disediakan lapisan aplikasi
[in] aEvent
Pointer fungsi untuk panggilan balik peristiwa
[in] aInParam
Referensi konstanta ke parameter input untuk peristiwa ini
[out] aOutParam
Referensi ke parameter output untuk peristiwa ini

EventID

 EventID

Peristiwa yang dibuat langsung dari komponen ini.

Fungsi statis publik

DefaultEventHandler

void DefaultEventHandler(
  EventID aEvent,
  const InEventParam & aInParam,
  OutEventParam & aOutParam
)

Ini adalah pengendali peristiwa default yang akan dipanggil oleh lapisan aplikasi untuk setiap peristiwa yang diabaikan atau tidak dikenali.

Detail
Parameter
[in] aEvent
Pointer fungsi untuk panggilan balik peristiwa
[in] aInParam
Referensi konstanta ke parameter input untuk peristiwa ini
[out] aOutParam
Referensi ke parameter output untuk peristiwa ini

GetInstance

SubscriptionEngine * GetInstance(
  void
)

Mengambil Subscription Engine singleton.

Perhatikan bahwa fungsi ini harus diimplementasikan oleh lapisan adopsi.

Detail
Hasil
Pointer ke Subscription Engine yang dibagikan

Fungsi publik

GetExchangeManager

nl::Weave::WeaveExchangeManager * GetExchangeManager(
  void
) const

GetMinEventLogPosition

WEAVE_ERROR GetMinEventLogPosition(
  size_t & outLogPosition
) const

Mengambil posisi relatif minimum titik offload peristiwa dari semua pengendali langganan yang aktif.

Mengambil posisi relatif minimum (terhadap waktu booting) titik pemindahan peristiwa dari semua pengendali langganan yang aktif.

Detail
Parameter
[in,out] outLogPosition
Titik diskon log minimum untuk semua pengendali langganan yang aktif. Jika tidak ada pengendali langganan yang aktif, nilai tetap tidak berubah. Posisi log disetel ke 0 setelah menginisialisasi pengendali langganan.
Nilai Pengembalian
WEAVE_NO_ERROR
tanpa syarat

Inisiasi

WEAVE_ERROR Init(
  nl::Weave::WeaveExchangeManager *const apExchangeMgr,
  void *const aAppState,
  const EventCallback aEventCallback
)

SetEventCallback

void SetEventCallback(
  void *const aAppState,
  const EventCallback aEventCallback
)

Menetapkan fungsi dan pointer kembali pada peristiwa ke objek status terkait untuk panggilan balik khusus SubscriptionEngine.

Detail
Parameter
[in] aAppState
Pointer ke objek status yang disediakan lapisan aplikasi
[in] aEventCallback
Pointer fungsi untuk panggilan balik peristiwa

SubscriptionEngine

 SubscriptionEngine(
  void
)