nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender

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

Tạo lớp Người gửi HeartBeat.

Tóm tắt

Hàm khởi tạo và phá huỷ
WeaveHeartbeatSender(void)

Loại công khai
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

Các thuộc tính công khai
AppState
void *

Hàm công khai
GetBinding() const
Lấy đối tượng liên kết 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
Nhận cấu hình thời gian cho nhịp đập.
GetEventCallback() const
EventCallback
Trả về hàm sẽ được gọi để thông báo cho ứng dụng về các sự kiện hoặc thay đổi xảy ra trong WeaveHeartbeatSender.
GetRequestAck() const
bool
Trả về 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 bằng tính năng Weave Trusted Messaging hay không.
GetSubscriptionState() const
uint8_t
Lấy giá trị trạng thái hiện tại của gói thuê bao.
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
Khởi chạy trình gửi HeartBeat của Weave.
ScheduleHeartbeat(void)
Lên lịch gửi tin nhắn Nhịp tim của Weave.
SendHeartbeatNow(void)
Gửi tin nhắn HeartBeat của Weave ngay bây giờ.
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
void
Đặt cấu hình thời gian cho nhịp của nhịp.
SetEventCallback(EventCallback eventCallback)
void
Thiết lập hàm sẽ được gọi để thông báo cho ứng dụng về các sự kiện hoặc thay đổi xảy ra trong WeaveHeartbeatSender.
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 bằng tính năng Weave Trusted Messaging hay không.
SetSubscriptionState(uint8_t val)
void
Đặt trạng thái hiện tại của gói thuê bao.
Shutdown(void)
Tắt trình gửi HeartBeat của Weave.
StartHeartbeat(void)
Bắt đầu gửi tin nhắn HeartBeat của Weave.
StopHeartbeat(void)
Ngừng gửi tin nhắn Nhịp tim của Weave.

Hàm tĩnh công khai
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
void
Hàm của trình xử lý mặc định cho các sự kiện API WeaveHeartbeatSender.

Cấu trúc
nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender::InEventParam

Các tham số đầu vào cho sự kiện API WeaveHeartbeatSender.

nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender::OutEventParam

Xuất các tham số cho sự kiện API WeaveHeartbeatSender.

Loại công khai

EventCallback

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

EventType

 EventType
Thuộc tính
kEvent_DefaultCheck

Dùng để xác minh cách xử lý sự kiện mặc định chính xác trong ứng dụng.

Các ứng dụng KHÔNG được xử lý rõ ràng sự kiện này.

kEvent_HeartbeatFailed

Không gửi được tin nhắn về nhịp cho ứng dụng ngang hàng.

kEvent_HeartbeatSent

Đã gửi thành công thông báo về nhịp tim cho ứng dụng ngang hàng.

Nếu tính năng truyền đáng tin cậy được bật, sự kiện này cho biết thông báo đã được xác nhận.

kEvent_UpdateSubscriptionState

Ứng dụng được yêu cầu cập nhật trạng thái của gói thuê bao.

Các thuộc tính công khai

AppState

void * AppState

Hàm công khai

GetBinding

Binding * GetBinding() const

Lấy đối tượng liên kết liên kết với trình gửi nhịp tim.

GetConfiguration

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

Nhận cấu hình thời gian cho nhịp đập.

Chi tiết
Tham số
[out] interval
Giá trị tham chiếu đến một số nguyên để nhận khoảng thời gian nhịp tim.
[out] phase
Giá trị tham chiếu đến một số nguyên để nhận được giai đoạn nhịp tim.
[out] window
Tham chiếu đến một số nguyên để nhận cửa sổ ngẫu nhiên nhịp tim.

GetEventCallback

EventCallback GetEventCallback() const

Trả về hàm sẽ được gọi để thông báo cho ứng dụng về các sự kiện hoặc thay đổi xảy ra trong WeaveHeartbeatSender.

GetRequestAck

bool GetRequestAck() const

