Google berkomitmen untuk mendorong terwujudnya keadilan ras bagi komunitas Kulit Hitam. Lihat caranya.
Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

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) typedef
void(*
EventType{
  kEvent_UpdateSubscriptionState = 1,
  kEvent_HeartbeatSent = 2,
  kEvent_HeartbeatFailed = 3,
  kEvent_DefaultCheck = 100
} 		enum

Atribut publik
AppState
void *

Fungsi publik
GetBinding() const
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::Weave::Profiles::Heartbeat::WeaveHeartbeatSender::InEventParam

Masukkan parameter ke peristiwa API WeaveHeartbeatSender.

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

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
[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 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
[in] exchangeMgr
Pointer ke sistem Weave Exchange Manager.
[in] binding
Pointer ke objek binding Weave yang akan digunakan untuk menangani node pembanding.
[in] eventCallback
Pointer ke fungsi yang akan dipanggil untuk memberi tahu penerapan peristiwa atau perubahan status yang terjadi di pengirim.
[in] appState
Pointer ke data khusus aplikasi. Pointer ini akan dikembalikan dalam callback ke aplikasi.
Nilai yang Ditampilkan
WEAVE_ERROR_INCORRECT_STATE
Jika objek WeaveHeartbeatSender telah diinisialisasi.
WEAVE_ERROR_INVALID_ARGUMENT
Jika salah satu argumen yang diberikan bernilai null.
WEAVE_NO_ERROR
Jika berhasil.

Jadwal Heartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Menjadwalkan pengiriman pesan Heartbeat Weave.

Detail
Nilai yang Ditampilkan
WEAVE_SYSTEM_ERROR_NO_MEMORY
jika StartTimer() gagal
WEAVE_NO_ERROR
saat berhasil

KirimHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

Kirim pesan Heartbeat Weave sekarang.

Detail
Nilai yang Ditampilkan
WEAVE_ERROR_INCORRECT_STATE
jika WeaveHeartbeatSender tidak diinisialisasi
WEAVE_NO_ERROR
saat berhasil

SetKonfigurasi

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

Atur konfigurasi pengaturan waktu detak jantung.

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

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
[in] val
True jika pesan detak jantung harus dikirim dengan tepercaya.

MenetapkanStatusLangganan

void SetSubscriptionState(
  uint8_t val
)

Menyetel status langganan saat ini.

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

Mematikan

WEAVE_ERROR Shutdown(
  void
)

Matikan Pengirim Heartbeat Weave.

Detail
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Jika berhasil.

Mulai Heartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Mulai kirim pesan Weave Heartbeat.

Detail
Nilai yang Ditampilkan
INET_ERROR_NO_MEMORY
jika StartTimer() gagal
WEAVE_NO_ERROR
saat berhasil

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Berhenti mengirim pesan Heartbeat Weave.

Detail
Nilai yang Ditampilkan
WEAVE_NO_ERROR
tanpa syarat

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.