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

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

نسج فئة مرسلي Heartbeat.

ملخّص

الشركات المصنّعة والمُصنّعة
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
} 		تعداد

السمات العامة
AppState
void *

وظائف عامة
GetBinding() const
الحصول على كائن الربط المرتبط بمرسل نبضات القلب.
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
void
الحصول على إعدادات ضبط توقيت نبضات القلب
GetEventCallback() const
EventCallback
تعرض الدالة التي سيتم استدعاؤها لإشعار تطبيق الأحداث أو التغييرات التي تحدث في WeaveHeartbeatSender.
GetRequestAck() const
bool
عرض علامة تشير إلى ما إذا كان سيتم إرسال رسائل النبض القلبي بشكل موثوق باستخدام ميزة المراسلة الموثوق بها في Weave.
GetSubscriptionState() const
uint8_t
تعرَّف على قيمة حالة الاشتراك الحالية.
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
قم بتهيئة Weave Heartbeat المرسل.
ScheduleHeartbeat(void)
جدولة إرسال رسائل Weave Heartbeat.
SendHeartbeatNow(void)
أرسِل رسالة من Weave Heartbeat الآن.
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
void
ضبط ضبط توقيت ضربات القلب
SetEventCallback(EventCallback eventCallback)
void
تضبط هذه السياسة الدالة التي سيتم استدعاؤها لإشعار تطبيق الأحداث أو التغييرات التي تحدث في WeaveHeartbeatSender.
SetRequestAck(bool val)
void
لتعيين علامة تشير إلى ما إذا كان يجب إرسال رسائل النبض القلبي بشكل موثوق باستخدام ميزة المراسلة الموثوق بها في Weave.
SetSubscriptionState(uint8_t val)
void
ضبط حالة الاشتراك الحالية
Shutdown(void)
أوقِف مرسِل Weave.
StartHeartbeat(void)
ابدأ بإرسال رسائل Weave Heartbeat.
StopHeartbeat(void)
إيقاف إرسال رسائل Weave Heartbeat

الدوال الثابتة العامة
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.

GetSubscriptionState

uint8_t GetSubscriptionState() const

تعرَّف على قيمة حالة الاشتراك الحالية.

Init

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

قم بتهيئة Weave Heartbeat المرسل.

التفاصيل
المعلمات
[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 Heartbeat.

التفاصيل
قيم الإرجاع
WEAVE_SYSTEM_ERROR_NO_MEMORY
في حال فشل StartTimer()
WEAVE_NO_ERROR
حول النجاح

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

أرسِل رسالة من Weave Heartbeat الآن.

التفاصيل
قيم الإرجاع
WEAVE_ERROR_INCORRECT_STATE
في حال عدم إعداد WeaveHeartbeatSender
WEAVE_NO_ERROR
حول النجاح

SetConfiguration

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

ضبط ضبط توقيت ضربات القلب

التفاصيل
المعلمات
[in] interval
الفاصل الزمني المستخدم عند إرسال رسائل Heartbeat Weave.
[in] phase
المرحلة التي يتم استخدامها عند إرسال رسائل Heave.
[in] window
نطاق النافذة المراد استخدامه لاختيار الفاصل الزمني العشوائي

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

تضبط هذه السياسة الدالة التي سيتم استدعاؤها لإشعار تطبيق الأحداث أو التغييرات التي تحدث في WeaveHeartbeatSender.

SetRequestAck

void SetRequestAck(
  bool val
)

لتعيين علامة تشير إلى ما إذا كان يجب إرسال رسائل النبض القلبي بشكل موثوق باستخدام ميزة المراسلة الموثوق بها في Weave.

لاحظ أن هذه العلامة لا تكون ذات معنى إلا عند استخدام بروتوكول UDP كوسيلة نقل.

التفاصيل
المعلمات
[in] val
صحيح إذا كان ينبغي إرسال رسائل نبضات القلب بشكل موثوق.

SetSubscriptionState

void SetSubscriptionState(
  uint8_t val
)

ضبط حالة الاشتراك الحالية

التفاصيل
المعلمات
[in] val
قيمة حالة الاشتراك 8 بت التي سيتم نقلها مع رسالة الإشارات الدورية.

إيقاف التشغيل

WEAVE_ERROR Shutdown(
  void
)

أوقِف مرسِل Weave.

التفاصيل
قيم الإرجاع
WEAVE_NO_ERROR
عند النجاح.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

ابدأ بإرسال رسائل Weave Heartbeat.

التفاصيل
قيم الإرجاع
INET_ERROR_NO_MEMORY
في حال فشل StartTimer()
WEAVE_NO_ERROR
حول النجاح

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

إيقاف إرسال رسائل Weave Heartbeat

التفاصيل
قيم الإرجاع
WEAVE_NO_ERROR
بدون شرط

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

الدوال الثابتة العامة

DefaultEventHandler

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

وظيفة المعالِج التلقائي لأحداث واجهة برمجة التطبيقات WeaveHeartbeatSender.

يجب أن تستدعي التطبيقات هذه الدالة لأي أحداث واجهة برمجة تطبيقات لا تعالجها.