nl :: Tejido:: Perfiles: Aprovisionamiento de red: NetworkProvisioningServer

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

Clase de servidor para implementar el perfil de aprovisionamiento de red.

Resumen

Herencia

Hereda de: nl :: :: Armadura WeaveServerBase
Subclases conocidas directas:
  nl :: Weave :: DeviceLayer :: Internal :: GenericNetworkProvisioningServerImpl <NetworkProvisioningServerImpl>
  nl :: Weave :: DeviceLayer :: Internal :: GenericNetworkProvisioningServerImpl <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 publicas

Init ( WeaveExchangeManager *exchangeMgr)
Inicialice el estado del servidor de aprovisionamiento de red y regístrese para recibir mensajes de aprovisionamiento de red.
SendAddNetworkComplete (uint32_t networkId)
virtual WEAVE_ERROR
Envíe un mensaje Agregar red completa si la red se agregó correctamente.
SendGetNetworksComplete (uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Envíe un mensaje Obtener redes completas que contenga las redes escaneadas anteriormente.
SendGetWirelessRegulatoryConfigComplete ( PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Envíe un mensaje GetWirelessRegulatoryConfigComplete al par.
SendNetworkScanComplete (uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
Envíe un mensaje de respuesta de Análisis de red completo que contenga los resultados del análisis.
SendStatusReport (uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Envíe una respuesta de informe de estado a una solicitud.
SendSuccessResponse (void)
virtual WEAVE_ERROR
Envíe una respuesta satisfactoria a una solicitud de aprovisionamiento de red.
SetDelegate ( NetworkProvisioningDelegate *delegate)
void
Configure el delegado para procesar los eventos del servidor de aprovisionamiento de red.
Shutdown (void)
Apague 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

Código de estado

uint16_t StatusCode

StatusProfileId

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

Funciones publicas

En eso

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Inicialice el estado del servidor de aprovisionamiento de red y regístrese para recibir mensajes de aprovisionamiento de red.

Detalles
Parámetros
[in] exchangeMgr
Un puntero al sistema Weave Exchange Manager.
Valores devueltos
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Si ya se han registrado demasiados controladores de mensajes.
WEAVE_NO_ERROR
Sobre el éxito.

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

Envíe un mensaje Agregar red completa si la red se agregó correctamente.

Detalles
Parámetros
[in] networkId
El ID de la red agregada.
Valores devueltos
WEAVE_ERROR_INCORRECT_STATE
Si el servidor de aprovisionamiento de red no se inicializa correctamente.
WEAVE_ERROR_NO_MEMORY
En caso de que no se asigne un PacketBuffer.
WEAVE_NO_ERROR
Sobre el éxito.
other
Otros códigos de error de Weave o específicos de la plataforma que indican que se produjo un error que impide que el dispositivo envíe el mensaje Agregar red completa.

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

Envíe un mensaje de Obtener redes completas que contenga las redes escaneadas anteriormente.

Detalles
Parámetros
[in] resultCount
El número de resultados del análisis.
[in] scanResultsTLV
Los resultados del escaneo.
Valores devueltos
WEAVE_ERROR_INCORRECT_STATE
Si el servidor de aprovisionamiento de red no se inicializa correctamente.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si el búfer de resultados no es lo suficientemente grande.
WEAVE_NO_ERROR
Sobre el éxito.
other
Otros códigos de error Weave o específicos de la plataforma que indican que se produjo un error que impide que el dispositivo envíe el mensaje Get Networks Complete.

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

Envíe un mensaje GetWirelessRegulatoryConfigComplete al par.

Detalles
Parámetros
[in] resultsTLV
Un búfer de paquetes que contiene la información de configuración reguladora inalámbrica que se devolverá.
Valores devueltos
WEAVE_ERROR_INCORRECT_STATE
Si el servidor de aprovisionamiento de red no se inicializa correctamente.
WEAVE_ERROR_NO_MEMORY
En caso de que no se asigne un PacketBuffer.
WEAVE_NO_ERROR
Sobre el éxito.
other
Otros códigos de error de Weave o específicos de la plataforma que indican que se produjo un error que impide que el dispositivo envíe el mensaje Agregar red completa.

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

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

Detalles
Parámetros
[in] resultCount
El número de resultados del análisis.
[in] scanResultsTLV
Los resultados del escaneo.
Valores devueltos
WEAVE_ERROR_INCORRECT_STATE
Si el servidor de aprovisionamiento de red no se inicializa correctamente.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si el búfer de resultados no es lo suficientemente grande.
WEAVE_NO_ERROR
Sobre el éxito.
other
Otros códigos de error Weave o específicos de la plataforma 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íe 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 devueltos
WEAVE_ERROR_INCORRECT_STATE
Si no se está procesando ninguna solicitud.
WEAVE_NO_ERROR
Sobre el é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 el informe de estado.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Envíe una respuesta satisfactoria a una solicitud de aprovisionamiento de red.

Detalles
Valores devueltos
WEAVE_ERROR_INCORRECT_STATE
Si no se está procesando ninguna solicitud.
WEAVE_NO_ERROR
Sobre el é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
)

Configure el delegado para procesar los eventos del servidor de aprovisionamiento de red.

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

Cerrar

WEAVE_ERROR Shutdown(
  void
)

Apague el servidor de aprovisionamiento de red.

Detalles
Valores devueltos
WEAVE_NO_ERROR
Sobre el éxito.