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

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

מדובר ב-Singleton שמארח את כל המינויים ל-WDM Next, הן מצד הלקוח והן מצד בעלי האתרים.

סיכום

בונים והורסים
SubscriptionEngine(void)

סוגים ציבוריים
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
מגדירים את פונקציית 'הקודם' באירוע ואת המצביע על אובייקט מצב משויך עבור שיחות חוזרות ספציפיות ל-SubscriptionEngine.
EventID טיפוסים בני מנייה (enum)
אירועים שנוצרו ישירות מהרכיב הזה.

פונקציות סטטיות ציבוריות
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
זהו ה-handler שמוגדר כברירת מחדל לאירועים ששכבת האפליקציה מפעילה אותו עבור כל אירוע לא מזוהה או התעלמות ממנו.
GetInstance(void)
מאחזרים את מנוע המינויים של singleton.

תפקידים ציבוריים
GetExchangeManager(void) const
GetMinEventLogPosition(size_t & outLogPosition) const
אחזור המיקום היחסי המינימלי של נקודת המסירה של האירוע מכל רכיבי ה-handler הפעילים של המינויים.
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
מצביע של פונקציה ל-callback
[in] aInParam
הפניה קבועה לפרמטר הקלט עבור האירוע הזה
[out] aOutParam
הפניה לפרמטר הפלט של האירוע הזה

EventID

 EventID

אירועים שנוצרו ישירות מהרכיב הזה.

פונקציות סטטיות ציבוריות

DefaultEventHandler

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

זהו ה-handler שמוגדר כברירת מחדל לאירועים ששכבת האפליקציה מפעילה אותו עבור כל אירוע לא מזוהה או התעלמות ממנו.

פרטים
פרמטרים
[in] aEvent
מצביע של פונקציה ל-callback
[in] aInParam
הפניה קבועה לפרמטר הקלט עבור האירוע הזה
[out] aOutParam
הפניה לפרמטר הפלט של האירוע הזה

GetInstance

SubscriptionEngine * GetInstance(
  void
)

מאחזרים את מנוע המינויים של singleton.

הערה: צריך להטמיע את הפונקציה הזו באמצעות שכבת ההטמעה.

פרטים
החזרות
הפניה למנוע המינויים המשותף

תפקידים ציבוריים

GetExchangeManager

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

GetMinEventLogPosition

WEAVE_ERROR GetMinEventLogPosition(
  size_t & outLogPosition
) const

אחזור המיקום היחסי המינימלי של נקודת המסירה של האירוע מכל רכיבי ה-handler הפעילים של המינויים.

שולפת את המיקום היחסי המינימלי (לזמן האתחול) של נקודת ההעברה (offload) של האירוע מכל רכיבי ה-handler הפעילים של המינויים.

פרטים
פרמטרים
[in,out] outLogPosition
נקודת ההורדה המינימלית של היומן לכל גורמי ה-handler הפעילים של המינויים. אם אין גורמי handler פעילים של מינויים, הערך לא ישתנה. מיקום היומן מוגדר ל-0 בעת אתחול ה-handler של המינוי.
ערכים מוחזרים
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
מצביע של פונקציה ל-callback

SubscriptionEngine

 SubscriptionEngine(
  void
)