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

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

Serverklasse zur Implementierung des Gerätesteuerungsprofils

Zusammenfassung

Übernahme

Übernommen von: nl::Weave::WeaveServerBase
Direkte bekannte Unterklassen: 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ätesteuerungsnachrichten.
IsRemotePassiveRendezvousInProgress(void) const
bool
Gibt den Status „Remote Passive Rendezvous“ zurück.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Eine Statusberichtsantwort auf eine Anfrage senden.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Senden Sie eine Erfolgsantwort auf eine Gerätesteuerungsanfrage.
SetDelegate(DeviceControlDelegate *delegate)
void
Legen Sie fest, dass der Bevollmächtigte Device Control Server-Ereignisse verarbeitet.
Shutdown(void)
Fahren Sie den Device Control Server 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ätesteuerungsnachrichten.

Details
Parameter
[in] exchangeMgr
Ein Verweis auf den Weave Exchange Manager.
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn ein passiver Rendezvous-Remoteserver 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 Status „Remote Passive Rendezvous“ zurück.

Details
Rückgabewerte
TRUE
wenn ein passives Remote-Rendezvous läuft.
FALSE
Wenn ein passives Remote-Rendezvous nicht ausgeführt wird.

SendStatusReport

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

Eine Statusberichtsantwort auf eine Anfrage senden.

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 diese Antwort eingefügt werden muss.
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn keine Anfrage verarbeitet wird.
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die auf einen Fehler hinweisen, der das Senden des Statusberichts verhindert hat.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Senden Sie eine Erfolgsantwort auf eine Gerätesteuerungsanfrage.

Details
Rückgabewerte
WEAVE_ERROR_INCORRECT_STATE
Wenn keine Anfrage verarbeitet wird.
WEAVE_NO_ERROR
Bei Erfolg.
other
Andere Weave- oder plattformspezifische Fehlercodes, die darauf hinweisen, dass ein Fehler aufgetreten ist und die Erfolgsantwort nicht gesendet werden konnte.

SetDelegate

void SetDelegate(
  DeviceControlDelegate *delegate
)

Legen Sie fest, dass der Bevollmächtigte Device Control Server-Ereignisse verarbeitet.

Details
Parameter
[in] delegate
Ein Zeiger auf den Device Control Delegate.

Herunterfahren

WEAVE_ERROR Shutdown(
  void
)

Fahren Sie den Device Control Server herunter.

Details
Rückgabewerte
WEAVE_NO_ERROR
bedingungslos.

SystemTestTimeout

void SystemTestTimeout(
  void
)