nl::Inet::InterfaceAddressIterator

Iterator for the list of system network interface IP addresses.

Summary

Use objects of this class to iterate the list of system network interface interface IP addresses.

Methods on an individual instance of this class are not thread-safe; however separate instances may be used simultaneously by multiple threads.

On multi-threaded LwIP systems, instances are thread-safe relative to other threads accessing the global LwIP state provided that: 1) other threads hold the LwIP core lock while mutating the list of netifs; and 2) netif object themselves are never destroyed.

On sockets-based systems, iteration is always stable in the face of changes to the underlying system's interfaces and/or addresses.

On LwIP systems, iteration is stable except in the case where the interface associated with the current address is removed, in which case iteration may end prematurely.

Public functions

IPAddress GetAddress(
  void
)

void GetAddressWithPrefix(
  IPPrefix & addrWithPrefix
)

uint8_t GetIPv6PrefixLength(
  void
)

InterfaceId GetInterface(
  void
)

InterfaceId GetInterfaceId(
  void
)

INET_ERROR GetInterfaceName(
  char *nameBuf,
  size_t nameBufSize
)

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

uint8_t GetPrefixLength(
  void
)

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.

bool HasBroadcastAddress(
  void
)

bool HasCurrent(
  void
)

 InterfaceAddressIterator(
  void
)

bool IsUp(
  void
)

bool Next(
  void
)

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.

bool SupportsMulticast(
  void
)

 ~InterfaceAddressIterator(
  void
)