nl :: Tecer:: Perfis :: NetworkProvisioning :: Informação de Rede

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

Uma classe de utilitário para serializar e desserializar cargas úteis comunicadas por meio do perfil NetworkProvisioning : ela encapsula informações pertinentes à detecção e configuração de redes.

Resumo

A classe depende do 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`	`:: nl::Weave::Profiles::NetworkProvisioning::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 segmento 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`	`:: nl::Weave::Profiles::NetworkProvisioning::WiFiMode` O modo de operação da rede sem fio.
`WiFiRole`	`:: nl::Weave::Profiles::NetworkProvisioning::WiFiRole` O papel desempenhado pelo dispositivo na rede sem fio.
`WiFiSSID`	`char *` O SSID WiFi ou NULL se não for especificado.
`WiFiSecurityType`	`:: nl::Weave::Profiles::NetworkProvisioning::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` Redefina para o padrão e libere todos os valores neste objeto NetworkInfo .
`CopyTo ( NetworkInfo & dest)`	`WEAVE_ERROR` Substitua o conteúdo deste objeto NetworkInfo pela cópia detalhada do conteúdo do argumento.
`Decode (nl::Weave::TLV::TLVReader & reader)`	`WEAVE_ERROR` Desserialize o conteúdo deste objeto NetworkInfo de sua representação TLV .
`Encode (nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags) const`	`WEAVE_ERROR` Serialize o conteúdo deste objeto NetworkInfo em sua representação TLV .
`MergeTo ( NetworkInfo & dest)`	`WEAVE_ERROR` Mescle o conteúdo deste objeto NetworkInfo com a cópia profunda do conteúdo do argumento.

Funções estáticas públicas
`DecodeList (nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray)`	`WEAVE_ERROR` Desserialize uma lista de elementos NetworkInfo de sua representação TLV .
`EncodeList (nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags)`	`WEAVE_ERROR` Serialize uma matriz de objetos NetworkInfo em sua 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)`	`WEAVE_ERROR` Serialize uma matriz de objetos NetworkInfo em sua representação TLV selecionando apenas 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.

Tipo de rede

::nl::Weave::Profiles::NetworkProvisioning::NetworkType NetworkType

O tipo de rede.

ThreadChannel

uint8_t ThreadChannel

O canal atual (atualmente [11..26]) em que 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ído em qualquer condição que chame Clear() no 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, pertencente à classe Destroyed em qualquer condição que chame Clear() no 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ído em qualquer condição que chame Clear() no 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, pertencente à classe Destroyed em qualquer condição que chame Clear() no 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 comprimento especificado por WiFiKeyLen . Destruído em qualquer condição que chame Clear() no 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ído em qualquer condição que chame Clear() no 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
)

Redefina para o padrão e libera todos os valores neste objeto NetworkInfo .

Copiar para

WEAVE_ERROR CopyTo(
  NetworkInfo & dest
)

Substitua o conteúdo deste objeto NetworkInfo pela cópia detalhada do conteúdo do argumento.

Detalhes

Parâmetros

[in] dest

Objeto NetworkInfo contendo informações a serem copiadas para este objeto.

Valores Retornados

`WEAVE_NO_ERROR`	Com sucesso.
`WEAVE_ERROR_NOT_IMPLEMENTED`	Quando a plataforma não suporta malloc ou free.
`WEAVE_ERROR_NO_MEMORY`	Em falhas de alocação de memória.

Decodificar

WEAVE_ERROR Decode(
  nl::Weave::TLV::TLVReader & reader
)

Desserialize o conteúdo deste objeto NetworkInfo de sua representação TLV .

Detalhes

Parâmetros

[in] reader

TLVReader posicionado no elemento da estrutura contendo informações da rede.

Devoluções

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 um dos erros do leitor TLV na decodificação incorreta de elementos.

Codificar

WEAVE_ERROR Encode(
  nl::Weave::TLV::TLVWriter & writer,
  uint8_t encodeFlags
) const

Serialize o conteúdo deste objeto NetworkInfo em sua representação TLV .

Detalhes

Parâmetros

`[in] writer`	TLVWriter posicionado no local onde o objeto será serializado. A função emite uma tag anônima para este objeto quando este objeto faz parte de um array de elementos ou uma tag de perfil para kTag_NetworkInformation quando emitida como um elemento autônomo.
`[in] encodeFlags`	Sinalizadores que controlam se as credenciais do NetworkInfo devem ser serializadas.

