nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender

#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>

वीव हार्टबीट भेजने वाले की क्लास.

खास जानकारी

कंस्ट्रक्टर और डिस्ट्रक्टर
WeaveHeartbeatSender(void)

सार्वजनिक टाइप
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) typedef
void(*
EventType{
  kEvent_UpdateSubscriptionState = 1,
  kEvent_HeartbeatSent = 2,
  kEvent_HeartbeatFailed = 3,
  kEvent_DefaultCheck = 100
} 		enum

सार्वजनिक एट्रिब्यूट
AppState
void *

सार्वजनिक फ़ंक्शन
GetBinding() const
हार्टबीट भेजने वाले से जुड़ा बाइंडिंग ऑब्जेक्ट पाएं.
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
void
हार्टबीट के समय का कॉन्फ़िगरेशन पाएं.
GetEventCallback() const
EventCallback
वह फ़ंक्शन देता है जिसे WeaveHeartbeatSender में होने वाले इवेंट या बदलावों के लागू होने की सूचना देने के लिए कॉल किया जाता है.
GetRequestAck() const
bool
यह बताने के लिए फ़्लैग देता है कि क्या हार्टबीट के मैसेज को Weave Trusted Stores का इस्तेमाल करके भरोसेमंद तरीके से भेजा जाएगा.
GetSubscriptionState() const
uint8_t
सदस्यता की मौजूदा स्थिति जानें.
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
वीव हार्टबीट सेंडर को शुरू करें.
ScheduleHeartbeat(void)
Weave की हार्टबीट वाले मैसेज भेजने का शेड्यूल तय करें.
SendHeartbeatNow(void)
अभी वीव हार्टबीट मैसेज भेजें.
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
void
हार्टबीट टाइम का कॉन्फ़िगरेशन सेट करें.
SetEventCallback(EventCallback eventCallback)
void
उस फ़ंक्शन को सेट करता है जिसे WeaveHeartbeatSender में होने वाले इवेंट या बदलावों के लागू होने के बारे में सूचना देने के लिए कॉल किया जाता है.
SetRequestAck(bool val)
void
यह बताने के लिए एक फ़्लैग सेट करता है कि Weave Trusted Stores का इस्तेमाल करके, भरोसेमंद तरीके से हार्टबीट मैसेज भेजे जाएं या नहीं.
SetSubscriptionState(uint8_t val)
void
सदस्यता की मौजूदा स्थिति सेट करें.
Shutdown(void)
वीव हार्टबीट सेंडर को बंद करो.
StartHeartbeat(void)
Weave हार्टबीट के मैसेज भेजना शुरू करें.
StopHeartbeat(void)
Weave की हार्टबीट वाले मैसेज भेजना बंद करें.

सार्वजनिक स्टैटिक फ़ंक्शन
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
void
WeaveHeartbeatSender एपीआई इवेंट के लिए, डिफ़ॉल्ट हैंडलर फ़ंक्शन.

संरचना
nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender::InEventParam

WeaveHeartbeatSender एपीआई इवेंट के लिए इनपुट पैरामीटर.

nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender::OutEventParam

WeaveHeartbeatSender एपीआई इवेंट के लिए आउटपुट पैरामीटर.

सार्वजनिक टाइप

EventCallback

void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)

EventType

 EventType
प्रॉपर्टी
kEvent_DefaultCheck

इसका इस्तेमाल, ऐप्लिकेशन में डिफ़ॉल्ट इवेंट हैंडलिंग के सही तरीके की पुष्टि करने के लिए किया जाता है.

ऐप्लिकेशन को इस इवेंट को साफ़ तौर पर हैंडल नहीं करना चाहिए.

kEvent_HeartbeatFailed

पीयर को हार्टबीट का मैसेज नहीं भेजा जा सका.

kEvent_HeartbeatSent

पीयर को हार्टबीट मैसेज भेज दिया गया.

अगर भरोसेमंद ट्रांसमिशन चालू है, तो यह इवेंट बताता है कि मैसेज को स्वीकार कर लिया गया था.

kEvent_UpdateSubscriptionState

ऐप्लिकेशन से, सदस्यता की स्थिति अपडेट करने का अनुरोध किया गया है.

सार्वजनिक एट्रिब्यूट

AppState

void * AppState

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

GetBinding

Binding * GetBinding() const

हार्टबीट भेजने वाले से जुड़ा बाइंडिंग ऑब्जेक्ट पाएं.

GetConfiguration

void GetConfiguration(
  uint32_t & interval,
  uint32_t & phase,
  uint32_t & window
) const

हार्टबीट के समय का कॉन्फ़िगरेशन पाएं.

ब्यौरा
पैरामीटर
[out] interval
हार्टबीट का अंतराल पाने के लिए किसी पूर्णांक का रेफ़रंस.
[out] phase
हार्टबीट की फ़ेज़ पाने के लिए किसी पूर्णांक का रेफ़रंस.
[out] window
हार्टबीट रैंडमाइज़ेशन विंडो पाने के लिए किसी पूर्णांक का रेफ़रंस.

GetEventCallback

EventCallback GetEventCallback() const

वह फ़ंक्शन देता है जिसे WeaveHeartbeatSender में होने वाले इवेंट या बदलावों के लागू होने की सूचना देने के लिए कॉल किया जाता है.

GetRequestAck

bool GetRequestAck() const

