nl :: Tecer:: Perfis :: NetworkProvisioning :: Informação de Rede
#include <src/lib/profiles/network-provisioning/NetworkInfo.h>
A classe de utilitário para serialização e desserialização cargas comunicadas através NetworkProvisioning perfil: ele encapsula as informações pertinentes às redes de detecção e configuração.
Resumo
A classe se baseia no armazenamento intermediário de informações de provisionamento de rede (intermediário entre o armazenamento final das informações e a carga útil da rede) e usa gerenciamento de memória dinâmica para fornecer ao objeto resultante um tempo de execução flexível. Como tal, esta classe não é adequada para os ambientes mais restritos, mas pode ser usada em sistemas maiores.
Construtores e Destruidores | |
---|---|
NetworkInfo () | |
~NetworkInfo () |
Tipos públicos | |
---|---|
@210 | enum |
@211 | enum |
Atributos públicos | |
---|---|
Hidden | bool Se a rede está ou não oculta. |
NetworkId | int64_t O id de rede atribuído à rede pelo dispositivo, -1 se não for 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 Thread estendido PAN ID. |
ThreadNetworkKey | uint8_t * A chave de rede mestre do thread ou NULL se não for especificado. |
ThreadNetworkName | char * O nome da rede Thread ou NULL se não for especificado. |
ThreadPANId | uint32_t O Thread PAN ID de 16 bits ou kThreadPANId_NotSpecified. |
ThreadPSKc | uint8_t * Chave pré-compartilhada de thread para o comissário ou NULL se não for especificado. |
WiFiKey | uint8_t * A chave WiFi, ou NULL se não for especificado. |
WiFiKeyLen | uint32_t O comprimento em bytes da chave WiFi. |
WiFiMode | O modo de operação da rede sem fio. |
WiFiRole | O papel desempenhado pelo dispositivo na rede sem fio. |
WiFiSSID | char * O SSID WiFi ou NULL se não for especificado. |
WiFiSecurityType | O tipo de segurança WiFi. |
WirelessSignalStrength | int16_t A intensidade do sinal da rede ou INT16_MIN se não disponível / aplicável. |
Funções públicas | |
---|---|
Clear (void) | void Redefinir para o padrão e libertar todos os valores dentro dessa NetworkInfo objeto. |
CopyTo ( NetworkInfo & dest) | Substituir o conteúdo deste NetworkInfo objeto com a cópia profunda dos conteúdos do argumento. |
Decode (nl::Weave::TLV::TLVReader & reader) | Desserializar o conteúdo deste NetworkInfo objeto de seu TLV representação. |
Encode (nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags) const | Serializar o conteúdo deste NetworkInfo objeto em sua TLV representação. |
MergeTo ( NetworkInfo & dest) | Mesclar o conteúdo deste NetworkInfo objeto com a cópia profunda dos conteúdos do argumento. |
Funções estáticas públicas | |
---|---|
DecodeList (nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray) | Desserializar uma lista de NetworkInfo elementos de sua TLV representação. |
EncodeList (nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags) | Serializar uma matriz de NetworkInfo objectos para a sua TLV representação. |
EncodeList (nl::Weave::TLV::TLVWriter & writer, uint16_t arrayLen, const NetworkInfo *elemArray, :: nl::Weave::Profiles::NetworkProvisioning::NetworkType networkType, uint8_t encodeFlags, uint16_t & encodedElemCount) | Serializar uma matriz de NetworkInfo objectos para a sua TLV representação seleccionando somente as redes de um tipo específico. |
Tipos públicos
@ 210
@210
@ 211
@211
Atributos públicos
Escondido
bool Hidden
Se a rede está ou não oculta.
ID de rede
int64_t NetworkId
O id de rede atribuído à rede pelo dispositivo, -1 se não for especificado.
ThreadChannel
uint8_t ThreadChannel
O canal atual (atualmente [11..26]) no qual a rede Thread opera, ou kThreadChannel_NotSpecified.
ThreadExtendedPANId
uint8_t * ThreadExtendedPANId
O segmento estendido PAN ID.
É um array alocado dinamicamente de 8 octetos, pertencente à classe. Destruída em qualquer condição que chama Clear()
sobre o objeto.
ThreadNetworkKey
uint8_t * ThreadNetworkKey
A chave de rede mestre do thread ou NULL se não for especificado.
É uma matriz alocada dinamicamente de octetos arbitrários, de propriedade da classe Destruído em qualquer condição que chama Clear()
sobre o objeto.
ThreadNetworkName
char * ThreadNetworkName
O nome da rede Thread ou NULL se não for especificado.
É uma string C terminada em NUL e alocada dinamicamente, de propriedade da classe. Destruída em qualquer condição que chama Clear()
sobre o objeto.
ThreadPANId
uint32_t ThreadPANId
O Thread PAN ID de 16 bits ou kThreadPANId_NotSpecified.
ThreadPSKc
uint8_t * ThreadPSKc
Chave pré-compartilhada de thread para o comissário ou NULL se não for especificado.
É uma matriz alocada dinamicamente de octetos arbitrários, de propriedade da classe Destruído em qualquer condição que chama Clear()
sobre o objeto.
WiFiKey
uint8_t * WiFiKey
A chave WiFi, ou NULL se não for especificado.
É uma matriz alocada dinamicamente de octetos arbitrários, de propriedade da classe, com o comprimento especificado por WiFiKeyLen
. Destruída em qualquer condição que chama Clear()
sobre o objeto.
WiFiKeyLen
uint32_t WiFiKeyLen
O comprimento em bytes da chave WiFi.
WiFiMode
::nl::Weave::Profiles::NetworkProvisioning::WiFiMode WiFiMode
O modo de operação da rede sem fio.
WiFiRole
::nl::Weave::Profiles::NetworkProvisioning::WiFiRole WiFiRole
O papel desempenhado pelo dispositivo na rede sem fio.
WiFiSSID
char * WiFiSSID
O SSID WiFi ou NULL se não for especificado.
É uma string C terminada em NUL e alocada dinamicamente, de propriedade da classe. Destruída em qualquer condição que chama Clear()
sobre o objeto.
WiFiSecurityType
::nl::Weave::Profiles::NetworkProvisioning::WiFiSecurityType WiFiSecurityType
O tipo de segurança WiFi.
WirelessSignalStrength
int16_t WirelessSignalStrength
A intensidade do sinal da rede ou INT16_MIN se não disponível / aplicável.
Funções públicas
Claro
void Clear( void )
Redefinir para o padrão e libertar todos os valores dentro dessa NetworkInfo objeto.
Copiar para
WEAVE_ERROR CopyTo( NetworkInfo & dest )
Substituir o conteúdo deste NetworkInfo objeto com a cópia profunda dos conteúdos do argumento.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
Decodificar
WEAVE_ERROR Decode( nl::Weave::TLV::TLVReader & reader )
Desserializar o conteúdo deste NetworkInfo objeto de seu TLV representação.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | WEAVE_NO_ERROR Em caso de sucesso, WEAVE_ERROR_INVALID_TLV_ELEMENT em qualquer elemento que não correspondam ao perfil de aprovisionamento de rede, qualquer um dos TLV erros leitor sobre decodificação incorreta de elementos. |
Codificar
WEAVE_ERROR Encode( nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags ) const
Serializar o conteúdo deste NetworkInfo objeto em sua TLV representação.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Devoluções | WEAVE_NO_ERROR Em caso de sucesso, WEAVE_ERROR_INVALID_TLV_ELEMENT em qualquer elemento que não correspondam ao perfil de aprovisionamento de rede, qualquer um dos TLV erros leitor sobre decodificação incorreta de elementos. |
MergeTo
WEAVE_ERROR MergeTo( NetworkInfo & dest )
Mesclar o conteúdo deste NetworkInfo objeto com a cópia profunda dos conteúdos do argumento.
Todos os valores não padrão do objeto de argumento substituem os valores neste objeto.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
Informação de Rede
NetworkInfo()
~ NetworkInfo
~NetworkInfo()
Funções estáticas públicas
DecodeList
WEAVE_ERROR DecodeList( nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray )
Desserializar uma lista de NetworkInfo elementos de sua TLV representação.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
EncodeList
WEAVE_ERROR EncodeList( nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags )
Serializar uma matriz de NetworkInfo objectos para a sua TLV representação.
A matriz será um elemento anónimo no TLV representação.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores Retornados |
|
EncodeList
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 )
Serializar uma matriz de NetworkInfo objectos para a sua TLV representação seleccionando somente as redes de um tipo específico.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||||||
Valores Retornados |
|