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
此事件輸入參數的 const 參照
[out] aOutParam
此事件輸出參數的參照

EventID

 EventID

直接從此元件產生的事件。

公開的靜態函式

DefaultEventHandler

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

這是針對任何已忽略或無法辨識的事件，應用程式層呼叫的預設事件處理常式。

詳細資料
參數
[in] aEvent
事件呼叫的函式指標
[in] aInParam
此事件輸入參數的 const 參照
[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
)