จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ

nl::Weave::โปรไฟล์::ฮาร์ตบีต::WeaveHeartbeatSender

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

เป็นสมาชิกผู้ส่งประเภท Heartbeat

สรุป

เครื่องมือสร้างและตัวสร้าง

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 Reliable Messaging
GetSubscriptionState() const
uint8_t
รับค่าสถานะการสมัครใช้บริการปัจจุบัน
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
เริ่มต้นผู้ส่ง Heartbeat ของ Weave
ScheduleHeartbeat(void)
ตั้งเวลาส่งข้อความ Heartbeat ของ Weave
SendHeartbeatNow(void)
ส่งข้อความ Heartbeat ของ Weave เลย
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)
ปิดผู้ส่ง Heartbeat ของ Weave
StartHeartbeat(void)
เริ่มส่งข้อความ Heartbeat ของ Weave
StopHeartbeat(void)
หยุดส่งข้อความ Heartbeat ของ Weave

ฟังก์ชันสาธารณะแบบคงที่

DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
void
ฟังก์ชันเครื่องจัดการเริ่มต้นสําหรับเหตุการณ์ API WeaveHeartbeatSender

โครงสร้าง

nl::Weave::Profiles::ฮาร์ตบีต::WeaveHeartbeatSender::InEventParam

ป้อนพารามิเตอร์ให้กับเหตุการณ์ API WeaveHeartbeatSender

nl::Weave::Profiles::ฮาร์ตบีต:WeaveHeartbeatSender::OutEventParam

พารามิเตอร์เอาต์พุตไปยังเหตุการณ์ API ของ WeaveHeartbeatSender

ประเภทสาธารณะ

เรียกกลับเหตุการณ์

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

ประเภทเหตุการณ์

 EventType
พร็อพเพอร์ตี้
kEvent_DefaultCheck

ใช้เพื่อยืนยันการจัดการเหตุการณ์เริ่มต้นที่ถูกต้องในแอปพลิเคชัน

แอปพลิเคชันไม่ควรจัดการกับเหตุการณ์นี้อย่างชัดแจ้ง

kEvent_HeartbeatFailed

ส่งข้อความฮาร์ตบีตไปยังเพียร์ไม่สําเร็จ

kEvent_HeartbeatSent

ส่งข้อความฮาร์ตบีตไปยังเพียร์เรียบร้อยแล้ว

หากเปิดใช้การส่งที่เชื่อถือได้ เหตุการณ์นี้จะระบุว่าข้อความรับทราบแล้ว

kEvent_UpdateSubscriptionState

แอปพลิเคชันจะอัปเดตสถานะการสมัครใช้บริการ

แอตทริบิวต์สาธารณะ

สถานะแอป

void * AppState

ฟังก์ชันสาธารณะ

ดาวน์โหลด Get-inding

Binding * GetBinding() const 

รับออบเจ็กต์การเชื่อมโยงที่เชื่อมโยงกับผู้ส่งฮาร์ตบีต

การกําหนดค่า

void GetConfiguration(
  uint32_t & interval,
  uint32_t & phase,
  uint32_t & window
) const 

รับการกําหนดค่าเวลาฮาร์ตบีต

รายละเอียด
พารามิเตอร์
[out] interval
การอ้างอิงจํานวนเต็มเพื่อรับช่วงฮาร์ตบีต
[out] phase
การอ้างอิงจํานวนเต็มเพื่อรับช่วงฮาร์ตบีต
[out] window
การอ้างอิงจํานวนเต็มเพื่อรับกรอบเวลาการสุ่มการเต้นของหัวใจ

เรียกกลับเหตุการณ์

EventCallback GetEventCallback() const 

แสดงฟังก์ชันที่จะเรียกใช้เพื่อแจ้งเหตุการณ์หรือการเปลี่ยนแปลงที่เกิดขึ้นใน WeaveHeartbeatSender

GetRequestAck

bool GetRequestAck() const 

ส่งคืนธงที่บ่งชี้ว่าจะส่งข้อความฮาร์ตบีตอย่างเสถียรโดยใช้ Weave Reliable Messaging

รับสถานะ

uint8_t GetSubscriptionState() const 

รับค่าสถานะการสมัครใช้บริการปัจจุบัน

เริ่ม

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

เริ่มต้นผู้ส่ง Heartbeat ของ Weave

