Google cam kết thúc đẩy công bằng chủng tộc cho Cộng đồng người da đen. Xem cách thực hiện.
Trang này được dịch bởi Cloud Translation API.
Switch to English

nl :: Dệt :: Hồ sơ :: Nhịp tim:: WeaveHeartbeatSender

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

Dệt lớp người gửi Heartbeat .

Tóm lược

Người xây dựng và Người phá hủy

WeaveHeartbeatSender (void)

Các 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

Thuộc tính công cộng

AppState
void *

Chức năng công cộng

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

Chức năng 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 WeaveHeartbeatSender .

Cấu trúc

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

Nhập thông số cho sự kiện API WeaveHeartbeatSender .

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

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

Các loại công khai

EventCallback

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

Loại sự kiện

 EventType
Tính chất
kEvent_DefaultCheck

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

Ứng dụng KHÔNG nên xử lý rõ ràng sự kiện này.

kEvent_HeartbeatFailed

Không gửi được tin nhắn nhịp tim cho đồng nghiệp.

kEvent_HeartbeatSent

Một tin nhắn nhịp tim đã được gửi thành công đến đồng nghiệp.

Nếu truyền đáng tin cậy được bật, sự kiện này cho biết rằng 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 đăng ký.

Thuộc tính công cộng

AppState

void * AppState

Chức năng công cộng

GetBinding

Binding * GetBinding() const 

Nhận đối tượng ràng buộc liên kết với người 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 nhịp tim.

Chi tiết
Thông số
[out] interval
Tham chiếu đến một số nguyên để nhận khoảng nhịp tim.
[out] phase
Tham chiếu đến một số nguyên để nhận pha 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ề một cờ cho biết liệu tin nhắn 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 Nhắn tin đáng tin cậy Weave.

GetSubscriptionState

uint8_t GetSubscriptionState() const 

Nhận giá trị trạng thái đăng ký hiện tại.

Trong đó

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

Khởi tạo Weave Heartbeat Sender.

Chi tiết
Thông số
[in] exchangeMgr
Một con trỏ đến hệ thống Weave Exchange Manager.
[in] binding
Một con trỏ đến một đối tượng ràng buộc Weave sẽ được sử dụng để giải quyết nút ngang hàng.
[in] eventCallback
Một con 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 trong người gửi.
[in] appState
Một con trỏ đến dữ liệu dành riêng cho ứng dụng. Con trỏ này sẽ được trả về trong các lệnh gọi lại ứng dụng.
Giá trị trả lại
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à rỗng.
WEAVE_NO_ERROR
Về thành công.

ScheduleHeartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Lên lịch gửi tin nhắn Weave Heartbeat .

Chi tiết
Giá trị trả lại
WEAVE_SYSTEM_ERROR_NO_MEMORY
nếu StartTimer () không thành công
WEAVE_NO_ERROR
thành công

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

Gửi tin nhắn Weave Heartbeat ngay bây giờ.

Chi tiết
Giá trị trả lại
WEAVE_ERROR_INCORRECT_STATE
nếu WeaveHeartbeatSender không được khởi tạo
WEAVE_NO_ERROR
thành công

SetConfiguration

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

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

Chi tiết
Thông 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ử dụng khi gửi tin nhắn Weave Heartbeat .
[in] window
Phạm vi cửa sổ để sử dụng để chọn khoảng thời gian ngẫu nhiên

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

Đặt chức năng 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 cờ cho biết liệu tin nhắn 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 Weave Trusted Messaging.

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
Thông số
[in] val
Đúng nếu tin nhắn nhịp tim sẽ được gửi đi một cách đáng tin cậy.

SetSubscriptionState

void SetSubscriptionState(
  uint8_t val
)

Đặt trạng thái đăng ký hiện tại.

Chi tiết
Thông số
[in] val
Giá trị trạng thái đăng ký 8 bit sẽ được truyền tải với thông điệp nhịp tim.

Tắt

WEAVE_ERROR Shutdown(
  void
)

Tắt máy gửi Weave Heartbeat .

Chi tiết
Giá trị trả lại
WEAVE_NO_ERROR
Về thành công.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Bắt đầu gửi tin nhắn Weave Heartbeat .

Chi tiết
Giá trị trả lại
INET_ERROR_NO_MEMORY
nếu StartTimer () không thành công
WEAVE_NO_ERROR
thành công

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Dừng gửi tin nhắn Weave Heartbeat .

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

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

Chức năng tĩnh công khai

DefaultEventHandler

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

Các ứ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ý.