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
)