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

Herkese açık özellikler

AppState
void *

Herkese açık işlevler

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

Parametreleri WeaveHeartbeatSender API etkinliğine girin.

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

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

GetLinking

Binding * GetBinding() const 

Sinyal gönderen gönderenle ilişkili bağlama nesnesini alın.

GetConfiguration

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

Sinyal zamanlaması yapılandırması alın.

Ayrıntılar
Parametreler
[out] interval
Sinyal aralığı almak için bir tam sayı referansı.
[out] phase
Sinyal aşamasını almak için bir tam sayı referansı.
[out] window
Sinyal sinyali rastgele hale getirme aralığını almak için bir tam sayı referansı.

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
[in] exchangeMgr
Sistem Weave Exchange Yöneticisi'ne yönelik bir işaretçi.
[in] binding
Eş düğümünü ele almak için kullanılacak bir Weave bağlama nesnesine işaretçi.
[in] eventCallback
Etkinliklerin uygulanmasını veya gönderende gerçekleşen değişiklikleri bildirmek için çağrılacak bir işlev işaretçisi.
[in] appState
Uygulamaya özel verilerin işaretçisi. Bu işaretçi, uygulamaya yapılan geri çağırmalarda döndürülecek.
Döndürülen Değerler
WEAVE_ERROR_INCORRECT_STATE
WeaveHeartbeatSender nesnesi zaten başlatılmışsa.
WEAVE_ERROR_INVALID_ARGUMENT
Sağlanan bağımsız değişkenlerden herhangi biri boşsa.
WEAVE_NO_ERROR
Başarılı.

Tarzı Dinleme

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Weave Heartbeat mesajları gönderme işlemini planlayın.

Ayrıntılar
Döndürülen Değerler
WEAVE_SYSTEM_ERROR_NO_MEMORY
StartZamanlayıcı() başarısız olduysa
WEAVE_NO_ERROR
başarıyla ilgili

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

Şimdi Weave Heartbeat mesajı gönderin.

Ayrıntılar
Döndürülen Değerler
WEAVE_ERROR_INCORRECT_STATE
WeaveHeartbeatSender başlatılmadıysa
WEAVE_NO_ERROR
başarıyla ilgili

SetYapılandırma

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

Sinyal sinyali ayarlama yapılandırmasını ayarla.

Ayrıntılar
Parametreler
[in] interval
Weave Heartbeat mesajları gönderirken kullanılacak aralık.
[in] phase
Weave Heartbeat mesajları gönderirken kullanılacak aşama.
[in] window
Rastgele aralık seçmek için kullanılacak aralık aralığı

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
[in] val
Sinyal sesleri güvenilir bir şekilde gönderilmelidirsa true değerini alır.

Abonelik Abonelik Durumu

void SetSubscriptionState(
  uint8_t val
)

Mevcut abonelik durumunu ayarlayın.

Ayrıntılar
Parametreler
[in] val
Sinyal mesajıyla iletilecek 8 bit abonelik durumu değeri.

Kapat

WEAVE_ERROR Shutdown(
  void
)

Weave Heartbeat Göndereni kapatın.

Ayrıntılar
Döndürülen Değerler
WEAVE_NO_ERROR
Başarılı.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Weave Heartbeat mesajları göndermeye başlayın.

Ayrıntılar
Döndürülen Değerler
INET_ERROR_NO_MEMORY
StartZamanlayıcı() başarısız olduysa
WEAVE_NO_ERROR
başarıyla ilgili

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Weave Heartbeat mesajları gönderme.

Ayrıntılar
Döndürülen Değerler
WEAVE_NO_ERROR
koşulsuz olarak

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.