รายละเอียด
พารามิเตอร์
[in] exchangeMgr
ตัวชี้ไปยัง Weave Exchange Manager ของระบบ
[in] binding
ตัวชี้ไปยังออบเจ็กต์การเชื่อมโยง Weave ซึ่งจะใช้เพื่อจัดการกับโหนดเพียร์
[in] eventCallback
ตัวชี้ไปยังฟังก์ชันที่จะเรียกใช้เพื่อแจ้งเตือนการใช้เหตุการณ์หรือการเปลี่ยนแปลงสถานะที่เกิดขึ้นในผู้ส่ง
[in] appState
ตัวชี้ไปยังข้อมูลเฉพาะแอปพลิเคชัน ระบบจะส่งตัวชี้นี้กลับไปยังโค้ดเรียกกลับไปยังแอปพลิเคชัน
แสดงผลค่า
WEAVE_ERROR_INCORRECT_STATE
หากเริ่มต้นออบเจ็กต์ WeaveHeartbeatSender แล้ว
WEAVE_ERROR_INVALID_ARGUMENT
หากอาร์กิวเมนต์ที่ระบุเป็น Null
WEAVE_NO_ERROR
สําเร็จแล้ว

ฮาร์ตบีต

WEAVE_ERROR ScheduleHeartbeat(
  void
)

ตั้งเวลาส่งข้อความ Heartbeat ของ Weave

รายละเอียด
แสดงผลค่า
WEAVE_SYSTEM_ERROR_NO_MEMORY
หาก Startตัวจับเวลา() ล้มเหลว
WEAVE_NO_ERROR
สําเร็จ

ส่งฮาร์ตบีตเลย

WEAVE_ERROR SendHeartbeatNow(
  void
)

ส่งข้อความ Heartbeat ของ Weave เลย

รายละเอียด
แสดงผลค่า
WEAVE_ERROR_INCORRECT_STATE
หากเริ่มต้น WeaveHeartbeatSender ไว้
WEAVE_NO_ERROR
สําเร็จ

ตั้งค่าการกําหนดค่า

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

ตั้งค่ากําหนดเวลาฮาร์ตบีต

รายละเอียด
พารามิเตอร์
[in] interval
ระยะเวลาที่จะใช้เมื่อส่งข้อความ Weave Heartbeat
[in] phase
ระยะสําหรับส่งข้อความเมื่อส่งข้อความ Heartbeat ของ Weave
[in] window
ช่วงหน้าต่างที่จะใช้สําหรับการเลือกช่วงเวลาแบบสุ่ม

ตั้งค่าการเรียกกลับเหตุการณ์

void SetEventCallback(
  EventCallback eventCallback
)

ตั้งค่าฟังก์ชันที่จะเรียกใช้เพื่อแจ้งให้มีการใช้เหตุการณ์หรือการเปลี่ยนแปลงที่เกิดขึ้นใน WeaveHeartbeatSender

ตั้งค่าคําขอ

void SetRequestAck(
  bool val
)

ตั้งค่าการติดธงที่ระบุว่าควรส่งข้อความฮาร์ตบีตอย่างเสถียรโดยใช้ Weave Reliable Messaging

โปรดทราบว่าแฟล็กนี้มีความหมายเฉพาะในกรณีที่ใช้ UDP เป็นการขนส่ง

รายละเอียด
พารามิเตอร์
[in] val
เป็นจริงหากควรส่งฮาร์ตบีตอย่างน่าเชื่อถือ

ตั้งค่าสถานะการสมัครใช้บริการ

void SetSubscriptionState(
  uint8_t val
)

ตั้งค่าสถานะการสมัครใช้บริการปัจจุบัน

รายละเอียด
พารามิเตอร์
[in] val
ค่าสถานะการสมัครใช้บริการ 8 บิตที่จะถ่ายทอดด้วยข้อความฮาร์ตบีต

ปิดการทำงาน

WEAVE_ERROR Shutdown(
  void
)

ปิดผู้ส่ง Heartbeat ของ Weave

รายละเอียด
แสดงผลค่า
WEAVE_NO_ERROR
สําเร็จแล้ว

ฮาร์ตบีต

WEAVE_ERROR StartHeartbeat(
  void
)

เริ่มส่งข้อความ Heartbeat ของ Weave

รายละเอียด
แสดงผลค่า
INET_ERROR_NO_MEMORY
หาก Startตัวจับเวลา() ล้มเหลว
WEAVE_NO_ERROR
สําเร็จ

ฮาร์ตบีต

WEAVE_ERROR StopHeartbeat(
  void
)

หยุดส่งข้อความ Heartbeat ของ Weave

รายละเอียด
แสดงผลค่า
WEAVE_NO_ERROR
ไม่มีเงื่อนไข

ผู้ส่งฮาร์ตบีต

 WeaveHeartbeatSender(
  void
)

ฟังก์ชันสาธารณะแบบคงที่

เครื่องจัดการเหตุการณ์เริ่มต้น

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

ฟังก์ชันเครื่องจัดการเริ่มต้นสําหรับเหตุการณ์ API WeaveHeartbeatSender

แอปพลิเคชันต้องเรียกใช้ฟังก์ชันนี้สําหรับเหตุการณ์ API ใดๆ ที่ตนไม่ได้จัดการ