Trả về 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 bằng tính năng Weave Trusted Messaging hay không.

GetSubscriptionState

uint8_t GetSubscriptionState() const

Lấy giá trị trạng thái hiện tại của gói thuê bao.

Init

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

Khởi chạy trình gửi HeartBeat của Weave.

Chi tiết
Tham số
[in] exchangeMgr
Con trỏ trỏ đến hệ thống Weave Exchange Manager.
[in] binding
Con trỏ trỏ đến đối tượng liên kết Weave sẽ được dùng để địa chỉ với nút ngang hàng.
[in] eventCallback
Con trỏ trỏ đến một hàm sẽ được gọi để thông báo cho ứng dụng về các sự kiện hoặc thay đổi trạng thái xảy ra ở đối tượng gửi.
[in] appState
Con trỏ trỏ đến dữ liệu dành riêng cho ứng dụng. Con trỏ này sẽ được trả về trong lệnh gọi lại cho ứng dụng.
Giá trị trả về
WEAVE_ERROR_INCORRECT_STATE
Nếu đối tượng WeaveHeartbeatSender đã được khởi tạo.
WEAVE_ERROR_INVALID_ARGUMENT
Nếu bất kỳ đối số nào được cung cấp là giá trị rỗng.
WEAVE_NO_ERROR
Khi thành công.

ScheduleHeartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Lên lịch gửi tin nhắn Nhịp tim của Weave.

Chi tiết
Giá trị trả về
WEAVE_SYSTEM_ERROR_NO_MEMORY
nếu StartTimer() không thành công
WEAVE_NO_ERROR
khi thành công

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

Gửi tin nhắn HeartBeat của Weave ngay bây giờ.

Chi tiết
Giá trị trả về
WEAVE_ERROR_INCORRECT_STATE
nếu chưa khởi chạy WeaveHeartbeatSender
WEAVE_NO_ERROR
khi thành công

SetConfiguration

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

Đặt cấu hình thời gian cho nhịp của nhịp.

Chi tiết
Tham số
[in] interval
Khoảng thời gian sử dụng khi gửi tin nhắn Weave HeartBeat.
[in] phase
Giai đoạn sẽ sử dụng khi gửi thông báo Nhịp tim của Weave.
[in] window
Dải ô cửa sổ dùng để chọn khoảng thời gian ngẫu nhiên

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

Thiết lập hàm sẽ được gọi để thông báo cho ứng dụng về các sự kiện hoặc thay đổi xảy ra trong WeaveHeartbeatSender.

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 bằng tính năng Weave Trusted Messaging hay không.

Lưu ý rằng cờ này chỉ có ý nghĩa khi sử dụng UDP làm phương tiện truyền tải.

Chi tiết
Tham số
[in] val
"True" nếu thông báo về nhịp tim phải được gửi một cách đáng tin cậy.

SetSubscriptionState

void SetSubscriptionState(
  uint8_t val
)

Đặt trạng thái hiện tại của gói thuê bao.

Chi tiết
Tham số
[in] val
Một giá trị trạng thái của gói thuê bao 8 bit được truyền tải cùng với thông báo về nhịp.

Tắt

WEAVE_ERROR Shutdown(
  void
)

Tắt trình gửi HeartBeat của Weave.

Chi tiết
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Bắt đầu gửi tin nhắn HeartBeat của Weave.

Chi tiết
Giá trị trả về
INET_ERROR_NO_MEMORY
nếu StartTimer() không thành công
WEAVE_NO_ERROR
khi thành công

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Ngừng gửi tin nhắn Nhịp tim của Weave.

Chi tiết
Giá trị trả về
WEAVE_NO_ERROR
vô điều kiện

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

Hàm tĩnh công khai

DefaultEventHandler

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

Hàm của trình xử lý mặc định cho các sự kiện API WeaveHeartbeatSender.

Các ứng dụng phải gọi hàm này cho mọi sự kiện API mà ứng dụng không xử lý.