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(*
מגדירים את פונקציית החזרה של האירוע ואת המצביע לאובייקט המצב המשויך עבור קריאה חוזרת (callback) ספציפי ל-SubscriptionEngine.
EventID טיפוסים בני מנייה (enum)
אירועים שנוצרו ישירות מהרכיב הזה.

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

פונקציות ציבוריות
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
מגדירים את פונקציית החזרה של האירוע ואת המצביע לאובייקט המצב המשויך עבור קריאה חוזרת (callback) ספציפי ל-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)

מגדירים את פונקציית החזרה של האירוע ואת המצביע לאובייקט המצב המשויך עבור קריאה חוזרת (callback) ספציפי ל-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
)

מאחזרים את singleton Subscription Engine.

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

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

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

GetExchangeManager

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

GetMinEventLogPosition

WEAVE_ERROR GetMinEventLogPosition(
  size_t & outLogPosition
) const

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

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

פרטים
פרמטרים
[in,out] outLogPosition
נקודת סיום מינימלית של עומס יומן עבור כל ה-handlers הפעילים של המינויים. אם אין רכיבי 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
)

מגדירים את פונקציית החזרה של האירוע ואת המצביע לאובייקט המצב המשויך עבור קריאה חוזרת (callback) ספציפי ל-SubscriptionEngine.

פרטים
פרמטרים
[in] aAppState
מצביע לאובייקט המצב שסופק של שכבת האפליקציה
[in] aEventCallback
מצביע של פונקציה להפעלה חוזרת של האירוע

SubscriptionEngine

 SubscriptionEngine(
  void
)