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

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

فئة مُرسِل الإيقاع القلبي من Weave

ملخّص

الدلالة والهياكل
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
} 		تعداد

السمات العامة
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.
ScheduleHeartbeat(void)
جدولة إرسال رسائل الإيقاع القلبي في Weave.
SendHeartbeatNow(void)
أرسل رسالة 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.
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 الموثوقة للمراسلة.

GetSubscriptionState

uint8_t GetSubscriptionState() const

احصل على قيمة حالة الاشتراك الحالية.

إنت

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

ابدأ إعداد مُرسِل الإيقاع القلبي في Weave.

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

أرسل رسالة Heartbeat الآن.

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

SetConfiguration

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

يمكنك ضبط إعدادات توقيت الإشارات الدورية.

التفاصيل
المَعلمات
[in] interval
الفاصل الزمني للاستخدام عند إرسال رسائل نبضات القلب ضمن Weave.
[in] phase
مرحلة الاستخدام عند إرسال رسائل Heartbeat ضمن Weave.
[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.

التفاصيل
قيم الإرجاع
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.

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