यह बताने के लिए फ़्लैग देता है कि क्या हार्टबीट के मैसेज को Weave Trusted Stores का इस्तेमाल करके भरोसेमंद तरीके से भेजा जाएगा.

GetSubscriptionState

uint8_t GetSubscriptionState() const

सदस्यता की मौजूदा स्थिति जानें.

शुरू करें

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr,
  Binding *binding,
  EventCallback eventCallback,
  void *appState
)

वीव हार्टबीट सेंडर को शुरू करें.

ब्यौरा
पैरामीटर
[in] exchangeMgr
Weave Exchange मैनेजर के लिए सिस्टम का पॉइंटर.
[in] binding
Weave बाइंडिंग ऑब्जेक्ट के लिए एक पॉइंटर, जिसका इस्तेमाल पीयर नोड को पता करने के लिए किया जाएगा.
[in] eventCallback
उस फ़ंक्शन का पॉइंटर जिसे करने वाले के इवेंट या उसकी स्थिति में होने वाले बदलावों के बारे में सूचना देने के लिए कॉल किया जाएगा.
[in] appState
ऐप्लिकेशन के हिसाब से डेटा के लिए पॉइंटर. यह पॉइंटर, ऐप्लिकेशन के कॉलबैक में दिखेगा.
रिटर्न वैल्यू
WEAVE_ERROR_INCORRECT_STATE
अगर WeaveHeartbeatSender ऑब्जेक्ट को पहले ही शुरू किया जा चुका है.
WEAVE_ERROR_INVALID_ARGUMENT
अगर दिया गया कोई भी तर्क शून्य है.
WEAVE_NO_ERROR
सफलता पर.

ScheduleHeartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Weave की हार्टबीट वाले मैसेज भेजने का शेड्यूल तय करें.

ब्यौरा
रिटर्न वैल्यू
WEAVE_SYSTEM_ERROR_NO_MEMORY
अगर StartTimer() पूरे नहीं हो पाते
WEAVE_NO_ERROR
सफलता पर

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

अभी वीव हार्टबीट मैसेज भेजें.

ब्यौरा
रिटर्न वैल्यू
WEAVE_ERROR_INCORRECT_STATE
अगर WeaveHeartbeatSender को चालू नहीं किया गया हो
WEAVE_NO_ERROR
सफलता पर

SetConfiguration

void SetConfiguration(
  uint32_t interval,
  uint32_t phase,
  uint32_t window
)

हार्टबीट टाइम का कॉन्फ़िगरेशन सेट करें.

ब्यौरा
पैरामीटर
[in] interval
Weave Heartbeat मैसेज भेजते समय इस्तेमाल किया जाने वाला इंटरवल.
[in] phase
Weave हार्टबीट मैसेज भेजते समय इस्तेमाल करने का चरण.
[in] window
रैंडम इंटरवल चुनने के लिए इस्तेमाल की जाने वाली विंडो रेंज

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

उस फ़ंक्शन को सेट करता है जिसे WeaveHeartbeatSender में होने वाले इवेंट या बदलावों के लागू होने के बारे में सूचना देने के लिए कॉल किया जाता है.

SetRequestAck

void SetRequestAck(
  bool val
)

यह बताने के लिए एक फ़्लैग सेट करता है कि Weave Trusted Stores का इस्तेमाल करके, भरोसेमंद तरीके से हार्टबीट मैसेज भेजे जाएं या नहीं.

ध्यान दें कि यह फ़्लैग सिर्फ़ तब इस्तेमाल किया जा सकता है, जब यूडीपी का इस्तेमाल परिवहन के तौर पर किया जा रहा हो.

ब्यौरा
पैरामीटर
[in] val
अगर हार्टबीट के मैसेज भरोसेमंद तरीके से भेजे जाने चाहिए, तो वैल्यू 'सही' होगी.

SetSubscriptionState

void SetSubscriptionState(
  uint8_t val
)

सदस्यता की मौजूदा स्थिति सेट करें.

ब्यौरा
पैरामीटर
[in] val
8-बिट की सदस्यता की स्थिति की वैल्यू, जिसे हार्टबीट के मैसेज से बताया जाना है.

बंद है

WEAVE_ERROR Shutdown(
  void
)

वीव हार्टबीट सेंडर को बंद करो.

ब्यौरा
रिटर्न वैल्यू
WEAVE_NO_ERROR
सफलता पर.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Weave हार्टबीट के मैसेज भेजना शुरू करें.

ब्यौरा
रिटर्न वैल्यू
INET_ERROR_NO_MEMORY
अगर StartTimer() पूरे नहीं हो पाते
WEAVE_NO_ERROR
सफलता पर

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Weave की हार्टबीट वाले मैसेज भेजना बंद करें.

ब्यौरा
रिटर्न वैल्यू
WEAVE_NO_ERROR
बिना शर्त के

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

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

DefaultEventHandler

void DefaultEventHandler(
  void *appState,
  EventType eventType,
  const InEventParam & inParam,
  OutEventParam & outParam
)

WeaveHeartbeatSender एपीआई इवेंट के लिए, डिफ़ॉल्ट हैंडलर फ़ंक्शन.

ऐप्लिकेशन को ऐसे किसी भी एपीआई इवेंट के लिए यह फ़ंक्शन कॉल करना होगा जिसका वे इस्तेमाल नहीं करते.