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

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

Heartbeat Gönderen sınıfıdır.

Ö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 *

Herkese açık işlevler
GetBinding() const
Sinyal göndereni ile ilişkilendirilen 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'da 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 mesajlarının Weave Reliable Messaging ile güvenilir bir ş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önderenini başlatın.
ScheduleHeartbeat(void)
Weave Heartbeat mesajlarının gönderilmesini planlayı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'da gerçekleşen etkinlikleri veya değişiklikleri uygulamaya bildirmek için çağrılacak işlevi ayarlar.
SetRequestAck(bool val)
void
Sinyal mesajlarının Weave Reliable Messaging kullanılarak güvenilir bir ş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önderen'i kapatın.
StartHeartbeat(void)
Weave Heartbeat mesajları göndermeye başlayın.
StopHeartbeat(void)
Weave Heartbeat mesajları göndermeyi durdurun.

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 parametre girin.

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 etkinlik işlemenin doğru olduğunu doğrulamak için kullanılır.

Uygulamalar bu etkinliği açık bir şekilde işlememelidir.

kEvent_HeartbeatFailed

Benzer kişiye sinyal mesajı gönderilemedi.

kEvent_HeartbeatSent

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

Güvenilir iletim etkinleştirilmişse bu etkinlik mesajın onaylandığını gösterir.

kEvent_UpdateSubscriptionState

Uygulamanın, abonelik durumunu güncellemesi istenir.

Herkese açık özellikler

AppState

void * AppState

Herkese açık işlevler

GetBinding

Binding * GetBinding() const

Sinyal göndereni ile 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ı 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 penceresini almak için bir tam sayıya referans.

GetEventCallback

EventCallback GetEventCallback() const

WeaveHeartbeatSender'da gerçekleşen etkinliklerin veya değişikliklerin uygulanmasını bildirmek için çağrılacak işlevi döndürür.

GetRequestAck

bool GetRequestAck() const

Sinyal mesajlarının Weave Reliable Messaging ile güvenilir bir ş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.

Init

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

Weave Heartbeat Gönderenini başlatın.

Ayrıntılar
Parametreler
[in] exchangeMgr
Weave Exchange Manager sistem işaretçisi.
[in] binding
Eş düğüme yönlendirme yapmak için kullanılacak Weave bağlama nesnesinin işaretçisi.
[in] eventCallback
Gönderende gerçekleşen etkinliklerin veya durum değişikliklerini uygulamaya bildirmek için çağrılacak bir işlevin işaretçisi.
[in] appState
Uygulamaya özel veriler için bir işaretçi. Bu işaretçi, uygulamaya yapılan geri çağırmalarda döndürülür.
Değerleri Döndür
WEAVE_ERROR_INCORRECT_STATE
WeaveHeartbeatSender nesnesi zaten başlatıldıysa.
WEAVE_ERROR_INVALID_ARGUMENT
Sağlanan bağımsız değişkenlerden herhangi biri boşsa.
WEAVE_NO_ERROR
Başarıya merhaba.

ScheduleHeartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Weave Heartbeat mesajlarının gönderilmesini planlayın.

Ayrıntılar
Değerleri Döndür
WEAVE_SYSTEM_ERROR_NO_MEMORY
StartZamanlayıcı() başarısız olursa
WEAVE_NO_ERROR
başarı üzerine

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

Hemen Weave Heartbeat mesajı gönderin.

Ayrıntılar
Değerleri Döndür
WEAVE_ERROR_INCORRECT_STATE
WeaveHeartbeatSender başlatılmadıysa
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ö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ığı

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

WeaveHeartbeatSender'da gerçekleşen etkinlikleri veya değişiklikleri uygulamaya bildirmek için çağrılacak işlevi ayarlar.

SetRequestAck

void SetRequestAck(
  bool val
)

Sinyal mesajlarının Weave Reliable Messaging kullanılarak güvenilir bir şekilde gönderilip gönderilmeyeceğini gösteren bir işaret ayarlar.

Bu işaretin yalnızca aktarım olarak UDP kullanılı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 döndürü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önderen'i kapatın.

Ayrıntılar
Değerleri Döndür
WEAVE_NO_ERROR
Başarıya merhaba.

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

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

Ayrıntılar
Değerleri Döndür
INET_ERROR_NO_MEMORY
StartZamanlayıcı() başarısız olursa
WEAVE_NO_ERROR
başarı üzerine

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Weave Heartbeat mesajları göndermeyi durdurun.

Ayrıntılar
Değerleri Döndür
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ın, işlemedikleri API etkinlikleri için bu işlevi çağırmaları gerekir.