nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

To jest klasa abstrakcyjna.

#include <src/lib/profiles/device-control/DeviceControl.h>

Klasa przedstawiciela do wdrażania operacji przychodzących na urządzeniu po stronie serwera.

Podsumowanie

Dziedziczenie

Dziedziczy z: nl::Weave::WeaveServerDelegateBase
Bezpośrednie znane podklasy: nl::Weave::DeviceLayer::Internal::DeviceControlServer

Funkcje publiczne

EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
Wymuś kontrolę dostępu na poziomie wiadomości dla przychodzących wiadomości z prośbą DeviceControl.
IsPairedToAccount() const
virtual bool
Wywoływana w celu określenia, czy urządzenie jest obecnie sparowane z kontem.
IsResetAllowed(uint16_t resetFlags)=0
virtual bool
Sprawdź, czy można zresetować określoną konfigurację.
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr)=0
virtual void
Określ, że upłynął limit czasu monitorowania połączenia.
OnFailSafeArmed(void)=0
virtual WEAVE_ERROR
Wskaż, że konfiguracja urządzenia nie powiodła się i tryb awaryjny został włączony.
OnFailSafeDisarmed(void)=0
virtual WEAVE_ERROR
Wskaż, że konfiguracja urządzenia nie powiodła się i została wyłączona.
OnRemotePassiveRendezvousDone(void)=0
virtual void
Wskazuje, że proces zdalnego pasywnego rezonansu dobiegł końca.
OnRemotePassiveRendezvousStarted(void)=0
virtual void
Wskazuje, że rozpoczął się proces zdalnego pasywnego rezonansu.
OnResetConfig(uint16_t resetFlags)=0
virtual WEAVE_ERROR
Zresetuj całą konfigurację urządzenia lub jej część.
OnSystemTestStarted(uint32_t profileId, uint32_t testId)=0
virtual WEAVE_ERROR
Uruchom określony test systemu.
OnSystemTestStopped(void)=0
virtual WEAVE_ERROR
Zatrzymaj test systemu w toku.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags)=0
virtual bool
Ustal, czy przed zresetowaniem konfiguracji powinno zostać zakończone połączenie z serwerem (jeśli występuje).
WillCloseRemotePassiveRendezvous(void)=0
virtual void
Przygotuj się na odejście od dalekich pasywnych rendezvous.
WillStartRemotePassiveRendezvous(void)=0
virtual WEAVE_ERROR
Przygotuj się na zdalne pasywne rendezvous.

Funkcje publiczne

EnforceAccessControl

virtual void EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  AccessControlResult & result
)

Wymuś kontrolę dostępu na poziomie wiadomości dla przychodzących wiadomości z prośbą DeviceControl.

Szczegóły
Parametry
[in] ec
ExchangeContext, przez które została odebrana wiadomość.
[in] msgProfileId
Identyfikator profilu odebranej wiadomości.
[in] msgType
Typ odebranej wiadomości.
[in] msgInfo
Struktura WeaveMessageInfo zawierająca informacje o odebranej wiadomości.
[in,out] result
Wartość wyliczona opisująca wynik oceny zasady kontroli dostępu dla odebranej wiadomości. Po wprowadzeniu tej metody wartość reprezentuje wstępny wynik na bieżącym etapie procesu oceny. Po zwróceniu wynik powinien stanowić ostateczną ocenę zasad kontroli dostępu dla wiadomości.

IsPairedToAccount

virtual bool IsPairedToAccount() const 

Wywoływana w celu określenia, czy urządzenie jest obecnie sparowane z kontem.

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
)=0

Sprawdź, czy można zresetować określoną konfigurację.

Szczegóły
Parametry
[in] resetFlags
Flagi określające, którą konfigurację zresetować.
Zwracane wartości
TRUE
, jeśli resetowanie konfiguracji jest dozwolone.
FALSE
, jeśli resetowanie konfiguracji jest niedozwolone.

OnConnectionMonitorTimeout

virtual void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
)=0

