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

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

Kelas Pengirim Heartbeat.

Ringkasan

Konstruktor dan Destruktor
WeaveHeartbeatSender(void)

Jenis publik
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

Atribut publik
AppState
void *

Fungsi publik
GetBinding() const
Mendapatkan objek binding yang terkait dengan pengirim heartbeat.
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
void
Dapatkan konfigurasi pengaturan waktu detak jantung.
GetEventCallback() const
EventCallback
Menampilkan fungsi yang akan dipanggil untuk memberi tahu penerapan peristiwa atau perubahan yang terjadi di WeaveHeartbeatSender.
GetRequestAck() const
bool
Menampilkan flag yang menunjukkan apakah pesan heartbeat akan dikirim dengan andal menggunakan Weave Reliable Messaging.
GetSubscriptionState() const
uint8_t
Mendapatkan nilai status langganan saat ini.
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
Melakukan inisialisasi Pengirim Heartbeat Weave.
ScheduleHeartbeat(void)
Menjadwalkan pengiriman pesan Heartbeat Weave.
SendHeartbeatNow(void)
Kirim pesan Heartbeat Weave sekarang.
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
void
Tetapkan konfigurasi waktu detak jantung.
SetEventCallback(EventCallback eventCallback)
void
Menetapkan fungsi yang akan dipanggil untuk memberi tahu penerapan peristiwa atau perubahan yang terjadi dalam WeaveHeartbeatSender.
SetRequestAck(bool val)
void
Menyetel flag yang menunjukkan apakah pesan detak jantung harus dikirim dengan andal menggunakan Weave Reliable Messaging.
SetSubscriptionState(uint8_t val)
void
Setel status langganan saat ini.
Shutdown(void)
Matikan Pengirim Heartbeat Weave.
StartHeartbeat(void)
Mulai mengirim pesan Heartbeat Weave.
StopHeartbeat(void)
Berhenti mengirim pesan Heartbeat Weave.

Fungsi statis publik
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
void
Fungsi pengendali default untuk peristiwa WeaveHeartbeatSender API.

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

Parameter input ke peristiwa WeaveHeartbeatSender API.

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

Parameter output ke peristiwa WeaveHeartbeatSender API.

Jenis publik

EventCallback

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

EventType

 EventType
Properti
kEvent_DefaultCheck

Digunakan untuk memverifikasi penanganan peristiwa default yang benar dalam aplikasi.

Aplikasi TIDAK boleh menangani peristiwa ini secara jelas.

kEvent_HeartbeatFailed

Pesan detak jantung gagal dikirim ke rekan.

kEvent_HeartbeatSent

Pesan detak jantung berhasil dikirim ke rekan.

Jika transmisi yang andal diaktifkan, peristiwa ini menunjukkan bahwa pesan telah dikonfirmasi.

kEvent_UpdateSubscriptionState

Aplikasi diminta untuk memperbarui status langganan.

Atribut publik

AppState

void * AppState

Fungsi publik

GetBinding

Binding * GetBinding() const

Mendapatkan objek binding yang terkait dengan pengirim heartbeat.

GetConfiguration

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

Dapatkan konfigurasi pengaturan waktu detak jantung.

Detail
Parameter
[out] interval
Referensi ke bilangan bulat untuk menerima interval detak jantung.
[out] phase
Referensi ke bilangan bulat untuk menerima fase detak jantung.
[out] window
Referensi ke bilangan bulat untuk menerima jendela pengacakan detak jantung.

GetEventCallback

EventCallback GetEventCallback() const

Menampilkan fungsi yang akan dipanggil untuk memberi tahu penerapan peristiwa atau perubahan yang terjadi di WeaveHeartbeatSender.

GetRequestAck

bool GetRequestAck() const

Menampilkan flag yang menunjukkan apakah pesan heartbeat akan dikirim dengan andal menggunakan Weave Reliable Messaging.

GetSubscriptionState

uint8_t GetSubscriptionState() const

Mendapatkan nilai status langganan saat ini.

Inisiasi

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

Melakukan inisialisasi Pengirim Heartbeat Weave.

Detail
Parameter
[in] exchangeMgr
Pointer ke sistem Weave Exchange Manager.
[in] binding
Pointer ke objek binding Weave yang akan digunakan untuk menangani node peer.
[in] eventCallback
Pointer ke fungsi yang akan dipanggil untuk memberi tahu penerapan peristiwa atau perubahan status yang terjadi dalam pengirim.
[in] appState
Pointer ke data khusus aplikasi. Pointer ini akan dikembalikan dalam callback ke aplikasi.
Nilai Pengembalian
WEAVE_ERROR_INCORRECT_STATE
Jika objek WeaveHeartbeatSender sudah diinisialisasi.
WEAVE_ERROR_INVALID_ARGUMENT
Jika salah satu argumen yang diberikan adalah null.
WEAVE_NO_ERROR
Setelah berhasil.

ScheduleHeartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Menjadwalkan pengiriman pesan Heartbeat Weave.

Detail
Nilai Pengembalian
WEAVE_SYSTEM_ERROR_NO_MEMORY
jika StartTimer() gagal
WEAVE_NO_ERROR
saat berhasil

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

Kirim pesan Heartbeat Weave sekarang.

Detail
Nilai Pengembalian
WEAVE_ERROR_INCORRECT_STATE
jika WeaveHeartbeatSender tidak diinisialisasi
WEAVE_NO_ERROR
saat berhasil

SetConfiguration

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

Tetapkan konfigurasi waktu detak jantung.

Detail
Parameter
[in] interval
Interval yang digunakan saat mengirim pesan Heartbeat Weave.
[in] phase
Fase yang digunakan saat mengirim pesan Heartbeat Weave.
[in] window
Rentang jendela yang akan digunakan untuk memilih interval acak

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

Menetapkan fungsi yang akan dipanggil untuk memberi tahu penerapan peristiwa atau perubahan yang terjadi dalam WeaveHeartbeatSender.

SetRequestAck

void SetRequestAck(
  bool val
)

Menyetel flag yang menunjukkan apakah pesan detak jantung harus dikirim dengan andal menggunakan Weave Reliable Messaging.

Perhatikan bahwa flag ini hanya berguna jika menggunakan UDP sebagai transport.

Detail
Parameter
[in] val
Benar jika pesan detak jantung harus dikirim dengan andal.

SetSubscriptionState

void SetSubscriptionState(
  uint8_t val
)

Setel status langganan saat ini.

Detail
Parameter
[in] val
Nilai status langganan 8-bit yang akan disampaikan dengan pesan detak jantung.

Nonaktif

WEAVE_ERROR Shutdown(
  void
)

Matikan Pengirim Heartbeat Weave.

Detail
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Mulai mengirim pesan Heartbeat Weave.

Detail
Nilai Pengembalian
INET_ERROR_NO_MEMORY
jika StartTimer() gagal
WEAVE_NO_ERROR
saat berhasil

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Berhenti mengirim pesan Heartbeat Weave.

Detail
Nilai Pengembalian
WEAVE_NO_ERROR
tanpa syarat

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

Fungsi statis publik

DefaultEventHandler

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

Fungsi pengendali default untuk peristiwa WeaveHeartbeatSender API.

Aplikasi harus memanggil fungsi ini untuk setiap peristiwa API yang tidak ditangani.