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

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

Dies ist ein Singleton, auf dem alle WDM Next-Abos gehostet werden, sowohl auf Client- als auch auf Publisher-Seite.

Zusammenfassung

Konstruktoren und Zerstörer
SubscriptionEngine(void)

Öffentliche Typen
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
Setze die Ereignisfunktion und den Zeiger auf das zugehörige Statusobjekt für SubscriptionEngine-spezifische Rückrufe.
EventID enum
Direkt aus dieser Komponente generierte Ereignisse.

Öffentliche statische Funktionen
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
Dies ist der standardmäßige Ereignis-Handler, der von der Anwendungsebene für alle ignorierten oder nicht erkannten Ereignisse aufgerufen wird.
GetInstance(void)
Rufe die Singleton-Abo-Engine ab.

Öffentliche Funktionen
GetExchangeManager(void) const
GetMinEventLogPosition(size_t & outLogPosition) const
Ruft die minimale relative Position des Ereignisauslagerungspunkts von allen aktiven Abo-Handlern ab.
Init(nl::Weave::WeaveExchangeManager *const apExchangeMgr, void *const aAppState, const EventCallback aEventCallback)
SetEventCallback(void *const aAppState, const EventCallback aEventCallback)
void
Setze die Ereignisfunktion und den Zeiger auf das zugehörige Statusobjekt für SubscriptionEngine-spezifische Rückrufe.

Gewerkschaften
nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine::InEventParam

Eingehende Parameter, die mit Ereignissen gesendet werden, die direkt aus dieser Komponente generiert werden.

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

Ausgehende Parameter, die mit Ereignissen gesendet werden, die direkt von dieser Komponente generiert werden.

Öffentliche Typen

EventCallback

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

Setze die Ereignisfunktion und den Zeiger auf das zugehörige Statusobjekt für SubscriptionEngine-spezifische Rückrufe.

Details
Parameter
[in] aAppState
Ein Zeiger auf das von der Anwendungsebene bereitgestellte Zustandsobjekt
[in] aEvent
Funktionszeiger für den Ereignis-Callback
[in] aInParam
Ein const-Verweis auf den Eingabeparameter für dieses Ereignis
[out] aOutParam
Ein Verweis auf den Ausgabeparameter für dieses Ereignis

EventID

 EventID

Direkt aus dieser Komponente generierte Ereignisse.

Öffentliche statische Funktionen

DefaultEventHandler

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

Dies ist der standardmäßige Ereignis-Handler, der von der Anwendungsebene für alle ignorierten oder nicht erkannten Ereignisse aufgerufen wird.

Details
Parameter
[in] aEvent
Funktionszeiger für den Ereignis-Callback
[in] aInParam
Ein const-Verweis auf den Eingabeparameter für dieses Ereignis
[out] aOutParam
Ein Verweis auf den Ausgabeparameter für dieses Ereignis

GetInstance

SubscriptionEngine * GetInstance(
  void
)

Rufe die Singleton-Abo-Engine ab.

Diese Funktion sollte von der Adoptionsebene implementiert werden.

Details
Rückgabe
Ein Zeiger zur gemeinsamen Abo-Engine

Öffentliche Funktionen

GetExchangeManager

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

GetMinEventLogPosition

WEAVE_ERROR GetMinEventLogPosition(
  size_t & outLogPosition
) const

Ruft die minimale relative Position des Ereignisauslagerungspunkts von allen aktiven Abo-Handlern ab.

Ruft die relative Mindestposition (zur Bootzeit) des Ereignis-Auslagerungspunkts von allen aktiven Abo-Handlern ab.

Details
Parameter
[in,out] outLogPosition
Minimaler Logauslagerungspunkt für alle aktiven Abo-Handler. Wenn keine Abo-Handler aktiv sind, bleibt der Wert unverändert. Die Logposition wird bei der Initialisierung des Abo-Handlers auf 0 festgelegt.
Rückgabewerte
WEAVE_NO_ERROR
bedingungslos

Init

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

SetEventCallback

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

Setze die Ereignisfunktion und den Zeiger auf das zugehörige Statusobjekt für SubscriptionEngine-spezifische Rückrufe.

Details
Parameter
[in] aAppState
Ein Zeiger auf das von der Anwendungsebene bereitgestellte Zustandsobjekt
[in] aEventCallback
Funktionszeiger für den Ereignis-Callback

SubscriptionEngine

 SubscriptionEngine(
  void
)