Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split AddrList into object-iterator-container components #5410

Merged
merged 4 commits into from
Dec 3, 2018
Merged

Split AddrList into object-iterator-container components #5410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c1ee864
Split AddrList into object-iterator-container components
devyte Dec 2, 2018
8f91848
Merge branch 'master' into addrList
devyte Dec 2, 2018
cf26897
Update AddrList.h
devyte Dec 3, 2018
d222330
Merge branch 'master' into addrList
devyte Dec 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
184 changes: 106 additions & 78 deletions cores/esp8266/AddrList.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@
This class allows to explore all configured IP addresses
in lwIP netifs, with that kind of c++ loop:

for (auto a: ifList)
for (auto a: addrList)
out.printf("IF='%s' index=%d legacy=%d IPv4=%d local=%d hostname='%s' addr= %s\n",
a->iface().c_str(),
a->number(),
a->addr().isLegacy(),
a->addr().isV4(),
a->addr().isLocal(),
a->hostname().c_str(),
a->addr().toString().c_str());
a.iface().c_str(),
a.number(),
a.addr().isLegacy(),
a.addr().isV4(),
a.addr().isLocal(),
a.hostname().c_str(),
a.addr().toString().c_str());

This loop:

Expand All @@ -41,8 +41,8 @@
can be replaced by:

