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

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

Jest to pojedynczy podmiot hostujący wszystkie subskrypcje WDM Next, zarówno po stronie klienta, jak i wydawcy.

Podsumowanie

Konstruktory i niszczyciele
SubscriptionEngine(void)

Typy publiczne
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
Ustaw funkcję cofnięcia zdarzenia i wskaźnik do powiązanego obiektu stanu dla określonych wywołań zwrotnych SubscriptionEngine.
EventID enum | typ wyliczeniowy
Zdarzenia generowane bezpośrednio z tego komponentu.

Publiczne funkcje statyczne
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
Jest to domyślny moduł obsługi zdarzeń wywoływany przez warstwę aplikacji w przypadku każdego ignorowanego lub nierozpoznanego zdarzenia.
GetInstance(void)
Pobierz mechanizm subskrypcji dla usługi singleton.

Funkcje publiczne
GetExchangeManager(void) const
GetMinEventLogPosition(size_t & outLogPosition) const
Pobierz minimalną pozycję punktu odciążania zdarzenia ze wszystkich aktywnych modułów obsługi subskrypcji.
Init(nl::Weave::WeaveExchangeManager *const apExchangeMgr, void *const aAppState, const EventCallback aEventCallback)
SetEventCallback(void *const aAppState, const EventCallback aEventCallback)
void
Ustaw funkcję cofnięcia zdarzenia i wskaźnik do powiązanego obiektu stanu dla określonych wywołań zwrotnych SubscriptionEngine.

Związki
nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine::InEventParam

Parametry przychodzące wysyłane ze zdarzeniami wygenerowanymi bezpośrednio na tym komponencie.

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

Parametry wychodzące wysyłane ze zdarzeniami wygenerowanymi bezpośrednio z tego komponentu.

Typy publiczne

EventCallback

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

Ustaw funkcję cofnięcia zdarzenia i wskaźnik do powiązanego obiektu stanu dla określonych wywołań zwrotnych SubscriptionEngine.

Szczegóły
Parametry
[in] aAppState
Wskaźnik do obiektu stanu dostarczonego w warstwie aplikacji
[in] aEvent
Wskaźnik funkcji wywołania zwrotnego zdarzenia
[in] aInParam
Stałe odniesienie do parametru wejściowego tego zdarzenia
[out] aOutParam
Odwołanie do parametru wyjściowego tego zdarzenia

EventID

 EventID

Zdarzenia generowane bezpośrednio na podstawie tego komponentu.

Publiczne funkcje statyczne

DefaultEventHandler

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

Jest to domyślny moduł obsługi zdarzeń wywoływany przez warstwę aplikacji w przypadku każdego ignorowanego lub nierozpoznanego zdarzenia.

Szczegóły
Parametry
[in] aEvent
Wskaźnik funkcji wywołania zwrotnego zdarzenia
[in] aInParam
Stałe odniesienie do parametru wejściowego tego zdarzenia
[out] aOutParam
Odwołanie do parametru wyjściowego tego zdarzenia

GetInstance

SubscriptionEngine * GetInstance(
  void
)

Pobierz mechanizm subskrypcji dla usługi singleton.

Pamiętaj, że funkcję tę należy zaimplementować w warstwie rozpowszechnienia.

Szczegóły
Zwroty
Wskaźnik do mechanizmu współdzielonych subskrypcji

Funkcje publiczne

GetExchangeManager

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

GetMinEventLogPosition

WEAVE_ERROR GetMinEventLogPosition(
  size_t & outLogPosition
) const

Pobierz minimalną pozycję punktu odciążania zdarzenia ze wszystkich aktywnych modułów obsługi subskrypcji.

Pobiera minimalną względną (w stosunku do czasu rozruchu) pozycję punktu odciążania zdarzenia ze wszystkich aktywnych modułów obsługi subskrypcji.

Szczegóły
Parametry
[in,out] outLogPosition
Minimalny punkt odciążania logów dla wszystkich aktywnych modułów obsługi subskrypcji. Jeśli żadne moduły obsługi subskrypcji nie są aktywne, wartość pozostaje niezmieniona. Pozycja logu jest ustawiana na 0 po zainicjowaniu modułu obsługi subskrypcji.
Zwracane wartości
WEAVE_NO_ERROR
bezwarunkowo

Rozpocznij

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

SetEventCallback

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

Ustaw funkcję cofnięcia zdarzenia i wskaźnik do powiązanego obiektu stanu dla określonych wywołań zwrotnych SubscriptionEngine.

Szczegóły
Parametry
[in] aAppState
Wskaźnik do obiektu stanu dostarczonego w warstwie aplikacji
[in] aEventCallback
Wskaźnik funkcji wywołania zwrotnego zdarzenia

SubscriptionEngine

 SubscriptionEngine(
  void
)