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

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

这是一个单例，用于托管客户端和发布商方的所有 WDM Next 订阅。

摘要

构造函数和析构函数
SubscriptionEngine(void)

公共类型
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
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

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

公共类型

EventCallback

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

将事件返回函数和指针设置为特定于 SubscriptionEngine 回调的关联状态对象。

详细信息
参数
[in] aAppState
指向应用层提供的状态对象的指针
[in] aEvent
事件回调的函数指针
[in] aInParam
对此事件的输入参数的常量引用
[out] aOutParam
对此事件的输出参数的引用

EventID

 EventID

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

公共静态函数

DefaultEventHandler

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
无条件地

Init

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

 SubscriptionEngine(
  void
)