Określ, że upłynął limit czasu monitorowania połączenia.

Ta funkcja jest wywoływana po przekroczeniu limitu czasu oczekiwania monitora połączeń, czyli gdy przez określony czas nie wykryto kontroli żywotności z hosta zdalnego.

Szczegóły
Parametry
[in] peerNodeId
Identyfikator węzła zdalnego peera, z którym przekroczono limit czasu życia połączenia.
[in] peerAddr
Adres zdalnego peera.

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

Wskaż, że konfiguracja urządzenia nie powiodła się i tryb awaryjny został włączony.

Ta funkcja jest wywoływana, gdy w odpowiedzi na żądanie klienta włączono tryb awaryjny, w którym konfiguracja urządzenia serwera została włączona. Jeśli proces konfiguracji się nie powiedzie, konfiguracja urządzenia zostanie automatycznie zresetowana do znanego stanu.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.
other
Inne kody błędów Weave lub dotyczące konkretnej platformy wskazujące, że wystąpił błąd, który uniemożliwia bezpieczne włączenie.

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
)=0

Wskaż, że konfiguracja urządzenia nie powiodła się i została wyłączona.

Funkcja ta jest wywoływana, gdy w odpowiedzi na żądanie klienta nastąpiło wyłączenie funkcji bezpiecznego konfiguracji urządzenia serwera. Po ukończeniu konfiguracji klient wyłączy tryb awaryjny.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.
other
Inne kody błędów Weave lub dotyczące platformy wskazujące, że wystąpił błąd, który uniemożliwia wyłączenie alarmu.

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

Wskazuje, że proces zdalnego pasywnego rezonansu dobiegł końca.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

Wskazuje, że rozpoczął się proces zdalnego pasywnego rezonansu.

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

Zresetuj całą konfigurację urządzenia lub jej część.

Implementacja tej funkcji powinna zresetować dowolną kombinację konfiguracji sieci, sieci Weave i usługi do znanego stanu, zgodnie z flagami resetowania.

Szczegóły
Parametry
[in] resetFlags
Flagi określające, którą konfigurację zresetować.
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.
other
Inne kody błędów Weave lub dotyczące platformy wskazujące, że wystąpił błąd, który uniemożliwia urządzeniu zresetowanie konfiguracji.

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
)=0

Uruchom określony test systemu.

Szczegóły
Parametry
[in] profileId
Identyfikator profilu żądanego testu.
[in] testId
Identyfikator żądanego testu.
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.
other
Inne kody błędów Weave lub platformy wskazujące, że wystąpił błąd uniemożliwiający rozpoczęcie testu systemu.

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
)=0

Zatrzymaj test systemu w toku.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.
other
Inne kody błędów Weave lub platformy wskazujące, że wystąpił błąd uniemożliwiający zatrzymanie testu systemu.

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
)=0

Ustal, czy przed zresetowaniem konfiguracji powinno zostać zakończone połączenie z serwerem (jeśli występuje).

Ta funkcja służy do wysyłania do delegata zapytania o odpowiednie działanie podczas przetwarzania żądania resetowania konfiguracji. Jeśli połączenie z serwerem jest w tej chwili aktywne, odpowiedź TRUE (PRAWDA) spowoduje zamknięcie połączenia przed zresetowaniem konfiguracji za pomocą metody OnResetConfig.

Szczegóły
Parametry
[in] resetFlags
Flagi określające, którą konfigurację zresetować.
Zwracane wartości
true
jeśli trzeba zamknąć połączenie.
false
jeśli połączenie nie musi być zamykane.

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
)=0

Przygotuj się na odejście od dalekich pasywnych rendezvous.

Zobacz też:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

Przygotuj się na zdalne pasywne rendezvous.

Możesz na przykład włączyć możliwość złączania sieci 15.4/Thread.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.
other
Inne kody błędów Weave lub specyficznych dla platformy wskazujące, że wystąpił błąd podczas przygotowywania do uruchomienia zdalnego pasywnego kanału Rendezvous.