for (bool configured = false; !configured; ) {
for (auto iface: ifList)
if ((configured = !iface->addr().isLocal())
for (auto iface: addrList)
if ((configured = !iface.addr().isLocal())
break;
Serial.print('.');
delay(500);
Expand All @@ -51,9 +51,9 @@
waiting for an IPv6 global address:

for (bool configured = false; !configured; ) {
for (auto iface: ifList)
if ((configured = ( !iface->addr()->isV4()
&& !iface->addr().isLocal())))
for (auto iface: addrList)
if ((configured = ( !iface.addr().isV4()
&& !iface.addr().isLocal())))
break;
Serial.print('.');
delay(500);
Expand All @@ -62,10 +62,10 @@
waiting for an IPv6 global address, on a specific interface:

for (bool configured = false; !configured; ) {
for (auto iface: ifList)
if ((configured = ( !iface->addr()->isV4()
&& !iface->addr().isLocal()
&& iface->number() == STATION_IF)))
for (auto iface: addrList)
if ((configured = ( !iface.addr().isV4()
&& !iface.addr().isLocal()
&& iface.number() == STATION_IF)))
break;
Serial.print('.');
delay(500);
Expand All @@ -85,84 +85,112 @@
#endif


class AddrListClass {
namespace esp8266
{

// no member in this class
// lwIP's global 'struct netif* netif_list' is used
// designed to be used with 'for (auto x: ifList)'
namespace AddressListImplementation
{

public:

class const_iterator {
struct netifWrapper
{
netifWrapper(netif * netif) : _netif(netif), _num(-1) {}
netifWrapper(const netifWrapper & o) : _netif(o._netif), _num(o._num) {}

public:
netifWrapper& operator=(const netifWrapper & o) {_netif = o._netif; _num = o._num; return *this;}

// iterator operations:
bool equal (const netifWrapper & o)
{
return _netif == o._netif && (!_netif || _num == o._num);
}

const_iterator (bool begin = true): _netif(begin? netif_list: nullptr), _num(-1) { ++*this; }
const_iterator (const const_iterator& o): _netif(o._netif), _num(o._num) { }
const_iterator& operator= (const const_iterator& o) { _netif = o._netif; _num = o._num; return *this; }

bool operator!= (const const_iterator& o) { return !equal(o); }
bool operator== (const const_iterator& o) { return equal(o); }
bool isLegacy() const { return _num == 0; }
bool isLocal() const { return addr().isLocal(); }
IPAddress addr () const { return ipFromNetifNum(); }
IPAddress netmask () const { return _netif->netmask; }
IPAddress gw () const { return _netif->gw; }
String iface () const { return String(_netif->name[0]) + _netif->name[1]; }
const char* hostname () const { return _netif->hostname?: emptyString.c_str(); }
const char* mac () const { return (const char*)_netif->hwaddr; }
int number () const { return _netif->num; }

const_iterator operator++(int) {
const_iterator ret = *this;
++(*this);
return ret;
}
const ip_addr_t* ipFromNetifNum () const
{
#if LWIP_IPV6
return _num ? &_netif->ip6_addr[_num - 1] : &_netif->ip_addr;
#else
return &_netif->ip_addr;
#endif
}

const_iterator& operator++() {
while (_netif) {
if (++_num == IF_NUM_ADDRESSES) {
_num = -1;
_netif = _netif->next;
continue;
}
if (!ip_addr_isany(_ip_from_netif_num()))
break;
}
return *this;
}

// (*iterator) emulation:
netif * _netif;
int _num;
};

const const_iterator& operator* () const { return *this; }
const const_iterator* operator-> () const { return this; }

bool isLegacy() const { return _num == 0; }
bool isLocal() const { return addr().isLocal(); }
IPAddress addr () const { return _ip_from_netif_num(); }
IPAddress netmask () const { return _netif->netmask; }
IPAddress gw () const { return _netif->gw; }
String iface () const { return String(_netif->name[0]) + _netif->name[1]; }
const char* hostname () const { return _netif->hostname?: emptyString.c_str(); }
const char* mac () const { return (const char*)_netif->hwaddr; }
int number () const { return _netif->num; }

protected:
class AddressListIterator
{
public:
AddressListIterator(const netifWrapper &o) : netIf(o) {}
AddressListIterator(netif * netif) : netIf(netif) {}

const netifWrapper& operator* () const {return netIf;}
const netifWrapper* operator->() const {return &netIf;}

bool operator==(AddressListIterator & o) {return netIf.equal(*o);}
bool operator!=(AddressListIterator & o) {return !netIf.equal(*o);}

AddressListIterator & operator= (const AddressListIterator& o) {netIf = o.netIf; return *this; }

AddressListIterator operator++(int)
{
AddressListIterator ret = *this;
++(*this);
return ret;
}

AddressListIterator & operator++()
{
while (netIf._netif)
{
if (++netIf._num == IF_NUM_ADDRESSES)
{
netIf = netifWrapper(netIf._netif->next); //num is inited to -1
continue;
}
if (!ip_addr_isany(netIf.ipFromNetifNum()))
break;
}
return *this;
}

netifWrapper netIf;
};

bool equal (const const_iterator& o) {
return _netif == o._netif
&& (!_netif || _num == o._num);
}

const ip_addr_t* _ip_from_netif_num () const {
#if LWIP_IPV6
return _num? &_netif->ip6_addr[_num - 1]: &_netif->ip_addr;
#else
return &_netif->ip_addr;
#endif
}

netif* _netif;
int _num; // address index (0 is legacy, _num-1 is ip6_addr[]'s index)
};
class AddressList
{
public:
using const_iterator = const AddressListIterator;

const_iterator begin() const {return const_iterator(netif_list);}
const_iterator end() const {return const_iterator(nullptr);}

const const_iterator begin () const { return const_iterator(true); }
const const_iterator end () const { return const_iterator(false); }
};

extern AddrListClass addrList;

#endif // __ADDRLIST_H
inline AddressList::const_iterator begin(const AddressList &a) {return a.begin();}
inline AddressList::const_iterator end(const AddressList &a) {return a.end();}

} //AddressListImplementation

} //esp8266

extern esp8266::AddressListImplementation::AddressList addrList;


#endif
22 changes: 11 additions & 11 deletions libraries/esp8266/examples/IPv6/IPv6.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,16 +66,16 @@ void status(Print& out) {
out.println(F("(with 'telnet <addr> or 'nc -u <addr> 23')"));
for (auto a : addrList) {
out.printf("IF='%s' IPv6=%d local=%d hostname='%s' addr= %s",
a->iface().c_str(),
!a->addr().isV4(),
a->addr().isLocal(),
a->hostname(),
a->addr().toString().c_str());
a.iface().c_str(),
!a.addr().isV4(),
a.addr().isLocal(),
a.hostname(),
a.addr().toString().c_str());

if (a->isLegacy()) {
if (a.isLegacy()) {
out.printf(" / mask:%s / gw:%s",
a->netmask().toString().c_str(),
a->gw().toString().c_str());
a.netmask().toString().c_str(),
a.gw().toString().c_str());
}

out.println();
Expand Down Expand Up @@ -121,9 +121,9 @@ void setup() {

for (bool configured = false; !configured;) {
for (auto addr : addrList)
if ((configured = !addr->isLocal()
// && addr->isV6() // uncomment when IPv6 is mandatory
// && addr->ifnumber() == STATION_IF
if ((configured = !addr.isLocal()
// && addr.isV6() // uncomment when IPv6 is mandatory
// && addr.ifnumber() == STATION_IF
)) {
break;
}
Expand Down