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

To zajęcia abstrakcyjne.

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

Przekaż klasę do implementacji przychodzących operacji kontroli urządzenia na serwerze.

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ącego żądania DeviceControl.
IsPairedToAccount() const
virtual bool
Wywołuje się 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
Informuje, że upłynął czas oczekiwania na monitor połączenia.
OnFailSafeArmed(void)=0
virtual WEAVE_ERROR
Wskazuje, że tryb bezpieczny konfiguracji urządzenia jest włączony.
OnFailSafeDisarmed(void)=0
virtual WEAVE_ERROR
Wskazuje, że funkcja Bezpieczne konfigurację urządzenia została wyłączona.
OnRemotePassiveRendezvousDone(void)=0
virtual void
Wskazuje, że proces zdalnego pasywnego Rendezvous dobiegł końca.
OnRemotePassiveRendezvousStarted(void)=0
virtual void
Wskazuje, że rozpoczął się proces zdalnego pasywnego Rendezvous.
OnResetConfig(uint16_t resetFlags)=0
virtual WEAVE_ERROR
Resetowanie całości lub części konfiguracji urządzenia.
OnSystemTestStarted(uint32_t profileId, uint32_t testId)=0
virtual WEAVE_ERROR
Rozpocznij określony test systemu.
OnSystemTestStopped(void)=0
virtual WEAVE_ERROR
Zatrzymaj test systemu w toku.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags)=0
virtual bool
Ustal, czy połączenie z serwerem ma zostać zamknięte przed zresetowaniem konfiguracji.
WillCloseRemotePassiveRendezvous(void)=0
virtual void
Przygotuj się na zatrzymanie zdalnego pasywnego 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ącego żądania DeviceControl.

Szczegóły
Parametry
[in] ec
Parametr ExchangeContext, w którym otrzymano wiadomość.
[in] msgProfileId
Identyfikator profilu odebranej wiadomości.
[in] msgType
Typ otrzymanej wiadomości.
[in] msgInfo
Struktura WeaveMessageInfo zawierająca informacje o otrzymanej wiadomości.
[in,out] result
Wartość wyliczana opisująca wynik oceny zasad kontroli dostępu dla otrzymanej wiadomości. Po wejściu do metody wartość przedstawia wstępny wynik w bieżącym punkcie procesu oceny. Zwrócony wynik powinien odzwierciedlać ostateczną ocenę zasad kontroli dostępu dla wiadomości.

IsPairedToAccount

virtual bool IsPairedToAccount() const

Wywołuje się 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ę chcesz zresetować.
Zwracane wartości
TRUE
jeśli zresetowanie konfiguracji jest dozwolone.
FALSE
, jeśli resetowanie konfiguracji jest niedozwolone.

OnConnectionMonitorTimeout

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

Sygnalizuj, że upłynął czas oczekiwania na monitor połączenia.

Ta funkcja jest wywoływana po upłynięciu czasu oczekiwania na monitorze połączeń, czyli gdy kontrola żywotności nie została wykryta przez hosta zdalnego przez określony czas.

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

Wskazuje, że funkcja Bezpieczne konfigurację urządzenia jest włączona.

Ta funkcja jest wywoływana, gdy w odpowiedzi na żądanie klienta została włączona funkcja zabezpieczeń konfiguracji urządzenia na serwerze. Jeśli proces konfiguracji się nie powiedzie, konfiguracja urządzenia zostanie automatycznie przywrócona do znanego stanu.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.
other
Inne kody błędów Weave lub dotyczące platformy, które wskazują, że wystąpił błąd uniemożliwiający bezpieczne włączenie.

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
)=0

Wskazuje, że funkcja Bezpieczne konfigurację urządzenia została wyłączona.

Ta funkcja jest wywoływana, gdy funkcja bezpiecznego konfiguracji urządzenia na serwerze została wyłączona w odpowiedzi na żądanie klienta. Po zakończeniu konfiguracji klient wyłączy alarm w trybie awaryjnym.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.
other
Inne kody błędów Weave lub dotyczące platformy, które wskazują, że wystąpił błąd uniemożliwiający bezpieczne wyłączenie awaryjne.

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

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

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

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

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

Resetowanie całości lub części konfiguracji urządzenia.

Implementacja tej funkcji oczekuje na zresetowanie dowolnej kombinacji sieci, tkaniny Weave i konfiguracji usługi do znanego stanu, zgodnie z flagami resetowania.

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

OnSystemTestStarted

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

Rozpocznij określony test systemu.

Szczegóły
Parametry
[in] profileId
Identyfikator profilu żądanego testu.
[in] testId
Identyfikator żądanego testu.
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.
other
Inne kody błędów Weave lub dotyczące platformy, które wskazują, ż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
Powodzenie.
other
Inne kody błędów Weave lub dotyczące platformy, które wskazują, że wystąpił błąd uniemożliwiający zatrzymanie testu systemu.

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
)=0

Ustal, czy połączenie z serwerem ma zostać zamknięte przed zresetowaniem konfiguracji.

Ta funkcja służy do wysyłania do przedstawiciela zapytania o pożądane zachowanie podczas przetwarzania żądania zresetowania konfiguracji. Jeśli połączenie z serwerem jest obecnie aktywne, odpowiedź TRUE na tę metodę spowoduje zamknięcie połączenia, zanim reset konfiguracji zostanie aktywowany przez metodę OnResetConfig.

Szczegóły
Parametry
[in] resetFlags
Flagi określające, którą konfigurację chcesz zresetować.
Zwracane wartości
true
w sytuacji, gdy trzeba zamknąć połączenie.
false
, jeśli nie trzeba zamykać połączenia.

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
)=0

Przygotuj się na zatrzymanie zdalnego pasywnego rendezvous.

Zobacz też:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

Przygotuj się na zdalne, pasywne rendezvous.

Możesz na przykład zezwolić na łączenie sieci 15.4/Thread.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.
other
Inne kody błędów Weave lub dotyczące platformy, które wskazują, że podczas przygotowywania do uruchomienia zdalnego pasywnego rendezvous wystąpił błąd.