nl:: Weave:: Profiller:: Nabız:: WeaveHeartbeatSender
#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>
Nabız gönderen sınıfı.
Özet
İnşaat Ustaları ve Yıkıcılar |
|
---|---|
WeaveHeartbeatSender(void)
|
Herkese açık türler |
|
---|---|
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
|
Türvoid(*
|
EventType{
|
enum |
Herkese açık özellikler |
|
---|---|
AppState
|
void *
|
Herkese açık işlevler |
|
---|---|
GetBinding() const
|
Binding *
Sinyal gönderen gönderenle ilişkili bağlama nesnesini alın.
|
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
|
void
Sinyal zamanlaması yapılandırması alın.
|
GetEventCallback() const
|
EventCallback
WeaveHeartbeatSender içinde gerçekleşen etkinliklerin veya değişikliklerin uygulanmasını bildirmek için çağrılacak işlevi döndürür.
|
GetRequestAck() const
|
bool
Sinyal sinyalinin Weave Güvenilir Mesajlaşma ile güvenilir şekilde gönderilip gönderilmeyeceğini belirten bir işaret döndürür.
|
GetSubscriptionState() const
|
uint8_t
Mevcut abonelik durumu değerini alın.
|
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
|
Weave Heartbeat Göndereni'ni başlatın.
|
ScheduleHeartbeat(void)
|
Weave Heartbeat mesajları gönderme işlemini planlayın.
|
SendHeartbeatNow(void)
|
Şimdi Weave Heartbeat mesajı gönderin.
|
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
|
void
Sinyal sinyali ayarlama yapılandırmasını ayarla.
|
SetEventCallback(EventCallback eventCallback)
|
void
WeaveHeartbeatSender içinde gerçekleşen etkinliklerin veya değişikliklerin uygulanmasını bildirmek için çağrılacak işlevi ayarlar.
|
SetRequestAck(bool val)
|
void
Sinyal mesajlarının Weave Güvenilir Mesajlaşma ile güvenilir şekilde gönderilip gönderilmeyeceğini belirten bir işaret ayarlar.
|
SetSubscriptionState(uint8_t val)
|
void
Mevcut abonelik durumunu ayarlayın.
|
Shutdown(void)
|
Weave Heartbeat Göndereni kapatın.
|
StartHeartbeat(void)
|
Weave Heartbeat mesajları göndermeye başlayın.
|
StopHeartbeat(void)
|
Weave Heartbeat mesajları gönderme.
|
Herkese açık statik işlevler |
|
---|---|
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
|
void
WeaveHeartbeatSender API etkinlikleri için varsayılan işleyici işlevi.
|
Struct |
|
---|---|
nl:: |
Parametreleri WeaveHeartbeatSender API etkinliğine girin. |
nl:: |
Parametreleri WeaveHeartbeatSender API etkinliğine çıkış yapın. |
Herkese açık türler
Etkinlik Geri Çağırması
void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
Etkinlik Türü
EventType
Özellikler | |
---|---|
kEvent_DefaultCheck
|
Uygulamada doğru varsayılan etkinlik işleme işlemini doğrulamak için kullanılır. Uygulamalar bu etkinliği açıkça KULLANMAMALIDIR. |
kEvent_HeartbeatFailed
|
Eşe sinyal mesajı gönderilemedi. |
kEvent_HeartbeatSent
|
Eşe başarılı bir şekilde sinyal gönderildi. Güvenilir iletim etkinse bu etkinlik, iletinin onaylandığını belirtir. |
kEvent_UpdateSubscriptionState
|
Uygulamadan abonelik durumunu güncellemesi istenir. |
Herkese açık özellikler
Uygulama Durumu
void * AppState
Herkese açık işlevler
GetConfiguration
void GetConfiguration( uint32_t & interval, uint32_t & phase, uint32_t & window ) const
Sinyal zamanlaması yapılandırması alın.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
GetEventCallBack
EventCallback GetEventCallback() const
WeaveHeartbeatSender içinde gerçekleşen etkinliklerin veya değişikliklerin uygulanmasını bildirmek için çağrılacak işlevi döndürür.
Alma İsteği
bool GetRequestAck() const
Sinyal sinyalinin Weave Güvenilir Mesajlaşma ile güvenilir şekilde gönderilip gönderilmeyeceğini belirten bir işaret döndürür.
Abonelik Abonelik Durumu
uint8_t GetSubscriptionState() const
Mevcut abonelik durumu değerini alın.
Başlangıç
WEAVE_ERROR Init( WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState )
Weave Heartbeat Göndereni'ni başlatın.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
Döndürülen Değerler |
|
Tarzı Dinleme
WEAVE_ERROR ScheduleHeartbeat( void )
Weave Heartbeat mesajları gönderme işlemini planlayın.
Ayrıntılar | |||||
---|---|---|---|---|---|
Döndürülen Değerler |
|
SendHeartbeatNow
WEAVE_ERROR SendHeartbeatNow( void )
Şimdi Weave Heartbeat mesajı gönderin.
Ayrıntılar | |||||
---|---|---|---|---|---|
Döndürülen Değerler |
|
SetYapılandırma
void SetConfiguration( uint32_t interval, uint32_t phase, uint32_t window )
Etkinlik Etkinliği Geri Çağırması
void SetEventCallback( EventCallback eventCallback )
WeaveHeartbeatSender içinde gerçekleşen etkinliklerin veya değişikliklerin uygulanmasını bildirmek için çağrılacak işlevi ayarlar.
Ayar İsteği Ack
void SetRequestAck( bool val )
Sinyal mesajlarının Weave Güvenilir Mesajlaşma ile güvenilir şekilde gönderilip gönderilmeyeceğini belirten bir işaret ayarlar.
Bu işaret yalnızca, aktarım olarak UDP'yi kullanırken anlamlıdır.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
Abonelik Abonelik Durumu
void SetSubscriptionState( uint8_t val )
Mevcut abonelik durumunu ayarlayın.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
Kapat
WEAVE_ERROR Shutdown( void )
StartHeartbeat
WEAVE_ERROR StartHeartbeat( void )
Weave Heartbeat mesajları göndermeye başlayın.
Ayrıntılar | |||||
---|---|---|---|---|---|
Döndürülen Değerler |
|
StopHeartbeat
WEAVE_ERROR StopHeartbeat( void )
WeaveHeartbeatGönderen
WeaveHeartbeatSender( void )
Herkese açık statik işlevler
VarsayılanEtkinlikHandler
void DefaultEventHandler( void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam )
WeaveHeartbeatSender API etkinlikleri için varsayılan işleyici işlevi.
Uygulamalar, işlemedikleri API etkinlikleri için bu işlevi çağırmalıdır.