nl::Weave::الملفات الشخصية::DataManagement_Current::SubscriptionsEngine

#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(*
اضبط وظيفة الرجوع عن الحدث والمؤشر على كائن الحالة المرتبط باستدعاءات ConnectionEngine المحدّدة.
EventID تعداد
الأحداث التي تم إنشاؤها مباشرةً من هذا المكوّن.

الدوال الثابتة العامة
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
هذا هو معالج الأحداث التلقائي الذي يتم طلبه بواسطة طبقة التطبيق لأي حدث تم تجاهله أو لم يتم التعرّف عليه.
GetInstance(void)
استعرِك محرك اشتراك Singleton.

وظائف عامة
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
اضبط وظيفة الرجوع عن الحدث والمؤشر على كائن الحالة المرتبط باستدعاءات ConnectionEngine المحدّدة.

الاتحادات
nl::Weave::الملفات الشخصية::DataManagement_Current::SUBSCRIPTIONEngine::InEventParam

المعلّمات الواردة التي تم إرسالها مع الأحداث التي تم إنشاؤها مباشرةً من هذا المكوّن.

nl::Weave::الملفات الشخصية::DataManagement_Current::SubscriptionsEngine::OutEventParam

المَعلمات الصادرة التي تم إرسالها مع الأحداث التي تم إنشاؤها مباشرةً من هذا المكوِّن.

الأنواع المتاحة للجميع

معاودة الاتصال بالحدث

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

اضبط وظيفة الرجوع عن الحدث والمؤشر على كائن الحالة المرتبط باستدعاءات ConnectionEngine المحدّدة.

التفاصيل
المعلَمات
[in] aAppState
مؤشر إلى طبقة التطبيق التي تقدم كائن الحالة
[in] aEvent
مؤشر دالة لاستدعاء الحدث
[in] aInParam
مرجع ثابت لمعلمة الإدخال لهذا الحدث
[out] aOutParam
مرجع إلى معلّمة الناتج لهذا الحدث

رقم تعريف الحدث

 EventID

الأحداث التي تم إنشاؤها مباشرةً من هذا المكوّن.

الدوال الثابتة العامة

مؤشر الحدث التلقائي

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

هذا هو معالج الأحداث التلقائي الذي يتم طلبه بواسطة طبقة التطبيق لأي حدث تم تجاهله أو لم يتم التعرّف عليه.

التفاصيل
المعلَمات
[in] aEvent
مؤشر دالة لاستدعاء الحدث
[in] aInParam
مرجع ثابت لمعلمة الإدخال لهذا الحدث
[out] aOutParam
مرجع إلى معلّمة الناتج لهذا الحدث

الحصول على مثيل

SubscriptionEngine * GetInstance(
  void
)

استعرِك محرك اشتراك Singleton.

تجدر الإشارة إلى أنه يجب تنفيذ هذه الدالة بواسطة طبقة الاعتماد.

التفاصيل
المرتجعات
مؤشر إلى محرك الاشتراك المشترك

وظائف عامة

الحصول على مدير Exchange

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

GetMinEventLogالموضع

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
)

ضبط CallEvent

void SetEventCallback(
  void *const aAppState,
  const EventCallback aEventCallback
)

اضبط وظيفة الرجوع عن الحدث والمؤشر على كائن الحالة المرتبط باستدعاءات ConnectionEngine المحدّدة.

التفاصيل
المعلَمات
[in] aAppState
مؤشر إلى طبقة التطبيق التي تقدم كائن الحالة
[in] aEventCallback
مؤشر دالة لاستدعاء الحدث

محرك البحث

 SubscriptionEngine(
  void
)