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
)