nl:: بافت:: پروفایل ها:: DataManagement_Current:: موتور اشتراک

#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 enum
رویدادهایی که مستقیماً از این مؤلفه ایجاد می شوند.

توابع استاتیک عمومی

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:: بافت:: پروفایل ها:: DataManagement_Current:: SubscriptionEngine:: InEventParam

پارامترهای ورودی با رویدادهایی که مستقیماً از این مؤلفه تولید می شوند ارسال می شوند.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: SubscriptionEngine:: OutEventParam

پارامترهای خروجی با رویدادهایی که مستقیماً از این مؤلفه تولید می شوند ارسال می شوند.

انواع عمومی

رویداد Callback

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

تابع و اشاره گر رویداد بازگشت را روی شیء وضعیت مرتبط برای تماس های خاص SubscriptionEngine تنظیم کنید.

جزئیات
مولفه های
[in] aAppState
یک اشاره گر به لایه برنامه که شیء حالت ارائه شده است
[in] aEvent
یک نشانگر تابع برای تماس مجدد رویداد
[in] aInParam
یک مرجع const به پارامتر ورودی برای این رویداد
[out] aOutParam
ارجاع به پارامتر خروجی برای این رویداد

شناسه رویداد

 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
بدون قید و شرط

شروع کنید

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(
  void
)