NL::编织：：简介::数据管理_当前::订阅引擎

#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 ::编织::概况:: DataManagement_Current :: SubscriptionEngine :: InEventParam

与直接从此组件生成的事件一起发送的传入参数。

NL ::编织::概况:: 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
对此事件的输出参数的引用

事件ID

 EventID

直接从此组件生成的事件。

公共静态函数

默认事件处理程序

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

这是应用程序层为任何被忽略或无法识别的事件调用的默认事件处理程序。

细节
参数
[in] aEvent
事件回调函数指针
[in] aInParam
对此事件的输入参数的常量引用
[out] aOutParam
对此事件的输出参数的引用

获取实例

SubscriptionEngine * GetInstance(
  void
)

检索单例订阅引擎。

注意这个功能应该由采用层来实现。

细节
退货
指向共享订阅引擎的指针

公共职能

获取交换管理器

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

获取最小事件日志位置

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
)

设置事件回调

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

设置事件回调函数指针，并为相关的状态对象SubscriptionEngine特定的回调。

细节
参数
[in] aAppState
指向应用层提供的状态对象的指针
[in] aEventCallback
事件回调函数指针

订阅引擎

 SubscriptionEngine(
  void
)