nl::Weave::Profiles::DeviceControl::DeviceControlServer

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

Serverklasse zum Implementieren des Device Control-Profils

Zusammenfassung

Übernahme

Übernimmt von: nl::Weave::WeaveServerBase
Direkte bekannte abgeleitete Klassen: nl::Weave::DeviceLayer::Internal::DeviceControlServer

Konstruktoren und Zerstörer
DeviceControlServer(void)

Geschützte Attribute
mCurClientOp
mDelegate
mFailSafeArmed
bool
mFailSafeToken
uint32_t
mRemotePassiveRendezvousClientCon
mRemotePassiveRendezvousEncryptionType
uint8_t
mRemotePassiveRendezvousJoinerAddr
mRemotePassiveRendezvousJoinerCon
mRemotePassiveRendezvousKeyId
uint16_t
mRemotePassiveRendezvousOp
mRemotePassiveRendezvousTimeout
uint16_t
mRemotePassiveRendezvousTunnel
mResetFlags
uint16_t
mTunnelInactivityTimeout
uint16_t

Öffentliche Funktionen
Init(WeaveExchangeManager *exchangeMgr)
Initialisieren Sie den Status des Gerätekontrollservers und registrieren Sie sich für den Empfang von Gerätekontrollnachrichten.
IsRemotePassiveRendezvousInProgress(void) const
bool
Gibt den Remote-Passiven-Rendezvous-Status zurück.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Senden Sie eine Statusberichtsantwort auf eine Anfrage.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Senden einer Erfolgsantwort auf eine Anfrage zur Gerätesteuerung.
SetDelegate(DeviceControlDelegate *delegate)
void
Den Bevollmächtigten so konfigurieren, dass er Ereignisse des Gerätekontrollservers verarbeitet.
Shutdown(void)
Fahren Sie den Gerätekontrollserver herunter.
SystemTestTimeout(void)
void

Geschützte Attribute

mCurClientOp

ExchangeContext * mCurClientOp

mDelegate

DeviceControlDelegate * mDelegate

mFailSafeArmed

bool mFailSafeArmed

mFailSafeToken

uint32_t mFailSafeToken

mRemotePassiveRendezvousClientCon

WeaveConnection * mRemotePassiveRendezvousClientCon

mRemotePassiveRendezvousEncryptionType

uint8_t mRemotePassiveRendezvousEncryptionType

mRemotePassiveRendezvousJoinerAddr

IPAddress mRemotePassiveRendezvousJoinerAddr

mRemotePassiveRendezvousJoinerCon

WeaveConnection * mRemotePassiveRendezvousJoinerCon

mRemotePassiveRendezvousKeyId

uint16_t mRemotePassiveRendezvousKeyId

mRemotePassiveRendezvousOp

ExchangeContext * mRemotePassiveRendezvousOp

mRemotePassiveRendezvousTimeout

uint16_t mRemotePassiveRendezvousTimeout

mRemotePassiveRendezvousTunnel

WeaveConnectionTunnel * mRemotePassiveRendezvousTunnel

mResetFlags

uint16_t mResetFlags

mTunnelInactivityTimeout

uint16_t mTunnelInactivityTimeout

Öffentliche Funktionen

DeviceControlServer

 DeviceControlServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Initialisieren Sie den Status des Gerätekontrollservers und registrieren Sie sich für den Empfang von Gerätekontrollnachrichten.

Details
Parameter
[in] exchangeMgr
Ein Zeiger auf den Weave Exchange Manager.
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn ein passiver Remote-Rendezvous-Server bereits registriert wurde
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Wenn zu viele unerwünschte Nachrichten-Handler registriert sind.
WEAVE_NO_ERROR
Bei Erfolg.

IsRemotePassiveRendezvousInProgress

bool IsRemotePassiveRendezvousInProgress(
  void
) const

Gibt den Remote-Passiven-Rendezvous-Status zurück.

Details
Rückgabewerte
TRUE
wenn Remote-Passive Rendezvous aktiv ist.
FALSE
wenn Remote Passive Rendezvous nicht ausgeführt wird.

SendStatusReport

virtual WEAVE_ERROR SendStatusReport(
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

Senden Sie eine Statusberichtsantwort auf eine Anfrage.

Details
Parameter
[in] statusProfileId
Die Weave-Profil-ID, auf die sich dieser Statusbericht bezieht.
[in] statusCode
Der Statuscode, der in diese Antwort eingefügt werden soll.
[in] sysError
Der Systemfehlercode, der in dieser Antwort enthalten sein soll.
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn gerade keine Anfrage bearbeitet wird.
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist und der Statusbericht nicht gesendet werden konnte.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Senden einer Erfolgsantwort auf eine Anfrage zur Gerätesteuerung.

Details
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn gerade keine Anfrage bearbeitet wird.
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist, der das Senden der Erfolgsantwort verhindert.

SetDelegate

void SetDelegate(
  DeviceControlDelegate *delegate
)

Den Bevollmächtigten so konfigurieren, dass er Ereignisse des Gerätekontrollservers verarbeitet.

Details
Parameter
[in] delegate
Ein Verweis auf den Bevollmächtigten für die Gerätesteuerung.

Herunterfahren

WEAVE_ERROR Shutdown(
  void
)

Fahren Sie den Gerätekontrollserver herunter.

Details
Rückgabewerte
WEAVE_NO_ERROR
bedingungslos.

SystemTestTimeout

void SystemTestTimeout(
  void
)