nl:: Weave:: Perfis:: NetworkProvisioning:: NetworkInfo
#include <src/lib/profiles/network-provisioning/NetworkInfo.h>
Uma classe de utilitário para serializar e desserializar payloads comunicados pelo perfil NetworkProvisioning: ela encapsula informações pertinentes para detecção e configuração de redes.
Resumo
A classe depende do armazenamento intermediário das informações de provisionamento de rede (intermediário entre o armazenamento final das informações e o payload de rede) e usa gerenciamento de memória dinâmico para dar ao objeto resultante um ambiente de execução flexível. Por isso, essa classe não é adequada para os ambientes mais restritos, mas pode ser usada em sistemas maiores.
Construtores e destrutores |
|
---|---|
NetworkInfo()
|
|
~NetworkInfo()
|
Tipos públicos |
|
---|---|
@210
|
tipo enumerado |
@211
|
tipo enumerado |
Atributos públicos |
|
---|---|
Hidden
|
bool
Indica se a rede está oculta.
|
NetworkId
|
int64_t
O ID de rede atribuído à rede pelo dispositivo, -1, se não especificado.
|
NetworkType
|
É o tipo de rede.
|
ThreadChannel
|
uint8_t
O canal atual (atualmente [11..26]) em que a rede Thread opera, ou kThreadChannel_Notspecified.
|
ThreadExtendedPANId
|
uint8_t *
O código PAN estendido da linha de execução.
|
ThreadNetworkKey
|
uint8_t *
A chave de rede mestre da linha de execução ou NULL , se não for especificada.
|
ThreadNetworkName
|
char *
O nome da rede Thread, ou NULL, se não for especificado.
|
ThreadPANId
|
uint32_t
O código PAN de linha de execução de 16 bits ou kThreadPANId_Notspecified.
|
ThreadPSKc
|
uint8_t *
Chave pré-compartilhada da linha de execução para comissionador, ou NULL se não for especificado.
|
WiFiKey
|
uint8_t *
A chave Wi-Fi, ou NULL, se não for especificado.
|
WiFiKeyLen
|
uint32_t
O tamanho em bytes da chave Wi-Fi.
|
WiFiMode
|
O modo operacional da rede Wi-Fi.
|
WiFiRole
|
A função atribuída pelo dispositivo na rede Wi-Fi.
|
WiFiSSID
|
char *
O SSID do Wi-Fi, ou NULL, se não for especificado.
|
WiFiSecurityType
|
O tipo de segurança do Wi-Fi.
|
WirelessSignalStrength
|
int16_t
A intensidade do sinal da rede, ou INT16_MIN, se não estiver disponível/aplicável.
|
Funções públicas |
|
---|---|
Clear(void)
|
void
Redefina para o padrão e libere todos os valores neste objeto NetworkInfo.
|
CopyTo(NetworkInfo & dest)
|
Substitua o conteúdo desse objeto NetworkInfo pela cópia detalhada do conteúdo do argumento.
|
Decode(nl::Weave::TLV::TLVReader & reader)
|
Desserialize o conteúdo desse objeto NetworkInfo a partir da representação TLV.
|
Encode(nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags) const
|
Serialize o conteúdo desse objeto NetworkInfo na representação TLV dele.
|
MergeTo(NetworkInfo & dest)
|
Mescle o conteúdo desse objeto NetworkInfo com a cópia detalhada do conteúdo do argumento.
|
Funções estáticas públicas |
|
---|---|
DecodeList(nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray)
|
Desserialize uma lista de elementos NetworkInfo da representação TLV.
|
EncodeList(nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags)
|
Serialize uma matriz de objetos NetworkInfo para a representação TLV.
|
EncodeList(nl::Weave::TLV::TLVWriter & writer, uint16_t arrayLen, const NetworkInfo *elemArray, ::nl::Weave::Profiles::NetworkProvisioning::NetworkType networkType, uint8_t encodeFlags, uint16_t & encodedElemCount)
|
Serialize uma matriz de objetos NetworkInfo para a representação TLV, selecionando apenas redes de um tipo específico.
|
Tipos públicos
@210
@210
@211
@211
Atributos públicos
Entradas
bool Hidden
Indica se a rede está oculta.
Código da rede
int64_t NetworkId
O ID de rede atribuído à rede pelo dispositivo, -1, se não especificado.
Canal de conversas
uint8_t ThreadChannel
O canal atual (atualmente [11..26]) em que a rede Thread opera, ou kThreadChannel_Notspecified.
ThreadExtendedPANId
uint8_t * ThreadExtendedPANId
O código PAN estendido da linha de execução.
Ele é uma matriz alocada dinamicamente de oito eventos, de propriedade da classe. Destruído em qualquer condição que chame Clear()
no objeto.
Chave de rede
uint8_t * ThreadNetworkKey
A chave de rede mestre da linha de execução ou NULL , se não for especificada.
Trata-se de uma matriz alocada dinamicamente de octetos arbitrários, de propriedade da classe Destroyed em qualquer condição que chame Clear()
no objeto.
Nome da rede
char * ThreadNetworkName
O nome da rede Thread, ou NULL, se não for especificado.
É uma string C terminada em NUL e alocada dinamicamente que pertence à classe. Destruído em qualquer condição que chame Clear()
no objeto.
ThreadPANId
uint32_t ThreadPANId
O código PAN de linha de execução de 16 bits ou kThreadPANId_Notspecified.
ThreadPSKc.
uint8_t * ThreadPSKc
Chave pré-compartilhada da linha de execução para comissionador, ou NULL se não for especificado.
Trata-se de uma matriz alocada dinamicamente de octetos arbitrários, de propriedade da classe Destroyed em qualquer condição que chame Clear()
no objeto.
Chave Wi-Fi
uint8_t * WiFiKey
A chave Wi-Fi, ou NULL, se não for especificado.
É uma matriz alocada dinamicamente de octetos arbitrários de propriedade da classe, com tamanho especificado por WiFiKeyLen
. Destruído em qualquer condição que chame Clear()
no objeto.
Wi-Fi Len
uint32_t WiFiKeyLen
O tamanho em bytes da chave Wi-Fi.
ModoWi-Fi
::nl::Weave::Profiles::NetworkProvisioning::WiFiMode WiFiMode
O modo operacional da rede Wi-Fi.
Função Wi-Fi
::nl::Weave::Profiles::NetworkProvisioning::WiFiRole WiFiRole
A função atribuída pelo dispositivo na rede Wi-Fi.
Wi-Fi SSID
char * WiFiSSID
O SSID do Wi-Fi, ou NULL, se não for especificado.
É uma string C terminada em NUL e alocada dinamicamente que pertence à classe. Destruído em qualquer condição que chame Clear()
no objeto.
TipoDeSegurançaWi-Fi
::nl::Weave::Profiles::NetworkProvisioning::WiFiSecurityType WiFiSecurityType
O tipo de segurança do Wi-Fi.
Qualidade de sinal sem fio
int16_t WirelessSignalStrength
A intensidade do sinal da rede, ou INT16_MIN, se não estiver disponível/aplicável.
Funções públicas
Limpar
void Clear( void )
Redefina para o padrão e libere todos os valores neste objeto NetworkInfo.
Copiar para
WEAVE_ERROR CopyTo( NetworkInfo & dest )
Substitua o conteúdo desse objeto NetworkInfo pela cópia detalhada do conteúdo do argumento.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
Decodificar
WEAVE_ERROR Decode( nl::Weave::TLV::TLVReader & reader )
Desserialize o conteúdo desse objeto NetworkInfo a partir da representação TLV.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
WEAVE_NO_ERROR Em caso de sucesso, WEAVE_ERROR_INVALID_TLV_ELEMENT em qualquer elemento que não esteja em conformidade com o perfil de provisionamento de rede, qualquer erro de leitor TLV na decodificação incorreta dos elementos.
|
Codificação
WEAVE_ERROR Encode( nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags ) const
Serialize o conteúdo desse objeto NetworkInfo na representação TLV dele.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Retorna |
WEAVE_NO_ERROR Em caso de sucesso, WEAVE_ERROR_INVALID_TLV_ELEMENT em qualquer elemento que não esteja em conformidade com o perfil de provisionamento de rede, qualquer erro de leitor TLV na decodificação incorreta dos elementos.
|
Combinado para
WEAVE_ERROR MergeTo( NetworkInfo & dest )
Mescle o conteúdo desse objeto NetworkInfo com a cópia detalhada do conteúdo do argumento.
Todos os valores não padrão do objeto de argumento substituem os valores nesse objeto.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
NetworkInfo
NetworkInfo()
Informações da rede
~NetworkInfo()
Funções estáticas públicas
Lista de códigos
WEAVE_ERROR DecodeList( nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray )
Desserialize uma lista de elementos NetworkInfo da representação TLV.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
Lista de codificação
WEAVE_ERROR EncodeList( nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags )
Serialize uma matriz de objetos NetworkInfo para a representação TLV.
A matriz será um elemento anônimo na representação TLV.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
Lista de codificação
WEAVE_ERROR EncodeList( nl::Weave::TLV::TLVWriter & writer, uint16_t arrayLen, const NetworkInfo *elemArray, ::nl::Weave::Profiles::NetworkProvisioning::NetworkType networkType, uint8_t encodeFlags, uint16_t & encodedElemCount )
Serialize uma matriz de objetos NetworkInfo para a representação TLV, selecionando apenas redes de um tipo específico.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|