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 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
ตั้งค่าฟังก์ชันย้อนกลับของเหตุการณ์และตัวชี้ไปยังออบเจ็กต์สถานะที่เชื่อมโยงสำหรับการเรียกกลับที่เฉพาะเจาะจงของ 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
การอ้างอิง Const กับพารามิเตอร์อินพุตสำหรับเหตุการณ์นี้
[out] aOutParam
การอ้างอิงพารามิเตอร์เอาต์พุตสำหรับเหตุการณ์นี้

EventID

 EventID

เหตุการณ์ที่สร้างจากคอมโพเนนต์นี้โดยตรง

ฟังก์ชันแบบคงที่แบบสาธารณะ

DefaultEventHandler

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

นี่เป็นเครื่องจัดการเหตุการณ์เริ่มต้นที่จะเรียกโดยเลเยอร์ของแอปพลิเคชันสำหรับเหตุการณ์ที่ถูกละเว้นหรือไม่รู้จัก

รายละเอียด
พารามิเตอร์
[in] aEvent
ตัวชี้ฟังก์ชันสำหรับการเรียกกลับของเหตุการณ์
[in] aInParam
การอ้างอิง Const กับพารามิเตอร์อินพุตสำหรับเหตุการณ์นี้
[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
จุดลดภาระของบันทึกขั้นต่ำสำหรับเครื่องจัดการการสมัครใช้บริการทั้งหมดที่ใช้งานอยู่ หากไม่มีเครื่องจัดการการสมัครใช้บริการที่ใช้งานอยู่ ค่าจะยังคงเหมือนเดิม ตำแหน่งบันทึกจะตั้งเป็น 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
)