nl::Inet::InterfaceAddressIterator

#include <src/inet/InetInterface.h>

Iterador da lista de endereços IP da interface de rede do sistema.

Resumo

Use objetos desta classe para iterar a lista de endereços IP da interface de rede do sistema.

Os métodos em uma instância individual desta classe não são thread-safe. No entanto, instâncias separadas podem ser usadas simultaneamente por várias linhas de execução.

Em sistemas LwIP com várias linhas de execução, as instâncias são seguras para linhas de execução em relação a outras linhas que acessam o estado LwIP global, desde que: 1) outras linhas de execução mantenham o bloqueio principal do LwIP enquanto modificam a lista de netifs; e 2) os próprios objetos netif nunca serão destruídos.

Em sistemas baseados em soquetes, a iteração é sempre estável diante de mudanças nas interfaces e/ou endereços do sistema subjacente.

Em sistemas LwIP, a iteração é estável, exceto quando a interface associada ao endereço atual é removida, caso em que a iteração pode terminar prematuramente.

Construtores e destruidores
InterfaceAddressIterator(void)
Constrói um objeto InterfaceAddressIterator.
~InterfaceAddressIterator(void)
Destrói um objeto InterfaceAddressIterator.

Funções públicas
GetAddress(void)
Consiga o endereço da interface atual.
GetAddressWithPrefix(IPPrefix & addrWithPrefix)
void
Retorna um IPPrefix que contém o endereço e o tamanho do prefixo do endereço atual.
GetIPv6PrefixLength(void)
uint8_t
Alias descontinuado de GetPrefixLength(void)
GetInterface(void)
InterfaceId
Alias descontinuado de GetInterfaceId(void)
GetInterfaceId(void)
InterfaceId
Retorna o ID da interface de rede associado ao endereço da interface atual.
GetInterfaceName(char *nameBuf, size_t nameBufSize)
Consiga o nome da interface de rede associada ao endereço da interface atual.
GetPrefixLength(void)
uint8_t
Recebe o prefixo de rede associado ao endereço da interface atual.
HasBroadcastAddress(void)
bool
Retorna se a interface de rede associada ao endereço de interface atual tem um endereço de transmissão IPv4.
HasCurrent(void)
bool
IsUp(void)
bool
Retorna indicando se a interface de rede associada ao endereço da interface atual está ativa.
Next(void)
bool
Avançar o iterador para o próximo endereço da interface.
SupportsMulticast(void)
bool
Retorna se a interface de rede associada ao endereço da interface atual oferece suporte a multicast.

Funções públicas

GetAddress

IPAddress GetAddress(
  void
)

Consiga o endereço da interface atual.

Detalhes
Retornos
o endereço da interface atual ou IPAddress::Any se o iterador estiver posicionado além do fim da lista de endereços.

GetAddressWithPrefix

void GetAddressWithPrefix(
  IPPrefix & addrWithPrefix
)

Retorna um IPPrefix que contém o endereço e o tamanho do prefixo do endereço atual.

GetIPv6PrefixLength

uint8_t GetIPv6PrefixLength(
  void
)

Alias descontinuado de GetPrefixLength(void)

GetInterface

InterfaceId GetInterface(
  void
)

Alias descontinuado de GetInterfaceId(void)

GetInterfaceId

InterfaceId GetInterfaceId(
  void
)

Retorna o ID da interface de rede associado ao endereço da interface atual.

Detalhes
Retornos
o ID da interface ou INET_NULL_INTERFACEID se o iterador estiver posicionado além do fim da lista de endereços.

GetInterfaceName

INET_ERROR GetInterfaceName(
  char *nameBuf,
  size_t nameBufSize
)

Consiga o nome da interface de rede associada ao endereço da interface atual. 

Writes the name of the network interface as \c NUL terminated text string
at \c nameBuf.

Detalhes
Parâmetros
[in] nameBuf
região da memória para gravar o nome da interface
[in] nameBufSize
tamanho da região indicada por nameBuf
Valores de retorno
INET_NO_ERROR
resultado bem-sucedido, nome da interface escrito
INET_ERROR_NO_MEMORY
o nome é muito grande para ser escrito em buffer
INET_ERROR_INCORRECT_STATE
o iterador não está posicionado no endereço de uma interface
other
outro erro do sistema ou da plataforma

GetPrefixLength

uint8_t GetPrefixLength(
  void
)

Recebe o prefixo de rede associado ao endereço da interface atual. 

On LwIP, this method simply returns the hard-coded constant 64.

Note Well: the standard subnet prefix on all links other than PPP
links is 64 bits. On PPP links and some non-broadcast multipoint access
links, the convention is either 127 bits or 128 bits, but it might be
something else. On most platforms, the system's interface address
structure can represent arbitrary prefix lengths between 0 and 128.

Detalhes
Retornos
o prefixo da rede (em bits) ou 0 se o iterador estiver posicionado além do fim da lista de endereços.

HasBroadcastAddress

bool HasBroadcastAddress(
  void
)

Retorna se a interface de rede associada ao endereço de interface atual tem um endereço de transmissão IPv4.

Detalhes
Retornos
true se a interface tiver um endereço de transmissão, false se não tiver ou se o iterador não estiver posicionado em um endereço de interface.

HasCurrent

bool HasCurrent(
  void
)

InterfaceAddressIterator

 InterfaceAddressIterator(
  void
)

Constrói um objeto InterfaceAddressIterator.

Inicia o iterador no primeiro endereço de rede. Em algumas plataformas, esse construtor pode alocar recursos reciclados pelo destrutor.

IsUp

bool IsUp(
  void
)

Retorna indicando se a interface de rede associada ao endereço da interface atual está ativa.

Detalhes
Retornos
true se a interface de rede atual estiver ativa, false se não estiver ou se o iterador não estiver posicionado em um endereço de interface.

Próxima

bool Next(
  void
)

Avançar o iterador para o próximo endereço da interface. 

Advances the iterator to the next interface address or to a position
beyond the end of the address list.

On LwIP, this method is thread-safe provided that: 1) other threads hold
the LwIP core lock while mutating the netif list; and 2) netif objects
themselves are never destroyed.  Additionally, iteration on LwIP systems
will terminate early if the current interface is removed from the list.

Detalhes
Retornos
false se você avançar além do final. Caso contrário, será true.

SupportsMulticast

bool SupportsMulticast(
  void
)

Retorna se a interface de rede associada ao endereço da interface atual oferece suporte a multicast.

Detalhes
Retornos
true se o multicast for compatível, false se não for, ou se o iterador não estiver posicionado em um endereço de interface.

~InterfaceAddressIterator

 ~InterfaceAddressIterator(
  void
)

Destrói um objeto InterfaceAddressIterator.

Recicla todos os recursos alocados pelo construtor.