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

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

Classe de servidor para implementar o perfil de provisionamento de rede.

Resumo

Herança

Herda de: nl::Weave::WeaveServerBase
Subclasses conhecidas diretas:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; ImplClass >

Construtores e destruidores
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

Funções públicas
Init(WeaveExchangeManager *exchangeMgr)
Inicializar o estado do servidor de provisionamento de rede e registrar-se para receber mensagens de provisionamento de rede.
SendAddNetworkComplete(uint32_t networkId)
virtual WEAVE_ERROR
Envie uma mensagem "Adicionar rede concluída" se a rede tiver sido adicionada.
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Envie uma mensagem "Get Networks Complete" contendo as redes verificadas anteriormente.
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Envie uma mensagem GetWireless RegulationConfigComplete ao outro ponto.
SendNetworkScanComplete(uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
Envie uma mensagem de resposta "Verificação de rede completa" com os resultados da verificação.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Enviar uma resposta de relatório de status a uma solicitação.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Envie uma resposta de êxito para uma solicitação de provisionamento de rede.
SetDelegate(NetworkProvisioningDelegate *delegate)
void
Defina o delegado para processar eventos do servidor de provisionamento de rede.
Shutdown(void)
Encerre o servidor de provisionamento de rede.

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

Funções públicas

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Inicializar o estado do servidor de provisionamento de rede e registrar-se para receber mensagens de provisionamento de rede.

Detalhes
Parâmetros
[in] exchangeMgr
Um ponteiro para o sistema do Weave Exchange Manager.
Valores de retorno
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Se muitos gerenciadores de mensagens já tiverem sido registrados.
WEAVE_NO_ERROR
Se a operação for bem-sucedida.

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

Envie uma mensagem "Adicionar rede concluída" se a rede tiver sido adicionada.

Detalhes
Parâmetros
[in] networkId
O ID da rede adicionada.
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Se o servidor de provisionamento de rede não for inicializado corretamente.
WEAVE_ERROR_NO_MEMORY
Em caso de falha na alocação de um PackageBuffer.
WEAVE_NO_ERROR
Se a operação for bem-sucedida.
other
Outros códigos de erro específicos da plataforma ou do Weave, indicando que ocorreu um erro que impede que o dispositivo envie a mensagem "Adicionar rede concluída".

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

Envie uma mensagem "Get Networks Complete" contendo as redes verificadas anteriormente.

Detalhes
Parâmetros
[in] resultCount
O número de resultados da verificação.
[in] scanResultsTLV
Os resultados da verificação.
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Se o servidor de provisionamento de rede não for inicializado corretamente.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se o buffer de resultados não for grande o suficiente.
WEAVE_NO_ERROR
Se a operação for bem-sucedida.
other
Outros códigos de erro do Weave ou específicos da plataforma indicando que ocorreu um erro que impede que o dispositivo envie a mensagem Get Networks Complete.

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

Envie uma mensagem GetWireless RegulationConfigComplete ao outro ponto.

Detalhes
Parâmetros
[in] resultsTLV
Um buffer de pacote contendo as informações de configuração regulatória sem fio a serem retornadas.
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Se o servidor de provisionamento de rede não for inicializado corretamente.
WEAVE_ERROR_NO_MEMORY
Em caso de falha na alocação de um PackageBuffer.
WEAVE_NO_ERROR
Se a operação for bem-sucedida.
other
Outros códigos de erro específicos da plataforma ou do Weave, indicando que ocorreu um erro que impede que o dispositivo envie a mensagem "Adicionar rede concluída".

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

Envie uma mensagem de resposta "Verificação de rede completa" com os resultados da verificação.

Detalhes
Parâmetros
[in] resultCount
O número de resultados da verificação.
[in] scanResultsTLV
Os resultados da verificação.
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Se o servidor de provisionamento de rede não for inicializado corretamente.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se o buffer de resultados não for grande o suficiente.
WEAVE_NO_ERROR
Se a operação for bem-sucedida.
other
Outros códigos de erro do Weave ou específicos da plataforma indicando que ocorreu um erro que impede que o dispositivo envie a resposta Verificação completa.

SendStatusReport

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

Enviar uma resposta de relatório de status a uma solicitação.

Detalhes
Parâmetros
[in] statusProfileId
O ID do perfil do Weave a que este relatório de status pertence.
[in] statusCode
O código de status a ser incluído nessa resposta.
[in] sysError
O código de erro do sistema a ser incluído nessa resposta.
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Se não houver solicitação sendo processada.
WEAVE_NO_ERROR
Se a operação for bem-sucedida.
other
Outros códigos de erro do Weave ou específicos da plataforma indicando que ocorreu um erro que impede que o dispositivo envie o relatório de status.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Envie uma resposta de êxito para uma solicitação de provisionamento de rede.

Detalhes
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Se não houver solicitação sendo processada.
WEAVE_NO_ERROR
Se a operação for bem-sucedida.
other
Outros códigos de erro do Weave ou específicos da plataforma indicando que ocorreu um erro que impede que o dispositivo envie a resposta bem-sucedida.

SetDelegate

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

Defina o delegado para processar eventos do servidor de provisionamento de rede.

Detalhes
Parâmetros
[in] delegate
Um ponteiro para o delegado de provisionamento de rede.

Encerramento

WEAVE_ERROR Shutdown(
  void
)

Encerre o servidor de provisionamento de rede.

Detalhes
Valores de retorno
WEAVE_NO_ERROR
Se a operação for bem-sucedida.