nl::Weave::Profiles::FabricProvisioning::FabricProvisioningServer

#include <src/lib/profiles/fabric-provisioning/FabricProvisioning.h>

Serverklasse zur Implementierung des Fabric-Bereitstellungsprofils.

Zusammenfassung

Übernahme

Übernimmt von: nl::Weave::WeaveServerBase
Direkte bekannte Unterklassen: nl::Weave::DeviceLayer::Internal::FabricProvisioningServer

Konstruktoren und Zerstörer
FabricProvisioningServer(void)

Geschützte Attribute
mCurClientOp
mDelegate

Öffentliche Funktionen
Init(WeaveExchangeManager *exchangeMgr)
Initialisieren Sie den Status des Fabric-Bereitstellungsservers und registrieren Sie sich, um Nachrichten zur Fabric-Bereitstellung zu erhalten.
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 Anfrage für die Fabric-Bereitstellung.
SessionHasFabricConfigAccessPrivilege(uint16_t keyId, uint64_t peerNodeId) const
bool
Gibt an, ob die Sitzung mit der angegebenen Knoten-ID und der Sitzungsschlüssel-ID berechtigt ist, Informationen zur Fabric-Konfiguration abzurufen.
SetDelegate(FabricProvisioningDelegate *delegate)
void
Legen Sie den Bevollmächtigten für die Verarbeitung von Fabric-Bereitstellungsereignissen fest.
Shutdown(void)
Fahren Sie den Fabric-Bereitstellungsserver herunter.

Geschützte Attribute

mCurClientOp

ExchangeContext * mCurClientOp

mDelegate

FabricProvisioningDelegate * mDelegate

Öffentliche Funktionen

FabricProvisioningServer

 FabricProvisioningServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Initialisieren Sie den Status des Fabric-Bereitstellungsservers und registrieren Sie sich, um Nachrichten zur Fabric-Bereitstellung zu erhalten.

Details
Parameter
[in] exchangeMgr
Ein Verweis auf das Weave Exchange Manager-System.
Rückgabewerte
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Wenn bereits zu viele Nachrichten-Handler registriert wurden.
WEAVE_NO_ERROR
Bei Erfolg.

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 darauf hinweisen, dass ein Fehler aufgetreten ist, der das Senden des Statuscodes verhindert.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Senden Sie eine Erfolgsantwort auf eine Anfrage für die Fabric-Bereitstellung.

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, der das Senden der Erfolgsantwort verhindert.

SessionHasFabricConfigAccessPrivilege

bool SessionHasFabricConfigAccessPrivilege(
  uint16_t keyId,
  uint64_t peerNodeId
) const

Gibt an, ob die Sitzung mit der angegebenen Knoten-ID und der Sitzungsschlüssel-ID berechtigt ist, Informationen zur Fabric-Konfiguration abzurufen.

Details
Rückgabe
Gibt "true" zurück, wenn der entsprechende Peer privilegiert ist. Andernfalls wird "false" zurückgegeben.

SetDelegate

void SetDelegate(
  FabricProvisioningDelegate *delegate
)

Legen Sie den Bevollmächtigten für die Verarbeitung von Fabric-Bereitstellungsereignissen fest.

Details
Parameter
[in] delegate
Ein Zeiger auf den Fabric-Bereitstellungs-Delegaten.

Herunterfahren

WEAVE_ERROR Shutdown(
  void
)

Fahren Sie den Fabric-Bereitstellungsserver herunter.

Details
Rückgabewerte
WEAVE_NO_ERROR
bedingungslos.