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

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

Klasa serwera do implementacji profilu obsługi administracyjnej sieci.

Podsumowanie

Dziedziczenie

Dziedziczy z: nl::Weave::WeaveServerBase
Bezpośrednie znane podklasy:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; Network ProvisioningingServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; ImplClass >

Konstruktory 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 obsługi administracyjnej sieci i zarejestruj się, aby otrzymywać komunikaty dotyczące obsługi administracyjnej sieci.
SendAddNetworkComplete(uint32_t networkId)
virtual WEAVE_ERROR
Jeśli sieć została dodana, wyślij wiadomość Add Network complete (Dodawanie sieci).
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Wyślij wiadomość Get Networks complete (zakończenie pobierania sieci) zawierającą zeskanowane wcześniej sieci.
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Wyślij wiadomość GetWirelessRegulatoryConfigComplete do peera.
SendNetworkScanComplete(uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
Wyślij odpowiedź o zakończeniu skanowania sieci zawierającą wyniki skanowania.
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
Wysyłaj odpowiedź na żądanie obsługi administracyjnej sieci.
SetDelegate(NetworkProvisioningDelegate *delegate)
void
Ustaw przedstawiciela do przetwarzania zdarzeń serwera obsługi administracyjnej sieci.
Shutdown(void)
Wyłącz serwer obsługi administracyjnej 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

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

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

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.

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

Jeśli sieć została dodana, wyślij wiadomość Add Network complete (Dodawanie sieci).

Szczegóły
Parametry
[in] networkId
Identyfikator dodanej sieci.
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Jeśli serwer obsługi administracyjnej sieci nie został poprawnie zainicjowany.
WEAVE_ERROR_NO_MEMORY
W przypadku niepowodzenia przydzielenia bufora PacketBuffer.
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 urządzeniu wysłanie komunikatu Add Network complete (Zakończono dodawanie sieci).

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

Wyślij wiadomość Get Networks complete (zakończenie pobierania sieci) zawierającą zeskanowane wcześniej sieci.

Szczegóły
Parametry
[in] resultCount
Liczba wyników skanowania.
[in] scanResultsTLV
wyniki skanowania.
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Jeśli serwer obsługi administracyjnej sieci nie został poprawnie zainicjowany.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jeśli bufor wyników nie jest wystarczająco duży.
WEAVE_NO_ERROR
Powodzenie.
other
Inne kody błędów Weave lub typowe dla platformy, które wskazują, że wystąpił błąd uniemożliwiający urządzeniu wysłanie komunikatu Get Networks Complete (Zakończono pobieranie sieci).

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

Wyślij komunikat GetWirelessRegulatoryConfigComplete do peera.

Szczegóły
Parametry
[in] resultsTLV
Bufor pakietów zawierający informacje o konfiguracji wymaganej przez prawo sieci bezprzewodowej, które mają zostać zwrócone.
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Jeśli serwer obsługi administracyjnej sieci nie został poprawnie zainicjowany.
WEAVE_ERROR_NO_MEMORY
W przypadku niepowodzenia przydzielenia bufora PacketBuffer.
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 urządzeniu wysłanie komunikatu Add Network complete (Zakończono dodawanie sieci).

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

Wyślij odpowiedź o zakończeniu 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 obsługi administracyjnej sieci nie został poprawnie zainicjowany.
WEAVE_ERROR_BUFFER_TOO_SMALL
Jeśli bufor wyników nie jest wystarczająco duży.
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 urządzeniu wysłanie odpowiedzi z zakończeniem skanowania.

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 typowe dla 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
)

Wysyłaj odpowiedź na żądanie obsługi administracyjnej sieci.

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 uniemożliwiający urządzeniu wysłanie odpowiedzi o pomyślnym zakończeniu.

SetDelegate

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

Ustaw przedstawiciela do przetwarzania zdarzeń serwera obsługi administracyjnej sieci.

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

Wyłączono

WEAVE_ERROR Shutdown(
  void
)

Wyłącz serwer obsługi administracyjnej sieci.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.