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

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

Weave Heartbeat (Gönderen) sınıfı.

Özet

Oluşturucular ve Yıkıcılar
WeaveHeartbeatSender(void)

Herkese açık türler
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

Herkese açık özellikler
AppState
void *

Kamu işlevleri
GetBinding() const
Sinyal göndericisiyle ilişkilendirilen bağlama nesnesini alın.
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
void
Sinyal zamanlaması yapılandırmasını alın.
GetEventCallback() const
EventCallback
WeaveHeartbeatSender'de meydana gelen etkinliklerin veya değişikliklerin uygulamasını bildirmek için çağrılacak işlevi döndürür.
GetRequestAck() const
bool
Weave Reliable Messaging, sinyal mesajlarının güvenilir şekilde gönderilip gönderilmeyeceğini gösteren bir işaret döndürür.
GetSubscriptionState() const
uint8_t
Geçerli abonelik durumu değerini alın.
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
Weave Heartbeat Göndereni başlatın.
ScheduleHeartbeat(void)
Weave Heartbeat mesajları için zaman planlaması yapın.
SendHeartbeatNow(void)
Hemen Weave Heartbeat mesajı gönderin.
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
void
Sinyal zamanlaması yapılandırmasını ayarlayın.
SetEventCallback(EventCallback eventCallback)
void
WeaveHeartbeatSender'de meydana gelen etkinliklerin veya değişikliklerin uygulamasını bildirmek için çağrılacak işlevi ayarlar.
SetRequestAck(bool val)
void
Weave Reliable Messaging sayesinde, sinyal mesajlarının güvenilir şekilde gönderilip gönderilmeyeceğini gösteren bir işaret ayarlar.
SetSubscriptionState(uint8_t val)
void
Geçerli abonelik durumunu ayarlayın.
Shutdown(void)
Weave Heartbeat Göndereni kapatın.
StartHeartbeat(void)
Weave Heartbeat mesajlarını göndermeye başlayın.
StopHeartbeat(void)
Weave Heartbeat mesajlarının gönderilmesine son verin.

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.

Yapılar
nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender::InEventParam

WeaveHeartbeatSender API etkinliğine giriş parametreleri.

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

WeaveHeartbeatSender API etkinliğine çıkış parametreleri.

Herkese açık türler

EventCallback

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

EventType

 EventType
Özellikler
kEvent_DefaultCheck

Uygulamada varsayılan olay işlemenin doğru olduğunu doğrulamak için kullanılır.

Uygulamalar bu etkinliği açıkça İŞLEME ALMAMALIDIR.

kEvent_HeartbeatFailed

Eşe sinyal mesajı gönderilemedi.

kEvent_HeartbeatSent

Eşe sinyal mesajı başarıyla gönderildi.

Güvenilir iletim etkinse bu etkinlik, iletinin onaylandığını gösterir.

kEvent_UpdateSubscriptionState

Uygulamadan, abonelik durumunu güncellemesi istenir.

Herkese açık özellikler

AppState

void * AppState

Kamu işlevleri

GetBinding

Binding * GetBinding() const

Sinyal göndericisiyle ilişkilendirilen bağlama nesnesini alın.

GetConfiguration

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

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

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

GetEventCallback

EventCallback GetEventCallback() const

WeaveHeartbeatSender'de meydana gelen etkinliklerin veya değişikliklerin uygulamasını bildirmek için çağrılacak işlevi döndürür.

GetRequestAck

bool GetRequestAck() const

Weave Reliable Messaging, sinyal mesajlarının güvenilir şekilde gönderilip gönderilmeyeceğini gösteren bir işaret döndürür.

GetSubscriptionState

uint8_t GetSubscriptionState() const

Geçerli abonelik durumu değerini alın.

Başlat

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

Weave Heartbeat Göndereni başlatın.

Ayrıntılar
Parametreler
[in] exchangeMgr
Sistem Weave Exchange Manager için işaretçi.
[in] binding
Eş düğümü ele almak için kullanılacak Weave bağlama nesnesinin işaretçisi.
[in] eventCallback
Gönderende meydana gelen olayların veya durum değişikliklerinin uygulamasını bildirmek için çağrılacak bir işlevin işaretçisi.
[in] appState
Uygulamaya özel verilere işaret eden bir işaretçi. Bu işaretçi, uygulamaya yapılan geri çağırmalarda döndürülür.
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ı olun.

ScheduleHeartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Weave Heartbeat mesajları için zaman planlaması yapı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ı üzerine

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

Hemen Weave Heartbeat mesajı gönderin.

Ayrıntılar
Döndürülen Değerler
WEAVE_ERROR_INCORRECT_STATE
WeaveHeartbeatSender başlatılmazsa
WEAVE_NO_ERROR
başarı üzerine

SetConfiguration

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

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

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

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

WeaveHeartbeatSender'de meydana gelen etkinliklerin veya değişikliklerin uygulamasını bildirmek için çağrılacak işlevi ayarlar.

SetRequestAck

void SetRequestAck(
  bool val
)

Weave Reliable Messaging sayesinde, sinyal mesajlarının güvenilir şekilde gönderilip gönderilmeyeceğini gösteren bir işaret ayarlar.

Bu işaretin yalnızca, aktarım olarak UDP'yi kullanırken anlamlı olduğunu unutmayın.

Ayrıntılar
Parametreler
[in] val
Sinyal mesajlarının güvenilir bir şekilde gönderilmesi gerekiyorsa doğru değerini alır.

SetSubscriptionState

void SetSubscriptionState(
  uint8_t val
)

Geçerli 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ı olun.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Weave Heartbeat mesajlarını 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ı üzerine

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Weave Heartbeat mesajlarının gönderilmesine son verin.

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

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

Herkese açık statik işlevler

DefaultEventHandler

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.