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

#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
यह फ़ंक्शन दिखाता है, ताकि WeaveHeartbeatSender में इवेंट या बदलाव लागू होने की सूचना दी जा सके.
GetRequestAck() const
bool
यह फ़्लैग करने वाला फ़्लैग बताता है कि Weave Trusted Messages का इस्तेमाल करके, हार्टबीट मैसेज सही तरीके से भेजे जाएंगे या नहीं.
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
इस नीति से यह फ़ंक्शन सेट किया जाता है, जिसे WeaveHeartbeatSender में होने वाले इवेंट या बदलावों की सूचना देने के लिए कॉल किया जाता है.
SetRequestAck(bool val)
void
यह फ़्लैग सेट करता है कि Weave Trusted Messages का इस्तेमाल करके, हार्टबीट मैसेज सही तरीके से भेजे जाने चाहिए या नहीं.
SetSubscriptionState(uint8_t val)
void
सदस्यता की मौजूदा स्थिति सेट करना.
Shutdown(void)
वीव हार्टबीट भेजने वाले व्यक्ति को बंद करें.
StartHeartbeat(void)
Weave दिल की धड़कन से जुड़े मैसेज भेजना शुरू करें.
StopHeartbeat(void)
Weave Heartबीट मैसेज भेजना बंद करें.

सार्वजनिक स्टैटिक फ़ंक्शन
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 Messages का इस्तेमाल करके, हार्टबीट मैसेज सही तरीके से भेजे जाएंगे या नहीं.

GetSubscriptionState

uint8_t GetSubscriptionState() const

सदस्यता की मौजूदा स्थिति का पता लगाएं.

Init

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

वीव हार्टबीट भेजने वाले की शुरुआत करें.

जानकारी
पैरामीटर
[in] exchangeMgr
सिस्टम Weave Exchange Manager का पॉइंटर.
[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 दिल की धड़कन मैसेज भेजें.

जानकारी
रिटर्न वैल्यू
WEAVE_ERROR_INCORRECT_STATE
अगर WeaveHeartbeatSender शुरू नहीं किया गया है, तो
WEAVE_NO_ERROR
सफलता मिलने पर

SetConfiguration

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

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

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

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

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

SetRequestAck

void SetRequestAck(
  bool val
)

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

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

जानकारी
पैरामीटर
[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 Heartबीट मैसेज भेजना बंद करें.

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

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

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

DefaultEventHandler

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

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

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