nl:: بافت:: پروفایل ها:: ضربان قلب:: WeaveHeartbeatSender

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

کلاس فرستنده ضربان قلب بافت.

خلاصه

سازندگان و تخریب کنندگان

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
}		 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 به طور قابل اعتماد ارسال می‌شوند یا خیر.
GetSubscriptionState () const
uint8_t
مقدار وضعیت اشتراک فعلی را دریافت کنید.
Init ( WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
فرستنده ضربان قلب بافت را راه اندازی کنید.
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)
فرستنده ضربان قلب بافت را خاموش کنید.
StartHeartbeat (void)
شروع به ارسال پیام های Weave Heartbeat کنید.
StopHeartbeat (void)
ارسال پیام های Weave Heartbeat را متوقف کنید.

توابع استاتیک عمومی

DefaultEventHandler (void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
void
عملکرد کنترل کننده پیش فرض برای رویدادهای WeaveHeartbeatSender API.

سازه ها

nl:: بافت:: پروفایل:: ضربان قلب:: WeaveHeartbeat فرستنده:: InEventParam

پارامترهای ورودی به رویداد WeaveHeartbeatSender API.

nl:: Weave:: پروفایل ها:: Heartbeat:: WeaveHeartbeatSender:: OutEventParam

پارامترهای خروجی به رویداد WeaveHeartbeatSender API.

انواع عمومی

رویداد Callback 

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

نوع رویداد 

 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
)

فرستنده ضربان قلب بافت را راه اندازی کنید.

جزئیات
پارامترها
[in] exchangeMgr
اشاره گر به سیستم Weave Exchange Manager.
[in] binding
یک اشاره گر به یک شیء اتصال Weave که برای آدرس دادن به گره همتا استفاده می شود.
[in] eventCallback
اشاره گر به تابعی که برای اطلاع از اعمال رویدادها یا تغییرات حالتی که در فرستنده رخ می دهد فراخوانی می شود.
[in] appState
اشاره گر به داده های خاص برنامه. این اشاره گر در تماس های برگشتی به برنامه برگردانده می شود.
ارزش های بازگشتی
WEAVE_ERROR_INCORRECT_STATE
اگر شی WeaveHeartbeatSender قبلاً مقداردهی شده باشد.
WEAVE_ERROR_INVALID_ARGUMENT
اگر هر یک از آرگومان های ارائه شده تهی باشد.
WEAVE_NO_ERROR
در مورد موفقیت

ضربان قلب را برنامه ریزی کنید 

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
فاصله زمانی برای ارسال پیام‌های Weave Heartbeat .
[in] phase
مرحله ای برای استفاده هنگام ارسال پیام های Weave Heartbeat .
[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_NO_ERROR
در مورد موفقیت

شروع ضربان قلب 

WEAVE_ERROR StartHeartbeat(
  void
)

شروع به ارسال پیام های Weave Heartbeat کنید.

جزئیات
ارزش های بازگشتی
INET_ERROR_NO_MEMORY
اگر StartTimer() شکست خورد
WEAVE_NO_ERROR
در مورد موفقیت

ضربان قلب را متوقف کنید 

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 API.

برنامه‌ها باید این تابع را برای هر رویداد API که مدیریت نمی‌کنند فراخوانی کنند.