nl:: Weave:: الملفات الشخصية:: Hartbeat:: Weave Heartbeatsender
#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>
ارتحِل فئة المُرسِلين Hartbeat.
الملخّص
الماكينات والبناء |
|
---|---|
WeaveHeartbeatSender(void)
|
الأنواع المتاحة للجميع |
|
---|---|
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
|
typedefvoid(*
|
EventType{
|
تعداد |
السمات العامة |
|
---|---|
AppState
|
void *
|
وظائف عامة |
|
---|---|
GetBinding() const
|
Binding *
احصل على الكائن المُلزِم المرتبط بمُرسِل نبضات القلب.
|
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
|
void
ضبط إعدادات معدّل نبضات القلب
|
GetEventCallback() const
|
EventCallback
لعرض الدالة التي سيتم استدعاؤها لإشعار تطبيق الأحداث أو التغييرات التي تحدث في Weave Heartbeatsender.
|
GetRequestAck() const
|
bool
تعرض علامة تشير إلى ما إذا كان سيتم إرسال رسائل النبضات بشكل موثوق به باستخدام ميزة الرسائل الموثوق بها من Weave.
|
GetSubscriptionState() const
|
uint8_t
معرفة قيمة حالة الاشتراك الحالية.
|
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
|
ابدأ في إعداد تطبيق Weave Hartbeat.
|
ScheduleHeartbeat(void)
|
تحديد موعد لإرسال رسائل Weave Hartbeat
|
SendHeartbeatNow(void)
|
أرسِل رسالة من Weave Hartbeat الآن.
|
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
|
void
ضبط ضبط توقيت نبضات القلب
|
SetEventCallback(EventCallback eventCallback)
|
void
تضبط الدالة التي سيتم استدعاؤها لإشعار تطبيق الأحداث أو التغييرات التي تحدث في Weave Heartbeatsender.
|
SetRequestAck(bool val)
|
void
لضبط علامة تشير إلى ما إذا كان يجب إرسال رسائل النبضات بشكل موثوق به باستخدام ميزة الرسائل الموثوق بها من Weave.
|
SetSubscriptionState(uint8_t val)
|
void
حدِّد حالة الاشتراك الحالية.
|
Shutdown(void)
|
إيقاف تشغيل Weave Hartbeat sender.
|
StartHeartbeat(void)
|
ابدأ بإرسال رسائل Weave Hartbeat.
|
StopHeartbeat(void)
|
إيقاف إرسال رسائل Weave Hartbeat
|
الدوال الثابتة العامة |
|
---|---|
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
|
void
دالة المعالج التلقائي لأحداث واجهة برمجة تطبيقات WeaveHiartbeatsender.
|
الهياكل |
|
---|---|
nl:: |
إدخال معلَمات إلى حدث واجهة برمجة التطبيقات WeaveHiartbeatsender. |
nl:: |
مَعلمات الإخراج إلى حدث واجهة برمجة التطبيقات Weave Heartbeatsender. |
الأنواع المتاحة للجميع
معاودة الاتصال بالحدث
void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
نوع الحدث
EventType
أماكن إقامة | |
---|---|
kEvent_DefaultCheck
|
يُستخدم للتحقق من معالجة الحدث التلقائية بشكل صحيح في التطبيق. يجب ألا تتعامل التطبيقات صراحةً مع هذا الحدث. |
kEvent_HeartbeatFailed
|
تعذّر إرسال رسالة دورية إلى الأقران. |
kEvent_HeartbeatSent
|
تم إرسال رسالة نبضه إلى الزملاء. في حال تفعيل الإرسال الموثوق به، يشير هذا الحدث إلى أنه تم الإقرار بالرسالة. |
kEvent_UpdateSubscriptionState
|
تتم مطالبة التطبيق بتحديث حالة الاشتراك. |
السمات العامة
حالة التطبيق
void * AppState
وظائف عامة
الحصول على تجميع البيانات
Binding * GetBinding() const
احصل على الكائن المُلزِم المرتبط بمُرسِل نبضات القلب.
الحصول على الإعدادات
void GetConfiguration( uint32_t & interval, uint32_t & phase, uint32_t & window ) const
ضبط إعدادات معدّل نبضات القلب
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلَمات |
|
GetEventCallback
EventCallback GetEventCallback() const
لعرض الدالة التي سيتم استدعاؤها لإشعار تطبيق الأحداث أو التغييرات التي تحدث في Weave Heartbeatsender.
GetRequestAck
bool GetRequestAck() const
تعرض علامة تشير إلى ما إذا كان سيتم إرسال رسائل النبضات بشكل موثوق به باستخدام ميزة الرسائل الموثوق بها من Weave.
حالة الاشتراك
uint8_t GetSubscriptionState() const
معرفة قيمة حالة الاشتراك الحالية.
إنيت
WEAVE_ERROR Init( WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState )
ابدأ في إعداد تطبيق Weave Hartbeat.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||
قيم الإرجاع |
|
جدول نبضات القلب
WEAVE_ERROR ScheduleHeartbeat( void )
تحديد موعد لإرسال رسائل Weave Hartbeat
التفاصيل | |||||
---|---|---|---|---|---|
قيم الإرجاع |
|
إرسال تقييم HeartBeatNow
WEAVE_ERROR SendHeartbeatNow( void )
أرسِل رسالة من Weave Hartbeat الآن.
التفاصيل | |||||
---|---|---|---|---|---|
قيم الإرجاع |
|
الضبط
void SetConfiguration( uint32_t interval, uint32_t phase, uint32_t window )
ضبط CallEvent
void SetEventCallback( EventCallback eventCallback )
تضبط الدالة التي سيتم استدعاؤها لإشعار تطبيق الأحداث أو التغييرات التي تحدث في Weave Heartbeatsender.
ضبط طلب
void SetRequestAck( bool val )
لضبط علامة تشير إلى ما إذا كان يجب إرسال رسائل النبضات بشكل موثوق به باستخدام ميزة الرسائل الموثوق بها من Weave.
لاحظ أن هذه العلامة لا تكون ذات معنى إلا عند استخدام UDP كنقل.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
تحديد حالة الاشتراك
void SetSubscriptionState( uint8_t val )
حدِّد حالة الاشتراك الحالية.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
إيقاف التشغيل
WEAVE_ERROR Shutdown( void )
بداية حركة القلب
WEAVE_ERROR StartHeartbeat( void )
ابدأ بإرسال رسائل Weave Hartbeat.
التفاصيل | |||||
---|---|---|---|---|---|
قيم الإرجاع |
|
إيقاف القلب
WEAVE_ERROR StopHeartbeat( void )
WeaveHartbeatsender
WeaveHeartbeatSender( void )
الدوال الثابتة العامة
مؤشر الحدث التلقائي
void DefaultEventHandler( void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam )
دالة المعالج التلقائي لأحداث واجهة برمجة تطبيقات WeaveHiartbeatsender.
يجب أن تسمّي التطبيقات هذه الدالة لأي أحداث من واجهة برمجة التطبيقات لا تعالجها.