nl::Weave::Profiles::DataManagement_Current::SUBSCRIPTIONHandler

สรุป

ประเภทสาธารณะ
@142 enum
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) Typedef
void(*
EventID enum
HandlerId Typedef
uint8_t

ฟังก์ชันสาธารณะแบบคงที่
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void

ฟังก์ชันสาธารณะ
AbortSubscription(void)
void
ฟังก์ชันนี้จะยุติการสมัครใช้บริการทันที ซึ่งเป็นการโทรพร้อมกัน
AcceptSubscribeRequest(const uint32_t aLivenessTimeoutSec)
EndSubscription(const uint32_t aReasonProfileId, const uint16_t aReasonStatusCode)
ฟังก์ชันนี้จะเริ่มต้นการสมัครใช้บริการอย่างราบรื่นและการทําความสะอาดออบเจ็กต์ของเครื่องจัดการ
GetBinding(void) const
GetMaxNotificationSize(void) const
uint32_t
GetPeerNodeId(void) const
uint64_t
GetSubscriptionId(uint64_t *const apSubscriptionId)
IsActive(void)
bool
IsCanceling() const
bool
IsEstablishedIdle()
bool
IsFree()
bool
IsTerminated()
bool
SetMaxNotificationSize(const uint32_t aMaxPayload)
void

โครงสร้าง
nl::Weave::Profiles::DataManagement_Current::SUBSCRIPTIONHandler::TraitInstanceInfo

สหภาพ
nl::Weave::Profiles::DataManagement_Current::SUBSCRIPTIONHandler::InEventParam
nl::Weave::Profiles::DataManagement_Current::SUBSCRIPTIONHandler::OutEventParam

ประเภทสาธารณะ

142

 @142

เรียกกลับเหตุการณ์

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

รหัสกิจกรรม

 EventID

เครื่องจัดการ

uint8_t HandlerId

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

เครื่องจัดการเหตุการณ์เริ่มต้น

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

ฟังก์ชันสาธารณะ

ล้มเลิกการสมัครใช้บริการ

void AbortSubscription(
  void
)

ฟังก์ชันนี้จะยุติการสมัครใช้บริการทันที ซึ่งเป็นการโทรพร้อมกัน

ล้มเลิกการสมัครใช้บริการของผู้เผยแพร่โฆษณา

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

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

เมื่อเรียกใช้ Abortsubscriptions() ออบเจ็กต์ SubscriptionHandler จะเข้าสู่สถานะ Terminated หากไม่มีการอ้างอิงเพิ่มเติมกับออบเจ็กต์เมื่อกระบวนการยุติเสร็จสมบูรณ์แล้ว ออบเจ็กต์ SubscriptionHandler จะใช้งานไม่ได้

ยอมรับคําขอสมัครใช้บริการ

WEAVE_ERROR AcceptSubscribeRequest(
  const uint32_t aLivenessTimeoutSec
)

สิ้นสุดการสมัครใช้บริการ

WEAVE_ERROR EndSubscription(
  const uint32_t aReasonProfileId,
  const uint16_t aReasonStatusCode
)

ฟังก์ชันนี้จะเริ่มต้นการสมัครใช้บริการอย่างราบรื่นและการทําความสะอาดออบเจ็กต์ของเครื่องจัดการ

สิ้นสุดการสมัครใช้บริการของผู้เผยแพร่โฆษณาอย่างราบรื่น

การดําเนินการนี้เป็นการเรียกแบบไม่พร้อมกันและจะแจ้งให้ไคลเอ็นต์ทราบถึงการปิดตัวที่กําลังรอดําเนินการผ่านข้อความสมัครยกเลิก/สถานะรายงานหากเกี่ยวข้อง

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

ค่อยๆ ยุติการสมัครใช้บริการของผู้เผยแพร่เนื้อหา หากเปิดใช้การสนับสนุนการยกเลิกการสมัครใช้บริการ ระบบจะส่งข้อความสมัครใช้บริการการยกเลิกการสมัครใช้บริการไปยังไคลเอ็นต์การสมัครใช้บริการ และระบบจะรอการตอบกลับก่อนที่จะสิ้นสุดการสมัครใช้บริการ มิเช่นนั้น การสมัครใช้บริการจะสิ้นสุดทันทีในลักษณะเดียวกับ Abortsubscriptions() หากมีการสมัครใช้บริการร่วมกัน ระบบจะยุติการสมัครใช้บริการจากผู้เผยแพร่โฆษณากลับไปยังไคลเอ็นต์ด้วย

รายละเอียด
พารามิเตอร์
[in] aReasonProfileId
รหัสของ StatusCode ที่ระบุเหตุผลของการสิ้นสุด
[in] aReasonStatusCode
StatusCode ที่ระบุเหตุผลของการสิ้นสุด
แสดงผลค่า
Returns
รหัสข้อผิดพลาด Weave เพื่อจุดประสงค์เพื่อให้ข้อมูลเท่านั้น หากมีข้อผิดพลาดเกิดขึ้น ออบเจ็กต์นั้นจะสิ้นสุดพร้อมกัน (เช่น ล้มเลิก)

ขณะรอการตอบกลับของการยกเลิกการสมัครใช้บริการ SubscriptionHandler จะเข้าสู่สถานะ Canceling

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

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

ดาวน์โหลด Get-inding

Binding * GetBinding(
  void
) const

ขนาดการแจ้งเตือนสูงสุด

uint32_t GetMaxNotificationSize(
  void
) const

GetPeerNodeId

uint64_t GetPeerNodeId(
  void
) const

รับรหัสการสมัครรับข้อมูล

WEAVE_ERROR GetSubscriptionId(
  uint64_t *const apSubscriptionId
)

IsActive

bool IsActive(
  void
)

กําลังยกเลิก

bool IsCanceling() const

เป็นที่ยอมรับ

bool IsEstablishedIdle()

ฟรี

bool IsFree()

สิ้นสุด

bool IsTerminated()

ตั้งค่าขนาดการแจ้งเตือนสูงสุด

void SetMaxNotificationSize(
  const uint32_t aMaxPayload
)