nl:: Weave:: Profil:: Heartbeat:: WeaveHeartbeatSender
#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>
Weave Heartbeat Sender class.
Ringkasan
Konstruktor dan Destruktor |
|
---|---|
WeaveHeartbeatSender(void)
|
Jenis publik |
|
---|---|
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
|
typedefvoid(*
|
EventType{
|
enum |
Atribut publik |
|
---|---|
AppState
|
void *
|
Fungsi publik |
|
---|---|
GetBinding() const
|
Binding *
Dapatkan objek binding yang terkait dengan pengirim detak jantung.
|
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 tanda yang menunjukkan apakah pesan detak jantung akan dikirim dengan andal menggunakan Weave Trusted Messaging.
|
GetSubscriptionState() const
|
uint8_t
Mendapatkan nilai status langganan saat ini.
|
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
|
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
Atur konfigurasi pengaturan waktu detak jantung.
|
SetEventCallback(EventCallback eventCallback)
|
void
Menetapkan fungsi yang akan dipanggil untuk memberitahukan penerapan peristiwa atau perubahan yang terjadi pada WeaveHeartbeatSender.
|
SetRequestAck(bool val)
|
void
Menetapkan tanda yang menunjukkan apakah pesan detak jantung harus dikirim dengan andal menggunakan Weave Trusted Messaging.
|
SetSubscriptionState(uint8_t val)
|
void
Menyetel status langganan saat ini.
|
Shutdown(void)
|
Matikan Pengirim Heartbeat Weave.
|
StartHeartbeat(void)
|
Mulai kirim pesan Weave Heartbeat.
|
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 API WeaveHeartbeatSender.
|
Struct |
|
---|---|
nl:: |
Masukkan parameter ke peristiwa API WeaveHeartbeatSender. |
nl:: |
Parameter output ke peristiwa API WeaveHeartbeatSender. |
Jenis publik
Callback Peristiwa
void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
Jenis Peristiwa
EventType
Properti | |
---|---|
kEvent_DefaultCheck
|
Digunakan untuk memverifikasi penanganan peristiwa default yang benar dalam aplikasi. Aplikasi TIDAK boleh secara eksplisit menangani peristiwa ini. |
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
StatusAplikasi
void * AppState
Fungsi publik
GetBinding
Binding * GetBinding() const
Dapatkan objek binding yang terkait dengan pengirim detak jantung.
GetConfiguration
void GetConfiguration( uint32_t & interval, uint32_t & phase, uint32_t & window ) const
Dapatkan konfigurasi pengaturan waktu detak jantung.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
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 tanda yang menunjukkan apakah pesan detak jantung akan dikirim dengan andal menggunakan Weave Trusted Messaging.
Mendapatkan StatusLangganan
uint8_t GetSubscriptionState() const
Mendapatkan nilai status langganan saat ini.
Init
WEAVE_ERROR Init( WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState )
Inisialisasi Pengirim Heartbeat Weave.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Nilai yang Ditampilkan |
|
Jadwal Heartbeat
WEAVE_ERROR ScheduleHeartbeat( void )
Menjadwalkan pengiriman pesan Heartbeat Weave.
Detail | |||||
---|---|---|---|---|---|
Nilai yang Ditampilkan |
|
KirimHeartbeatNow
WEAVE_ERROR SendHeartbeatNow( void )
Kirim pesan Heartbeat Weave sekarang.
Detail | |||||
---|---|---|---|---|---|
Nilai yang Ditampilkan |
|
SetKonfigurasi
void SetConfiguration( uint32_t interval, uint32_t phase, uint32_t window )
SetEventCallback
void SetEventCallback( EventCallback eventCallback )
Menetapkan fungsi yang akan dipanggil untuk memberitahukan penerapan peristiwa atau perubahan yang terjadi pada WeaveHeartbeatSender.
KumpulanPermintaan
void SetRequestAck( bool val )
Menetapkan tanda yang menunjukkan apakah pesan detak jantung harus dikirim dengan andal menggunakan Weave Trusted Messaging.
Perhatikan bahwa tanda ini hanya bermakna saat menggunakan UDP sebagai transport.
Detail | |||
---|---|---|---|
Parameter |
|
MenetapkanStatusLangganan
void SetSubscriptionState( uint8_t val )
Menyetel status langganan saat ini.
Detail | |||
---|---|---|---|
Parameter |
|
Mematikan
WEAVE_ERROR Shutdown( void )
Mulai Heartbeat
WEAVE_ERROR StartHeartbeat( void )
Mulai kirim pesan Weave Heartbeat.
Detail | |||||
---|---|---|---|---|---|
Nilai yang Ditampilkan |
|
StopHeartbeat
WEAVE_ERROR StopHeartbeat( void )
WeaveHeartbeatSender
WeaveHeartbeatSender( void )
Fungsi statis publik
PengendaliPeristiwaDefault
void DefaultEventHandler( void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam )
Fungsi pengendali default untuk peristiwa API WeaveHeartbeatSender.
Aplikasi harus memanggil fungsi ini untuk setiap peristiwa API yang tidak ditanganinya.