nl:: Weave:: Profiles:: Heartbeat:: WeaveHeartbeatSender
#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>
คลาส Weave Heartbeat Sender
สรุป
ผู้ผลิตและผู้ทำลาย |
|
---|---|
WeaveHeartbeatSender(void)
|
ประเภทสาธารณะ |
|
---|---|
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
|
typedefvoid(*
|
EventType{
|
enum |
แอตทริบิวต์สาธารณะ |
|
---|---|
AppState
|
void *
|
ฟังก์ชันสาธารณะ |
|
---|---|
GetBinding() const
|
Binding *
รับออบเจ็กต์การเชื่อมโยงที่เชื่อมโยงกับผู้ส่งฮาร์ตบีต
|
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
|
void
รับการกำหนดค่าเวลาฮาร์ตบีต
|
GetEventCallback() const
|
EventCallback
แสดงผลฟังก์ชันที่จะถูกเรียกเพื่อแจ้งการใช้เหตุการณ์หรือการเปลี่ยนแปลงที่เกิดขึ้นใน WeaveHeartbeatSender
|
GetRequestAck() const
|
bool
แสดงค่าสถานะที่ระบุว่าระบบจะส่งข้อความฮาร์ตบีตอย่างน่าเชื่อถือหรือไม่โดยใช้ Weave Reliable Messaging
|
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 Reliable Messaging
|
SetSubscriptionState(uint8_t val)
|
void
ตั้งค่าสถานะการสมัครใช้บริการปัจจุบัน
|
Shutdown(void)
|
ปิดตัวส่ง Weave Heartbeat
|
StartHeartbeat(void)
|
เริ่มส่งข้อความ Weave Heartbeat
|
StopHeartbeat(void)
|
หยุดส่งข้อความ Weave Heartbeat
|
ฟังก์ชันแบบคงที่แบบสาธารณะ |
|
---|---|
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
|
void
ฟังก์ชันตัวแฮนเดิลเริ่มต้นสำหรับเหตุการณ์ API WeaveHeartbeatSender
|
โครงสร้าง |
|
---|---|
nl:: |
ป้อนพารามิเตอร์ไปยังเหตุการณ์ API WeaveHeartbeatSender |
nl:: |
ส่งออกพารามิเตอร์ไปยังเหตุการณ์ API 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
ฟังก์ชันสาธารณะ
GetConfiguration
void GetConfiguration( uint32_t & interval, uint32_t & phase, uint32_t & window ) const
รับการกำหนดค่าเวลาฮาร์ตบีต
รายละเอียด | |||||||
---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
GetEventCallback
EventCallback GetEventCallback() const
แสดงผลฟังก์ชันที่จะถูกเรียกเพื่อแจ้งการใช้เหตุการณ์หรือการเปลี่ยนแปลงที่เกิดขึ้นใน WeaveHeartbeatSender
GetRequestAck
bool GetRequestAck() const
แสดงค่าสถานะที่ระบุว่าระบบจะส่งข้อความฮาร์ตบีตอย่างน่าเชื่อถือหรือไม่โดยใช้ Weave Reliable Messaging
GetSubscriptionState
uint8_t GetSubscriptionState() const
ดูค่าสถานะการสมัครใช้บริการปัจจุบัน
เริ่มต้น
WEAVE_ERROR Init( WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState )
เริ่มต้นผู้ส่ง Weave Heartbeat
รายละเอียด | |||||||||
---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||
แสดงผลค่า |
|
ScheduleHeartbeat
WEAVE_ERROR ScheduleHeartbeat( void )
กำหนดเวลาส่งข้อความ Weave Heartbeat
รายละเอียด | |||||
---|---|---|---|---|---|
แสดงผลค่า |
|
SendHeartbeatNow
WEAVE_ERROR SendHeartbeatNow( void )
ส่งข้อความ Weave Heartbeat ทันที
รายละเอียด | |||||
---|---|---|---|---|---|
แสดงผลค่า |
|
SetConfiguration
void SetConfiguration( uint32_t interval, uint32_t phase, uint32_t window )
SetEventCallback
void SetEventCallback( EventCallback eventCallback )
ตั้งค่าฟังก์ชันที่จะถูกเรียกเพื่อแจ้งการใช้เหตุการณ์หรือการเปลี่ยนแปลงที่เกิดขึ้นใน WeaveHeartbeatSender
SetRequestAck
void SetRequestAck( bool val )
ตั้งค่าธงเพื่อระบุว่าควรส่งข้อความฮาร์ตบีตอย่างน่าเชื่อถือหรือไม่โดยใช้ Weave Reliable Messaging
โปรดทราบว่าแฟล็กนี้จะมีความหมายก็ต่อเมื่อใช้ UDP เป็นการรับส่งข้อมูลเท่านั้น
รายละเอียด | |||
---|---|---|---|
พารามิเตอร์ |
|
SetSubscriptionState
void SetSubscriptionState( uint8_t val )
ตั้งค่าสถานะการสมัครใช้บริการปัจจุบัน
รายละเอียด | |||
---|---|---|---|
พารามิเตอร์ |
|
ปิดการทำงาน
WEAVE_ERROR Shutdown( void )
StartHeartbeat
WEAVE_ERROR StartHeartbeat( void )
เริ่มส่งข้อความ Weave Heartbeat
รายละเอียด | |||||
---|---|---|---|---|---|
แสดงผลค่า |
|
StopHeartbeat
WEAVE_ERROR StopHeartbeat( void )
WeaveHeartbeatSender
WeaveHeartbeatSender( void )
ฟังก์ชันแบบคงที่แบบสาธารณะ
DefaultEventHandler
void DefaultEventHandler( void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam )
ฟังก์ชันตัวแฮนเดิลเริ่มต้นสำหรับเหตุการณ์ API WeaveHeartbeatSender
แอปพลิเคชันต้องเรียกใช้ฟังก์ชันนี้สำหรับเหตุการณ์ API ที่ไม่ได้จัดการ