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

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

La clase de servidor para implementar el perfil de aprovisionamiento de red.

Resumen

Herencia

Se hereda de: nl::Weave::WeaveServerBase
Subclases conocidas directas:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; ImplClass >

Constructores y destructores
NetworkProvisioningServer(void)

Atributos protegidos
mCurOp
mCurOpType
uint8_t
mDelegate
mLastOpResult
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217

Atributos públicos
StatusCode
uint16_t
StatusProfileId
uint32_t
SysError

Funciones públicas
Init(WeaveExchangeManager *exchangeMgr)
Inicializa el estado del servidor de aprovisionamiento de red y regístrate para recibir mensajes de aprovisionamiento de red.
SendAddNetworkComplete(uint32_t networkId)
virtual WEAVE_ERROR
Envía un mensaje de Add Network Complete si la red se agregó correctamente.
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Envía un mensaje de Get Networks Complete que contenga las redes analizadas anteriormente.
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Envía un mensaje GetWirelessRegulatoryConfigComplete al par.
SendNetworkScanComplete(uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
Envía un mensaje de respuesta de escaneo de red completo que contenga los resultados del análisis.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Envía una respuesta de informe de estado a una solicitud.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Envía una respuesta exitosa a una solicitud de aprovisionamiento de red.
SetDelegate(NetworkProvisioningDelegate *delegate)
void
Configura el delegado para que procese los eventos del servidor de aprovisionamiento de red.
Shutdown(void)
Cierra el servidor de aprovisionamiento de red.

Atributos protegidos

mCurOp

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

mDelegate

NetworkProvisioningDelegate * mDelegate

mLastOpResult

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

Atributos públicos

StatusCode

uint16_t StatusCode

StatusProfileId

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

Funciones públicas

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Inicializa el estado del servidor de aprovisionamiento de red y regístrate para recibir mensajes de aprovisionamiento de red.

Detalles
Parámetros
[in] exchangeMgr
Un puntero al sistema Weave Exchange Manager.
Valores de retorno
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Si ya se registraron demasiados controladores de mensajes.
WEAVE_NO_ERROR
Si tiene éxito.

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

Envía un mensaje de Add Network Complete si la red se agregó correctamente.

Detalles
Parámetros
[in] networkId
El ID de la red agregada.
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Si el servidor de aprovisionamiento de redes no se inicializó de forma correcta
WEAVE_ERROR_NO_MEMORY
En caso de error en la asignación de un packageBuffer.
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros códigos de error específicos de la plataforma o de Weave que indican que se produjo un error que impidió que el dispositivo envíe el mensaje Add Network Complete.

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

Envía un mensaje de Get Networks Complete que contenga las redes analizadas anteriormente.

Detalles
Parámetros
[in] resultCount
La cantidad de resultados del análisis.
[in] scanResultsTLV
Los resultados del análisis.
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Si el servidor de aprovisionamiento de redes no se inicializó de forma correcta
WEAVE_ERROR_BUFFER_TOO_SMALL
Si el búfer de resultados no es lo suficientemente grande.
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros códigos de error específicos de la plataforma o de Weave que indican que se produjo un error que impidió que el dispositivo envíe el mensaje Get Networks Complete.

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

Envía un mensaje GetWirelessRegulatoryConfigComplete al par.

Detalles
Parámetros
[in] resultsTLV
Un búfer de paquetes que contiene la información de configuración regulatoria inalámbrica que se mostrará.
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Si el servidor de aprovisionamiento de redes no se inicializó de forma correcta
WEAVE_ERROR_NO_MEMORY
En caso de error en la asignación de un packageBuffer.
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros códigos de error específicos de la plataforma o de Weave que indican que se produjo un error que impidió que el dispositivo envíe el mensaje Add Network Complete.

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

Envía un mensaje de respuesta de escaneo de red completo que contenga los resultados del análisis.

Detalles
Parámetros
[in] resultCount
La cantidad de resultados del análisis.
[in] scanResultsTLV
Los resultados del análisis.
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Si el servidor de aprovisionamiento de redes no se inicializó de forma correcta
WEAVE_ERROR_BUFFER_TOO_SMALL
Si el búfer de resultados no es lo suficientemente grande.
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros códigos de error específicos de la plataforma o de Weave que indican que se produjo un error que impidió que el dispositivo envíe la respuesta de escaneo completo.

SendStatusReport

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

Envía una respuesta de informe de estado a una solicitud.

Detalles
Parámetros
[in] statusProfileId
El ID de perfil de Weave al que pertenece este informe de estado.
[in] statusCode
El código de estado que se incluirá en esta respuesta.
[in] sysError
El código de error del sistema que se incluirá en esta respuesta.
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Si no se está procesando ninguna solicitud.
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros códigos de error específicos de la plataforma o de Weave que indican que se produjo un error que impidió que el dispositivo envíe el informe de estado.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Envía una respuesta exitosa a una solicitud de aprovisionamiento de red.

Detalles
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Si no se está procesando ninguna solicitud.
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros códigos de error de Weave o específicos de la plataforma que indican que se produjo un error que impidió que el dispositivo envíe la respuesta de éxito.

SetDelegate

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

Configura el delegado para que procese los eventos del servidor de aprovisionamiento de red.

Detalles
Parámetros
[in] delegate
Un puntero sobre el delegado de aprovisionamiento de red.

Cierre

WEAVE_ERROR Shutdown(
  void
)

Cierra el servidor de aprovisionamiento de red.

Detalles
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.