нл:: Переплетение:: Профили:: DataManagement_Current:: ПодпискаДвигатель

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

Это синглтон, в котором размещаются все подписки WDM Next, как на стороне клиента, так и на стороне издателя.

Краткое содержание

Конструкторы и деструкторы

SubscriptionEngine (void)

Публичные типы

EventCallback )(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) определение типа
void(*
Установите функцию возврата событий и указатель на связанный объект состояния для обратных вызовов, специфичных для SubscriptionEngine .
EventID перечисление
События, генерируемые непосредственно из этого компонента.

Публичные статические функции

DefaultEventHandler ( EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
Это обработчик событий по умолчанию, который вызывается на уровне приложения для любого игнорируемого или нераспознанного события.
GetInstance (void)
Получите механизм одноэлементной подписки.

Общественные функции

GetExchangeManager (void) const
GetMinEventLogPosition (size_t & outLogPosition) const
Получите минимальное относительное положение точки разгрузки событий от всех активных обработчиков подписки.
Init ( nl::Weave::WeaveExchangeManager *const apExchangeMgr, void *const aAppState, const EventCallback aEventCallback)
SetEventCallback (void *const aAppState, const EventCallback aEventCallback)
void
Установите функцию возврата событий и указатель на связанный объект состояния для обратных вызовов, специфичных для SubscriptionEngine .

Союзы

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

Входящие параметры, отправляемые с событиями, сгенерированными непосредственно из этого компонента.

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

Исходящие параметры, отправляемые с событиями, сгенерированными непосредственно из этого компонента.

Публичные типы

Обратный вызов события 

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

Установите функцию возврата событий и указатель на связанный объект состояния для обратных вызовов, специфичных для SubscriptionEngine .

Подробности
Параметры
[in] aAppState
Указатель на объект состояния, предоставляемый прикладным уровнем.
[in] aEvent
Указатель функции для обратного вызова события
[in] aInParam
Константная ссылка на входной параметр для этого события.
[out] aOutParam
Ссылка на выходной параметр для этого события

идентификатор события 

 EventID

События, генерируемые непосредственно из этого компонента.

Публичные статические функции

Обработчик событий по умолчанию 

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

Это обработчик событий по умолчанию, который вызывается на уровне приложения для любого игнорируемого или нераспознанного события.

Подробности
Параметры
[in] aEvent
Указатель функции для обратного вызова события
[in] aInParam
Константная ссылка на входной параметр для этого события.
[out] aOutParam
Ссылка на выходной параметр для этого события

GetInstance 

SubscriptionEngine * GetInstance(
  void
)

Получите механизм одноэлементной подписки.

Обратите внимание, что эта функция должна быть реализована на уровне принятия.

Подробности
Возврат
Указатель на общий механизм подписки.

Общественные функции

GetExchangeManager 

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

GetMinEventLogPosition 

WEAVE_ERROR GetMinEventLogPosition(
  size_t & outLogPosition
) const

Получите минимальное относительное положение точки разгрузки событий от всех активных обработчиков подписки.

Получает минимальную относительную (по отношению ко времени загрузки) позицию точки разгрузки событий от всех активных обработчиков подписки.

Подробности
Параметры
[in,out] outLogPosition
Минимальная точка разгрузки журнала для всех активных обработчиков подписки. Если ни один обработчик подписки не активен, значение остается неизменным. Позиция журнала устанавливается в 0 при инициализации обработчика подписки.
Возвращаемые значения
WEAVE_NO_ERROR
безоговорочно

Инициализировать 

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

SetEventCallback 

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

Установите функцию возврата событий и указатель на связанный объект состояния для обратных вызовов, специфичных для SubscriptionEngine .

Подробности
Параметры
[in] aAppState
Указатель на объект состояния, предоставляемый прикладным уровнем.
[in] aEventCallback
Указатель функции для обратного вызова события

ПодпискаДвигатель 

 SubscriptionEngine(
  void
)