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

EventCallback

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

EventID

 EventID

HandlerId

uint8_t HandlerId

सार्वजनिक स्टैटिक फ़ंक्शन

DefaultEventHandler

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

सार्वजनिक फ़ंक्शन

AbortSubscription

void AbortSubscription(
  void
)

यह फ़ंक्शन तुरंत किसी सदस्यता को खत्म कर देता है - यह एक सिंक्रोनस कॉल है.

पब्लिशर की सदस्यता को रद्द करना.

क्लाइंट को समझौता खत्म होने की सूचना देने की कोई कोशिश नहीं की गई है. साथ ही, अगर एक्सचेंज का संदर्भ दिया गया है, तो उसे तुरंत रद्द कर दिया जाता है. इस कॉल के बाद, ऐप्लिकेशन को इस ऑब्जेक्ट पर किसी और गतिविधि की सूचना नहीं दी जाएगी. इसके अलावा, ऐप्लिकेशन को बाद में इस ऑब्जेक्ट से इसके किसी भी तरीके से इंटरैक्ट करने की अनुमति नहीं है.

सदस्यता क्लाइंट को सूचना दिए बिना और ऐप्लिकेशन के इवेंट हैंडलर को OnSubscriptionTerminated इवेंट डिलीवर किए बिना, पब्लिशर को सदस्यता खत्म करने के लिए कहा जाता है. अगर आपसी सदस्यता मौजूद है, तो पब्लिशर से क्लाइंट को वापस मिली काउंटर सदस्यता भी खत्म कर दी जाती है.

AbortSubscription() को कॉल करने पर, SubscriptionHandler ऑब्जेक्ट, Terminated की स्थिति में जाता है. अगर खत्म करने की प्रोसेस पूरी होने पर ऑब्जेक्ट के लिए कोई और रेफ़रंस मौजूद नहीं है, तो SubscriptionHandler ऑब्जेक्ट फ़्री हो जाता है.

AcceptSubscribeRequest

WEAVE_ERROR AcceptSubscribeRequest(
  const uint32_t aLivenessTimeoutSec
)

EndSubscription

WEAVE_ERROR EndSubscription(
  const uint32_t aReasonProfileId,
  const uint16_t aReasonStatusCode
)

यह फ़ंक्शन, सदस्यता को बेहतर तरीके से बंद करने और हैंडलर ऑब्जेक्ट को हटाने की प्रोसेस शुरू करता है.

पब्लिशर की सदस्यता को अच्छी तरह खत्म करें.

यह एसिंक्रोनस कॉल है. जहां ज़रूरी हो, वहां SubscribeCancel/StatusReport के मैसेज के ज़रिए, क्लाइंट को आने वाले समय में बंद होने की सूचना दी जाएगी.

खास तौर पर, इससे इस सदस्यता में ऐप्लिकेशन की भागीदारी को खत्म किया जा सकता है. इस कॉल के बाद, ऐप्लिकेशन को इस ऑब्जेक्ट पर किसी और गतिविधि की सूचना नहीं दी जाएगी. इसके अलावा, ऐप्लिकेशन को बाद में इस ऑब्जेक्ट से इसके किसी भी तरीके से इंटरैक्ट करने की अनुमति नहीं है.

पब्लिशर की सदस्यता को खत्म कर देता है. अगर सदस्यता रद्द करने की सुविधा चालू है, तो सदस्यता क्लाइंट को SubscribeCancelRequest मैसेज भेजा जाता है और सदस्यता खत्म करने से पहले सिस्टम जवाब का इंतज़ार करता है. ऐसा न होने पर, AbortSubscription() की तरह सदस्यता तुरंत खत्म कर दी जाती है. अगर कोई म्युचुअल सदस्यता मौजूद है, तो पब्लिशर से क्लाइंट को वापस दी जाने वाली काउंटर सदस्यता भी खत्म कर दी जाती है.

जानकारी
पैरामीटर
[in] aReasonProfileId
बंद किए जाने की वजह बताने वाले StatusCode का ProfileId
[in] aReasonStatusCode
बंद किए जाने की वजह बताने वाला StatusCode
रिटर्न वैल्यू
Returns
सिर्फ़ जानकारी देने के मकसद से, Weave की गड़बड़ी वाला कोड सबमिट करें. किसी भी गड़बड़ी पर, ऑब्जेक्ट को सिंक्रोनस रूप से खत्म कर दिया जाएगा (यानी रद्द किया गया).

SubscribeCancelRequest के जवाब का इंतज़ार करते समय, SubscriptionHandler Canceling की स्थिति में आता है.

बंद करने की प्रोसेस शुरू होने के बाद, SubscriptionHandler ऑब्जेक्ट Terminated की स्थिति में आ जाता है और ऐप्लिकेशन के इवेंट हैंडलर को OnSubscriptionTerminated इवेंट डिलीवर किया जाता है. ध्यान दें कि अगर 'रद्द करें' सपोर्ट की सुविधा चालू नहीं है, तो इवेंट हैंडलर को EndSubscription() को कॉल करने के दौरान सिंक्रोनस रूप से कॉल किया जा सकता है.

ऐप्लिकेशन के इवेंट हैंडलर के वापस आने के बाद, अगर SubscriptionHandler ऑब्जेक्ट के लिए कोई दूसरा रेफ़रंस मौजूद नहीं है, तो ऑब्जेक्ट फ़्री हो जाता है.

GetBinding

Binding * GetBinding(
  void
) const

GetMaxNotificationSize

uint32_t GetMaxNotificationSize(
  void
) const

GetPeerNodeId

uint64_t GetPeerNodeId(
  void
) const

GetSubscriptionId

WEAVE_ERROR GetSubscriptionId(
  uint64_t *const apSubscriptionId
)

IsActive

bool IsActive(
  void
)

IsCanceling

bool IsCanceling() const

IsEstablishedIdle

bool IsEstablishedIdle()

IsFree

bool IsFree()

IsTerminated

bool IsTerminated()

SetMaxNotificationSize

void SetMaxNotificationSize(
  const uint32_t aMaxPayload
)