nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer

#include <src/lib/profiles/network-provisioning/NetworkProvisioning.h>

Klasa serwera do implementacji profilu udostępniania sieci.

Podsumowanie

Dziedziczenie

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

Konstruktorzy i niszczyciele
NetworkProvisioningServer(void)

Atrybuty chronione
mCurOp
mCurOpType
uint8_t
mDelegate
mLastOpResult
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217

Atrybuty publiczne
StatusCode
uint16_t
StatusProfileId
uint32_t
SysError

Funkcje publiczne
Init(WeaveExchangeManager *exchangeMgr)
Zainicjuj stan serwera udostępniania sieci i zarejestruj się, aby otrzymywać wiadomości dotyczące obsługi administracyjnej sieci.
SendAddNetworkComplete(uint32_t networkId)
virtual WEAVE_ERROR
Jeśli sieć została dodana, wyślij wiadomość o ukończeniu dodawania sieci.
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Wyślij wiadomość „Get Networks complete” zawierającą poprzednio zeskanowane sieci.
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Wyślij komunikat GetWirelessRegulatoryConfigComplete do połączenia równorzędnego.
SendNetworkScanComplete(uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
Wyślij wiadomość z odpowiedzią dotyczącą zakończenia skanowania sieci zawierającą wyniki skanowania.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Wyślij odpowiedź z raportem o stanie na prośbę.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Wyślij odpowiedź o powodzeniu na żądanie udostępniania sieci.
SetDelegate(NetworkProvisioningDelegate *delegate)
void
Skonfiguruj osobę, której przekazano dostęp, aby przetwarzała zdarzenia serwera udostępniania sieci.
Shutdown(void)
Wyłącz serwer udostępniania sieci.

Atrybuty chronione

mCurOp

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

mDelegate

NetworkProvisioningDelegate * mDelegate

mLastOpResult

struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217 mLastOpResult

Atrybuty publiczne

StatusCode

uint16_t StatusCode

StatusProfileId

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

Funkcje publiczne

Zainicjuj

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Zainicjuj stan serwera udostępniania sieci i zarejestruj się, aby otrzymywać wiadomości dotyczące obsługi administracyjnej sieci.

Szczegóły
Parametry
[in] exchangeMgr
Wskaźnik do systemowego menedżera wymiany Weave Exchange.
Zwracane wartości
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Jeśli zarejestrowanych jest zbyt wiele modułów obsługi wiadomości.
WEAVE_NO_ERROR
Na sukces.

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

Jeśli sieć została dodana, wyślij wiadomość o ukończeniu dodawania sieci.

Szczegóły
Parametry
[in] networkId
Identyfikator dodanej sieci.
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Jeśli serwer udostępniania sieci nie został prawidłowo zainicjowany.
WEAVE_ERROR_NO_MEMORY
W przypadku niepowodzenia przydzielenia bufora pakietów.
WEAVE_NO_ERROR
Na sukces.
other
Inne kody błędów Weave lub specyficzne dla platformy wskazujące, że wystąpił błąd, który uniemożliwia urządzeniu wysłanie komunikatu o zakończeniu dodawania sieci.

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

Wyślij wiadomość „Get Networks complete” zawierającą poprzednio zeskanowane sieci.

Szczegóły
Parametry
[in] resultCount
Liczba wyników skanowania.
[in] scanResultsTLV
Wyniki skanowania.
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Jeśli serwer udostępniania sieci nie został prawidłowo zainicjowany.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jeśli bufor wyników nie jest wystarczająco duży.
WEAVE_NO_ERROR
Na sukces.
other
Inne kody błędów Weave lub specyficzne dla platformy wskazujące, że wystąpił błąd, który uniemożliwia urządzeniu wysłanie komunikatu Get Networks complete.

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

Wyślij komunikat GetWirelessRegulatoryConfigComplete do połączenia równorzędnego.

Szczegóły
Parametry
[in] resultsTLV
Bufor pakietów zawierający informacje na temat przepisów prawnych dotyczących konfiguracji sieci bezprzewodowych, które mają zostać zwrócone.
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Jeśli serwer udostępniania sieci nie został prawidłowo zainicjowany.
WEAVE_ERROR_NO_MEMORY
W przypadku niepowodzenia przydzielenia bufora pakietów.
WEAVE_NO_ERROR
Na sukces.
other
Inne kody błędów Weave lub specyficzne dla platformy wskazujące, że wystąpił błąd, który uniemożliwia urządzeniu wysłanie komunikatu o zakończeniu dodawania sieci.

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

Wyślij wiadomość z odpowiedzią dotyczącą zakończenia skanowania sieci zawierającą wyniki skanowania.

Szczegóły
Parametry
[in] resultCount
Liczba wyników skanowania.
[in] scanResultsTLV
Wyniki skanowania.
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Jeśli serwer udostępniania sieci nie został prawidłowo zainicjowany.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jeśli bufor wyników nie jest wystarczająco duży.
WEAVE_NO_ERROR
Na sukces.
other
Inne kody błędów Weave lub specyficzne dla platformy wskazujące, że wystąpił błąd, który uniemożliwia urządzeniu wysłanie odpowiedzi zakończenia skanowania.

SendStatusReport

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

Wyślij odpowiedź z raportem o stanie na prośbę.

Szczegóły
Parametry
[in] statusProfileId
Identyfikator profilu Weave, którego dotyczy ten raport o stanie.
[in] statusCode
Kod stanu, który ma być uwzględniony w tej odpowiedzi.
[in] sysError
Kod błędu systemu, który zostanie uwzględniony w tej odpowiedzi.
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Jeśli żadne żądanie nie jest przetwarzane.
WEAVE_NO_ERROR
Na sukces.
other
Inne kody błędów Weave lub platformy wskazujące, że wystąpił błąd, który uniemożliwia urządzeniu wysłanie raportu o stanie.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Wyślij odpowiedź o powodzeniu na żądanie udostępniania sieci.

Szczegóły
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Jeśli żadne żądanie nie jest przetwarzane.
WEAVE_NO_ERROR
Na sukces.
other
Inne kody błędów Weave lub dotyczące platformy wskazujące, że wystąpił błąd, który uniemożliwia urządzeniu wysłanie odpowiedzi powodzenia.

SetDelegate

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

Skonfiguruj osobę, której przekazano dostęp, aby przetwarzała zdarzenia serwera udostępniania sieci.

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

Wyłączono

WEAVE_ERROR Shutdown(
  void
)

Wyłącz serwer udostępniania sieci.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
Na sukces.