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

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

Klasa serwera do implementacji profilu obsługi administracyjnej Fabric.

Podsumowanie

Dziedziczenie

Dziedziczy z: nl::Weave::WeaveServerBase
Bezpośrednie znane podklasy: nl::Weave::DeviceLayer::Internal::FabricProvisioningServer

Konstruktory i niszczyciele

FabricProvisioningServer(void)

Atrybuty chronione

mCurClientOp
mDelegate

Funkcje publiczne

Init(WeaveExchangeManager *exchangeMgr)
Zainicjuj stan serwera obsługi administracyjnej Fabric i zarejestruj się, aby otrzymywać komunikaty dotyczące obsługi administracyjnej Fabric.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Wyślij odpowiedź na żądanie z raportem o stanie.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Wyślij odpowiedź na żądanie obsługi administracyjnej Fabric.
SessionHasFabricConfigAccessPrivilege(uint16_t keyId, uint64_t peerNodeId) const
bool
Wskazuje, czy sesja o podanym identyfikatorze węzła i identyfikatorze klucza sesji jest uprawniona do pobierania informacji o konfiguracji tkaniny.
SetDelegate(FabricProvisioningDelegate *delegate)
void
Ustaw przedstawiciela do przetwarzania zdarzeń obsługi administracyjnej Fabric.
Shutdown(void)
Wyłącz serwer obsługi administracyjnej Fabric.

Atrybuty chronione

mCurClientOp

ExchangeContext * mCurClientOp

mDelegate

FabricProvisioningDelegate * mDelegate

Funkcje publiczne

FabricProvisioningServer

 FabricProvisioningServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Zainicjuj stan serwera obsługi administracyjnej Fabric i zarejestruj się, aby otrzymywać komunikaty dotyczące obsługi administracyjnej Fabric.

Szczegóły
Parametry
[in] exchangeMgr
Wskaźnik systemu – menedżer wymiany oprogramowania Weave.
Zwracane wartości
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Jeśli zarejestrowano już zbyt wiele modułów obsługi wiadomości.
WEAVE_NO_ERROR
Powodzenie.

SendStatusReport

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

Wyślij odpowiedź na żądanie z raportem o stanie.

Szczegóły
Parametry
[in] statusProfileId
Identyfikator profilu Weave, którego dotyczy ten raport o stanie.
[in] statusCode
Kod stanu do uwzględnienia w tej odpowiedzi.
[in] sysError
Kod błędu systemu, który zostanie dołączony do tej odpowiedzi.
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Jeśli żadna prośba nie jest przetwarzana.
WEAVE_NO_ERROR
Powodzenie.
other
Inne kody błędów Weave lub dotyczące platformy, które wskazują, że wystąpił błąd, który uniemożliwia wysłanie raportu o stanie.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Wyślij odpowiedź na żądanie obsługi administracyjnej Fabric.

Szczegóły
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Jeśli żadna prośba nie jest przetwarzana.
WEAVE_NO_ERROR
Powodzenie.
other
Inne kody błędów Weave lub typowe dla platformy wskazujące, że wystąpił błąd, który uniemożliwia wysłanie odpowiedzi o pomyślnym zakończeniu.

SessionHasFabricConfigAccessPrivilege

bool SessionHasFabricConfigAccessPrivilege(
  uint16_t keyId,
  uint64_t peerNodeId
) const 

Wskazuje, czy sesja o podanym identyfikatorze węzła i identyfikatorze klucza sesji jest uprawniona do pobierania informacji o konfiguracji tkaniny.

Szczegóły
Zwroty
Zwraca wartość „true” (prawda) jeśli dany peer ma uprawnienia, w przeciwnym razie ma wartość 'false'.

SetDelegate

void SetDelegate(
  FabricProvisioningDelegate *delegate
)

Ustaw przedstawiciela do przetwarzania zdarzeń obsługi administracyjnej Fabric.

Szczegóły
Parametry
[in] delegate
Wskaźnik do przedstawiciela obsługi administracyjnej usługi Fabric.

Wyłączono

WEAVE_ERROR Shutdown(
  void
)

Wyłącz serwer obsługi administracyjnej Fabric.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
bezwarunkowo.