Devoluções

MergeTo

WEAVE_ERROR MergeTo(
  NetworkInfo & dest
)

Mescle o conteúdo deste objeto NetworkInfo com a cópia profunda do conteúdo do argumento.

Todos os valores não padrão do objeto de argumento substituem os valores neste objeto.

Detalhes

Parâmetros

[in] dest

Objeto NetworkInfo contendo informações a serem copiadas para este objeto.

Valores Retornados

`WEAVE_NO_ERROR`	Com sucesso.
`WEAVE_ERROR_NOT_IMPLEMENTED`	Quando a plataforma não suporta malloc ou free.
`WEAVE_ERROR_NO_MEMORY`	Em falhas de alocação de memória.

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
)

Desserialize uma lista de elementos NetworkInfo de sua representação TLV .

Detalhes

Parâmetros

`[in] reader`	TLVReader posicionado no início da matriz. No retorno bem-sucedido, o gravador é posicionado após o final da matriz.
`[in,out] elemCount`	Na entrada, número máximo de elementos a desserializar do TLVReader. Na saída, o número de elementos realmente desserializados do fluxo.
`[in,out] elemArray`	Uma referência à matriz de elementos NetworkInfo que conterá os objetos NetworkInfo desserializados. Quando a matriz é NULL, ela é alocada internamente pela função abaixo, caso contrário, presume-se que a matriz alocada externamente contém pelo menos objetos elemCount.

Valores Retornados

`WEAVE_NO_ERROR`	Com sucesso.
`WEAVE_ERROR_NOT_IMPLEMENTED`	em plataformas que não suportam gerenciamento de memória dinâmica.
`other`	Erros retornados da função `Decode()` .

EncodeList

WEAVE_ERROR EncodeList(
  nl::Weave::TLV::TLVWriter & writer,
  uint16_t elemCount,
  const NetworkInfo *elemArray,
  uint8_t encodeFlags
)

Serialize uma matriz de objetos NetworkInfo em sua representação TLV .

A matriz será um elemento anônimo na representação TLV .

Detalhes

Parâmetros

`[in] writer`	TLVWriter apropriadamente posicionado
`[in] elemCount`	Número de elementos no `elemArray` .
`[in] elemArray`	A matriz de objetos NetworkInfo a serem serializados.
`[in] encodeFlags`	Sinalizadores que controlam se as credenciais do NetworkInfo devem ser serializadas.

Valores Retornados

`WEAVE_NO_ERROR`	Com sucesso.
`Other`	Erros retornados da função `Encode()` .

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
)

Serialize uma matriz de objetos NetworkInfo em sua representação TLV selecionando apenas redes de um tipo específico.

Detalhes

Parâmetros

`[in] writer`	TLVWriter apropriadamente posicionado
`[in] arrayLen`	Número de elementos no `elemArray` .
`[in] elemArray`	A matriz de objetos NetworkInfo a serem serializados.
`[in] networkType`	O tipo de objetos NetworkInfo para serializar
`[in] encodeFlags`	Sinalizadores que controlam se as credenciais do NetworkInfo devem ser serializadas.
`[out] encodedElemCount`	O número de elementos realmente serializados.

Valores Retornados

`WEAVE_NO_ERROR`	Com sucesso.
`Other`	Erros retornados da função `Encode()` .

nl :: Tecer:: Perfis :: NetworkProvisioning :: Informação de Rede

Resumo

Construtores e Destruidores

Tipos públicos

Atributos públicos

Funções públicas

Funções estáticas públicas

Tipos públicos

@ 210

@ 211

Atributos públicos

Escondido

ID de rede

Tipo de rede

ThreadChannel

ThreadExtendedPANId

ThreadNetworkKey

ThreadNetworkName

ThreadPANId

ThreadPSKc

WiFiKey

WiFiKeyLen

WiFiMode

WiFiRole

WiFiSSID

WiFiSecurityType

WirelessSignalStrength

Funções públicas

Claro

Copiar para

Decodificar

Codificar

MergeTo

Informação de Rede

~ NetworkInfo

Funções estáticas públicas

DecodeList

EncodeList

EncodeList