nl::Weave::WeaveServerBase

#include <src/lib/core/WeaveServerBase.h>

Gemeinsames Basisobjekt für die Implementierung unerwünschter antwortlicher Weave-Profile (Server), das das Validieren authentifizierter Anfragen und das Senden von Statusberichten einschließt und gemeinsamen Datenspeicher für den Fabric-Zustand und einen Exchange-Manager bietet.

Zusammenfassung

Übernahme











nl::Weave::Profiles::DeviceControl::DeviceControlServernl::Weave::Profiles::DeviceDescription::DeviceDescriptionServernl::Weave::Profiles::Echo_Next::WeaveEchoServernl::Weave::Profiles::FabricProvisioning::FabricProvisioningServernl::Weave::Profiles::Heartbeat::WeaveHeartbeatReceivernl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServernl::Weave::Profiles::ServiceProvisioning::ServiceProvisioningServernl::Weave::Profiles::TokenPairing::TokenPairingServernl::Weave::Profiles::Vendor::Nestlabs::DropcamLegacyPairing::DropcamLegacyPairingServernl::Weave::Profiles::WeaveEchoServer

Öffentliche Attribute
ExchangeMgr
[READ ONLY] Exchange-Manager-Objekt
FabricState
[READ ONLY] Fabric-Zustandsobjekt

Öffentliche statische Funktionen
SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
Einen Weave-Statusbericht mit Standardnachrichtenmarkierungen an den Initiator des angegebenen Anzeigenplattform senden, der den Statuscode im angegebenen Profil und den Systemfehler enthält.
SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError, uint16_t sendFlags)
Senden Sie einen Weave-Statusbericht mit den bereitgestellten Nachrichtenmarkierungen an den Initiator der angegebenen Anzeigenplattform, der den Statuscode im angegebenen Profil und den Systemfehler enthält.

Geschützte Funktionen
EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, WeaveServerDelegateBase *delegate)
bool
Legen Sie fest, ob eine bei einem Weave-Server eingehende Anfragenachricht akzeptiert oder verworfen werden soll.
WeaveServerBase(void)

Öffentliche Attribute

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[READ ONLY] Exchange-Manager-Objekt

FabricState

WeaveFabricState * FabricState

[READ ONLY] Fabric-Zustandsobjekt

Öffentliche statische Funktionen

SendStatusReport

WEAVE_ERROR SendStatusReport(
  ExchangeContext *ec,
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

Einen Weave-Statusbericht mit Standardnachrichtenmarkierungen an den Initiator des angegebenen Anzeigenplattform senden, der den Statuscode im angegebenen Profil und den Systemfehler enthält.

Details
Parameter
[in] ec
Ein Verweis auf den Anzeigenplattform-Kontext, für den der Statusbericht gesendet werden soll.
[in] statusProfileId
Das Profil für den angegebenen Statuscode.
[in] statusCode
Der zu sendende Statuscode.
[in] sysError
Der Systemfehler im Zusammenhang mit dem Statuscode oder damit korreliert.

SendStatusReport

WEAVE_ERROR SendStatusReport(
  ExchangeContext *ec,
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError,
  uint16_t sendFlags
)

Senden Sie einen Weave-Statusbericht mit den bereitgestellten Nachrichtenmarkierungen an den Initiator der angegebenen Anzeigenplattform, der den Statuscode im angegebenen Profil und den Systemfehler enthält.

Details
Parameter
[in] ec
Ein Verweis auf den Anzeigenplattform-Kontext, für den der Statusbericht gesendet werden soll.
[in] statusProfileId
Das Profil für den angegebenen Statuscode.
[in] statusCode
Der zu sendende Statuscode.
[in] sysError
Der Systemfehler im Zusammenhang mit dem Statuscode oder damit korreliert.
[in] sendFlags
Flags, die von der Anwendung für den gesendeten Weave-Statusbericht festgelegt wurden.

Geschützte Funktionen

EnforceAccessControl

bool EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  WeaveServerDelegateBase *delegate
)

Legen Sie fest, ob eine bei einem Weave-Server eingehende Anfragenachricht akzeptiert oder verworfen werden soll.

Diese Methode wird von Weave-Serverimplementierungen verwendet, um eine erweiterbare Zugriffssteuerungsrichtlinie für eingehende Anfragenachrichten zu implementieren. Bei Serverimplementierungen, die auf Delegate-Objekten basieren, sollte diese Methode frühzeitig während der Nachrichtenverarbeitung aufgerufen werden, um zu bestimmen, ob die Nachrichtenverarbeitung fortgesetzt werden soll.

Diese Methode ruft die virtuelle Methode WeaveServerDelegateBase::EnforceAccessControl() für den bereitgestellten Delegaten auf, um die Zugriffssteuerungsrichtlinie für die Nachricht auszuwerten. Weave Server Delegate-Klassen und anwendungsspezifische Bevollmächtigte, die aus den Standardserverklassen abgeleitet sind, sollten die virtuelle Methode überschreiben, um bestimmte Richtlinien für die Zugriffssteuerung zu erzwingen.

Details
Parameter
[in] ec
Der ExchangeContext, über den die Nachricht empfangen wurde.
[in] msgProfileId
Die Profil-ID der empfangenen Nachricht.
[in] msgType
Der Nachrichtentyp der empfangenen Nachricht.
[in] msgInfo
Eine WeaveMessageInfo-Struktur, die Informationen zur empfangenen Nachricht enthält.
[in] delegate
Das von der Anwendung bereitgestellte Delegate-Objekt, mit dem die Standardrichtlinie für die Nachrichtenzugriffssteuerung überschrieben werden kann.
Rückgabewerte
true
Ob die Nachricht wie gewohnt akzeptiert und verarbeitet werden soll.
false
Wenn die Nachrichtenverarbeitung beendet und die Nachricht verworfen werden soll.

WeaveServerBase

 WeaveServerBase(
  void
)