nl:: बुना::प्रोफ़ाइलें::हार्टबीट::WeaHearHeart BeatSender

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

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

खास जानकारी

कंस्ट्रक्टर और कंस्ट्रक्टर

WeaveHeartbeatSender(void)

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

EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) टाइपडेफ़
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
उस फ़ंक्शन को दिखाता है जिसे WeaveHeart BeatSender में होने वाले इवेंट या बदलावों के बारे में बताने के लिए कॉल किया जाएगा.
GetRequestAck() const
bool
यह बताने वाला फ़्लैग दिखाता है कि Weave Trusted Messaging का इस्तेमाल करके, हार्टबीट मैसेज भरोसेमंद तरीके से भेजे जाएंगे या नहीं.
GetSubscriptionState() const
uint8_t
सदस्यता की मौजूदा स्थिति के बारे में जानें.
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
वीव हार्टबीट भेजने वाले की शुरुआत करें.
ScheduleHeartbeat(void)
Weave हार्टहार्ट मैसेज भेजना शेड्यूल करें.
SendHeartbeatNow(void)
Weave हार्टबीट मैसेज भेजें.
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
void
हार्टबीट के समय का कॉन्फ़िगरेशन सेट करें.
SetEventCallback(EventCallback eventCallback)
void
उस फ़ंक्शन को सेट करता है जिसे WeaveHeart BeatSender में होने वाले इवेंट या बदलावों के लागू होने पर सूचना देने के लिए कॉल किया जाएगा.
SetRequestAck(bool val)
void
यह तय करने वाले फ़्लैग सेट करता है कि Weave Trusted Messaging का इस्तेमाल करके, हार्टबीट मैसेज भरोसेमंद तरीके से भेजे जाने चाहिए या नहीं.
SetSubscriptionState(uint8_t val)
void
सदस्यता की मौजूदा स्थिति सेट करें.
Shutdown(void)
Weave हार्टहार्टबीट भेजने वाले को बंद करें.
StartHeartbeat(void)
Weave हार्टहार्ट मैसेज भेजना शुरू करें.
StopHeartbeat(void)
Weave हार्टबीट को मैसेज भेजना बंद करें.

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

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

स्ट्रक्चर

nl:: बुना::प्रोफ़ाइल::हार्टबीट::WeaHearHeart BeatSender::InEventParam

WeaveHeart BeatSender एपीआई इवेंट के लिए पैरामीटर डालें.

nl:: बुना::प्रोफ़ाइल::हार्टबीट::WeaHearHeart BeatSender::OutEventParam

WeaveHeart BeatSender एपीआई इवेंट के आउटपुट पैरामीटर.

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

इवेंट कॉलबैक

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

इवेंट टाइप

 EventType
प्रॉपर्टी
kEvent_DefaultCheck

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

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

kEvent_HeartbeatFailed

मिलते-जुलते ऐप्लिकेशन को हार्टबीट मैसेज नहीं भेजा जा सका.

kEvent_HeartbeatSent

पीयर को एक हार्टबीट संदेश सफलतापूर्वक भेजा गया था.

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

kEvent_UpdateSubscriptionState

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

सार्वजनिक विशेषताएं

AppState

void * AppState

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

गेटबाइंडिंग

Binding * GetBinding() const 

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

कॉन्फ़िगरेशन पाएं

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

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

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

GetEventCallback

EventCallback GetEventCallback() const 

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

GetRequestAck

bool GetRequestAck() const 

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

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
अगर WeaveHeartबीटSender ऑब्जेक्ट की शुरुआत पहले ही हो चुकी है.
WEAVE_ERROR_INVALID_ARGUMENT
अगर दिया गया कोई भी तर्क शून्य है.
WEAVE_NO_ERROR
सफल रहा.

शेड्यूल हार्टबीट

WEAVE_ERROR ScheduleHeartbeat(
  void
)

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

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

SendHeart BeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

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

ब्यौरा
सामान लौटाने की वैल्यू
WEAVE_ERROR_INCORRECT_STATE
अगर WeaveHeart BeatSender को शुरू नहीं किया गया है
WEAVE_NO_ERROR
सफल होने पर

सेट कॉन्फ़िगरेशन

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

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

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

setEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

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

सेट अनुरोध

void SetRequestAck(
  bool val
)

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

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

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

सेट सदस्यता की स्थिति

void SetSubscriptionState(
  uint8_t val
)

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

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

शटडाउन

WEAVE_ERROR Shutdown(
  void
)

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

ब्यौरा
सामान लौटाने की वैल्यू
WEAVE_NO_ERROR
सफल रहा.

स्टार्टहार्टबीट

WEAVE_ERROR StartHeartbeat(
  void
)

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

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

स्टॉपहार्टबीट

WEAVE_ERROR StopHeartbeat(
  void
)

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

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

WeaveHeart Beatsend

 WeaveHeartbeatSender(
  void
)

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

डिफ़ॉल्ट इवेंट हैंडलर

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

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

ऐप्लिकेशन को इस फ़ंक्शन को किसी भी ऐसे एपीआई इवेंट के लिए कॉल करना चाहिए जिसे वे हैंडल नहीं करते{0}.