nl:: Weave:: Hồ sơ:: Nhịp tim:: WeaveHeartbeatGửi
#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>
Lớp Weave Heartbeat (Người gửi).
Tóm tắt
Hàm dựng và hàm phá hủy |
|
---|---|
WeaveHeartbeatSender(void)
|
Loại công khai |
|
---|---|
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
|
typedefvoid(*
|
EventType{
|
enum |
Thuộc tính công khai |
|
---|---|
AppState
|
void *
|
Hàm công khai |
|
---|---|
GetBinding() const
|
Binding *
Lấy đối tượng liên kết được liên kết với trình gửi nhịp tim.
|
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
|
void
Xem cấu hình thời gian của nhịp tim.
|
GetEventCallback() const
|
EventCallback
Trả về hàm sẽ được gọi để thông báo cho việc áp dụng sự kiện hoặc thay đổi xảy ra trong WeaveHeartbeatGửi.
|
GetRequestAck() const
|
bool
Trả về một cờ cho biết liệu thông báo nhịp tim có được gửi một cách đáng tin cậy bằng cách sử dụng tính năng Nhắn tin qua tin nhắn Weave hay không.
|
GetSubscriptionState() const
|
uint8_t
Nhận giá trị trạng thái gói đăng ký hiện tại.
|
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
|
Khởi tạo người gửi Nhịp tim.
|
ScheduleHeartbeat(void)
|
Lên lịch gửi tin nhắn Weave Heartbeat.
|
SendHeartbeatNow(void)
|
Gửi tin nhắn Weave Heartbeat ngay.
|
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
|
void
Đặt cấu hình thời gian của nhịp tim.
|
SetEventCallback(EventCallback eventCallback)
|
void
Đặt hàm sẽ được gọi để thông báo cho việc áp dụng sự kiện hoặc thay đổi xảy ra trong WeaveHeartbeatGửi.
|
SetRequestAck(bool val)
|
void
Đặt một cờ cho biết liệu thông báo về nhịp tim có được gửi một cách đáng tin cậy hay không bằng cách sử dụng tính năng Nhắn tin đáng tin cậy.
|
SetSubscriptionState(uint8_t val)
|
void
Đặt trạng thái gói đăng ký hiện tại.
|
Shutdown(void)
|
Tắt nguồn người gửi Nhịp tim.
|
StartHeartbeat(void)
|
Bắt đầu gửi tin nhắn Weave Heartbeat.
|
StopHeartbeat(void)
|
Dừng gửi tin nhắn Weave Heartbeat.
|
Hàm tĩnh công khai |
|
---|---|
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
|
void
Hàm xử lý mặc định cho các sự kiện API WeaveHeartbeatGửi.
|
Cấu trúc |
|
---|---|
nl:: |
Nhập thông số vào sự kiện API WeaveHeartbeatNhịp. |
nl:: |
Thông số đầu ra cho sự kiện API WeaveHeartbeatbeat. |
Loại công khai
Lệnh gọi lại sự kiện
void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
Loại sự kiện
EventType
Thuộc tính | |
---|---|
kEvent_DefaultCheck
|
Dùng để xác minh rằng hoạt động xử lý sự kiện mặc định chính xác trong ứng dụng. Ứng dụng KHÔNG được xử lý rõ ràng sự kiện này. |
kEvent_HeartbeatFailed
|
Không thể gửi tin nhắn nhịp tim cho đồng nghiệp. |
kEvent_HeartbeatSent
|
Đã gửi thành công tin nhắn heart rate cho đồng nghiệp. Nếu bạn bật tính năng truyền đáng tin cậy, thì sự kiện này cho biết rằng tin nhắn đã được xác nhận. |
kEvent_UpdateSubscriptionState
|
Ứng dụng được yêu cầu cập nhật trạng thái đăng ký. |
Thuộc tính công khai
AppState
void * AppState
Hàm công khai
Cấu hình
void GetConfiguration( uint32_t & interval, uint32_t & phase, uint32_t & window ) const
Xem cấu hình thời gian của nhịp tim.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các thông số |
|
GetEventCallback
EventCallback GetEventCallback() const
Trả về hàm sẽ được gọi để thông báo cho việc áp dụng sự kiện hoặc thay đổi xảy ra trong WeaveHeartbeatGửi.
Nhận yêu cầu
bool GetRequestAck() const
Trả về một cờ cho biết liệu thông báo nhịp tim có được gửi một cách đáng tin cậy bằng cách sử dụng tính năng Nhắn tin qua tin nhắn Weave hay không.
Nhận trạng thái đăng ký
uint8_t GetSubscriptionState() const
Nhận giá trị trạng thái gói đăng ký hiện tại.
Số nguyên
WEAVE_ERROR Init( WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState )
Khởi tạo người gửi Nhịp tim.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Các thông số |
|
||||||||
Giá trị trả về |
|
Lên lịch
WEAVE_ERROR ScheduleHeartbeat( void )
Lên lịch gửi tin nhắn Weave Heartbeat.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Giá trị trả về |
|
SendGửibeatNow
WEAVE_ERROR SendHeartbeatNow( void )
Gửi tin nhắn Weave Heartbeat ngay.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Giá trị trả về |
|
Cấu hình bộ
void SetConfiguration( uint32_t interval, uint32_t phase, uint32_t window )
Đặt lại sự kiện
void SetEventCallback( EventCallback eventCallback )
Đặt hàm sẽ được gọi để thông báo cho việc áp dụng sự kiện hoặc thay đổi xảy ra trong WeaveHeartbeatGửi.
SetRequestAck
void SetRequestAck( bool val )
Đặt một cờ cho biết liệu thông báo về nhịp tim có được gửi một cách đáng tin cậy hay không bằng cách sử dụng tính năng Nhắn tin đáng tin cậy.
Lưu ý rằng cờ này chỉ có ý nghĩa khi sử dụng UDP làm phương tiện giao thông.
Thông tin chi tiết | |||
---|---|---|---|
Các thông số |
|
Đặt trạng thái đăng ký
void SetSubscriptionState( uint8_t val )
Đặt trạng thái gói đăng ký hiện tại.
Thông tin chi tiết | |||
---|---|---|---|
Các thông số |
|
Tắt
WEAVE_ERROR Shutdown( void )
Bắt đầu nhịp tim
WEAVE_ERROR StartHeartbeat( void )
Bắt đầu gửi tin nhắn Weave Heartbeat.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Giá trị trả về |
|
Dừng nhịp tim
WEAVE_ERROR StopHeartbeat( void )
WeaveHeartbeatGửi
WeaveHeartbeatSender( void )
Hàm tĩnh công khai
Trình xử lý sự kiện mặc định
void DefaultEventHandler( void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam )
Hàm xử lý mặc định cho các sự kiện API WeaveHeartbeatGửi.
Ứng dụng phải gọi hàm này cho bất kỳ sự kiện API nào mà chúng không xử lý.