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
مرجع ثابت لمَعلمة الإدخال لهذا الحدث
[out] aOutParam
مرجع إلى مَعلمة الإخراج لهذا الحدث

EventID

 EventID

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

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

DefaultEventHandler

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

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

التفاصيل
المَعلمات
[in] aEvent
مؤشر دالة لمعاودة الاتصال بالحدث
[in] aInParam
مرجع ثابت لمَعلمة الإدخال لهذا الحدث
[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

 SubscriptionEngine(
  void
)