nl::Weave::DeviceLayer::Internal::DeviceControlServer

#include <src/adaptations/device-layer/include/Weave/DeviceLayer/internal/DeviceControlServer.h>

Implementiert das Weave Device Control-Profil für ein Weave-Gerät.

Zusammenfassung

Übernahme

Übernimmt von:
  nl::Weave::Profiles::DeviceControl::DeviceControlServer
  nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

Öffentliche Funktionen

Init()
IsPairedToAccount() const override
virtual bool
Wird aufgerufen, um festzustellen, ob das Gerät derzeit mit einem Konto gekoppelt ist.
IsResetAllowed(uint16_t resetFlags) override
virtual bool
Prüfen Sie, ob das Zurücksetzen der angegebenen Konfiguration zulässig ist.
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr) override
void
OnFailSafeArmed(void) override
virtual WEAVE_ERROR
Zeigt an, dass die Gerätekonfiguration „Fail Safe“ scharf geschaltet wurde.
OnFailSafeDisarmed(void) override
virtual WEAVE_ERROR
Zeigt an, dass die Gerätekonfiguration „Fail Safe“ unscharf geschaltet wurde.
OnPlatformEvent(const WeaveDeviceEvent *event)
void
OnRemotePassiveRendezvousDone(void) override
virtual void
Gibt an, dass der Remote-Passive Rendezvous-Prozess abgeschlossen ist.
OnRemotePassiveRendezvousStarted(void) override
virtual void
Gibt an, dass der Remote-Passive Rendezvous-Prozess gestartet wurde.
OnResetConfig(uint16_t resetFlags) override
virtual WEAVE_ERROR
Gerätekonfiguration vollständig oder teilweise zurücksetzen.
OnSystemTestStarted(uint32_t profileId, uint32_t testId) override
virtual WEAVE_ERROR
Startet den angegebenen Systemtest.
OnSystemTestStopped(void) override
virtual WEAVE_ERROR
Stoppen Sie den laufenden Systemtest.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags) override
virtual bool
Bestimmen Sie, ob eine Serververbindung, falls vorhanden, vor dem Zurücksetzen der Konfiguration geschlossen werden soll.
WillCloseRemotePassiveRendezvous(void) override
virtual void
Stoppen Sie das Remote-Passive Rendezvous.
WillStartRemotePassiveRendezvous(void) override
virtual WEAVE_ERROR
Bereite dich auf ein passives Rendezvous vor.

Geschützte Funktionen

DeviceControlServer()=default
DeviceControlServer(const DeviceControlServer &)=delete
DeviceControlServer(const DeviceControlServer &&)=delete
operator=(const DeviceControlServer &)=delete
~DeviceControlServer()=default

Öffentliche Funktionen

Init

WEAVE_ERROR Init()

IsPairedToAccount

virtual bool IsPairedToAccount() const override

Wird aufgerufen, um festzustellen, ob das Gerät derzeit mit einem Konto gekoppelt ist.

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
) override

Prüfen Sie, ob das Zurücksetzen der angegebenen Konfiguration zulässig ist.

Details
Parameter
[in] resetFlags
Die Flags, die angeben, welche Konfiguration zurückgesetzt werden soll.
Rückgabewerte
TRUE
wenn das Zurücksetzen der Konfiguration erlaubt ist.
FALSE
wenn die Konfiguration nicht zurückgesetzt werden kann.

OnConnectionMonitorTimeout

void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
) override

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
) override

Zeigt an, dass die Ausfallsicherheit der Gerätekonfiguration scharf geschaltet wurde.

Diese Funktion wird aufgerufen, wenn die Ausfallsicherheit der Servergerätekonfiguration als Reaktion auf eine Anfrage vom Client scharf geschaltet wurde. Wenn der Konfigurationsprozess fehlschlägt, wird die Gerätekonfiguration automatisch auf einen bekannten Status zurückgesetzt.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die auf einen Fehler hinweisen, der die Sicherung der Fail-Safe-Verwarnung verhindert.

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
) override

Zeigt an, dass die Gerätekonfiguration „Fail Safe“ unscharf geschaltet wurde.

Diese Funktion wird aufgerufen, wenn die Ausfallsicherheit der Servergerätekonfiguration als Reaktion auf eine Anfrage vom Client unscharf geschaltet wurde. Der Client schaltet die Fail-Safe-Funktion nach Abschluss der Konfiguration unscharf.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die auf einen Fehler hinweisen, der das Unscharfschalten des Fail Safe verhindert.

OnPlatformEvent

void OnPlatformEvent(
  const WeaveDeviceEvent *event
)

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
) override

Gibt an, dass der Remote-Passive Rendezvous-Prozess abgeschlossen ist.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
) override

Gibt an, dass der Remote-Passive Rendezvous-Prozess gestartet wurde.

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
) override

Gerätekonfiguration vollständig oder teilweise zurücksetzen.

Bei der Implementierung dieser Funktion wird erwartet, dass jede Kombination aus Netzwerk-, Weave-Fabric- oder Dienstkonfigurationen gemäß den Flags zum Zurücksetzen auf einen bekannten Zustand zurückgesetzt wird.

Details
Parameter
[in] resetFlags
Die Flags, die angeben, welche Konfiguration zurückgesetzt werden soll.
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist und die Konfiguration des Geräts nicht zurückgesetzt werden konnte.

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
) override

Startet den angegebenen Systemtest.

Details
Parameter
[in] profileId
Die ID des Profils des angeforderten Tests.
[in] testId
Die ID des angeforderten Tests.
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist, der das Starten des Systemtests verhindert.

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
) override

Stoppen Sie den laufenden Systemtest.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist, der das Beenden des Systemtests verhindert.

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
) override

Bestimmen Sie, ob eine Serververbindung, falls vorhanden, vor dem Zurücksetzen der Konfiguration geschlossen werden soll.

Mit dieser Funktion wird das gewünschte Verhalten beim Verarbeiten einer Anfrage zum Zurücksetzen der Konfiguration vom Bevollmächtigten abgefragt. Wenn eine Serververbindung derzeit aktiv ist, führt die Antwort TRUE auf diese Methode dazu, dass diese Verbindung geschlossen wird, bevor die Konfiguration über die Methode OnResetConfig ausgelöst wird.

Details
Parameter
[in] resetFlags
Die Flags, die angeben, welche Konfiguration zurückgesetzt werden soll.
Rückgabewerte
true
wenn die Verbindung geschlossen werden muss.
false
wenn die Verbindung nicht geschlossen werden muss.

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
) override

Stoppen Sie das Remote-Passive Rendezvous.

Weitere Informationen:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
) override

Bereite dich auf ein passives Rendezvous vor.

Sorgen Sie beispielsweise dafür, dass das Netzwerk 15.4/Thread verbunden werden kann.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass bei der Vorbereitung auf den Start von Remote Passive Rendezvous ein Fehler aufgetreten ist.

Geschützte Funktionen

DeviceControlServer

 DeviceControlServer()=default

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &
)=delete

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

operator=

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~DeviceControlServer

 ~DeviceControlServer()=default