inet::Ipv4MulticastSourceList Struct Reference

#include <Ipv4InterfaceData.h>

Public Types
typedef std::vector< Ipv4Address >	Ipv4AddressVector

Public Member Functions
	Ipv4MulticastSourceList ()
	Ipv4MulticastSourceList (McastSourceFilterMode filterMode, const Ipv4AddressVector &sources)
bool	operator== (const Ipv4MulticastSourceList &other)
bool	operator!= (const Ipv4MulticastSourceList &other)
bool	isEmpty () const
bool	containsAll () const
bool	contains (Ipv4Address source)
bool	add (Ipv4Address source)
bool	remove (Ipv4Address source)
std::string	str () const
std::string	detailedInfo () const

Public Attributes
McastSourceFilterMode	filterMode
Ipv4AddressVector	sources

Static Public Attributes
static const Ipv4MulticastSourceList	ALL_SOURCES

Member Typedef Documentation

Ipv4AddressVector

typedef std::vector<Ipv4Address> inet::Ipv4MulticastSourceList::Ipv4AddressVector

Constructor & Destructor Documentation

Ipv4MulticastSourceList() [1/2]

inet::Ipv4MulticastSourceList::Ipv4MulticastSourceList ( )

inline

        : filterMode(MCAST_INCLUDE_SOURCES) {}

Ipv4MulticastSourceList() [2/2]

inet::Ipv4MulticastSourceList::Ipv4MulticastSourceList ( McastSourceFilterMode  filterMode, const Ipv4AddressVector &  sources  )

inline

        : filterMode(filterMode), sources(sources) {}

Member Function Documentation

add()

bool inet::Ipv4MulticastSourceList::add

(

Ipv4Address

source

)

{
    size_t oldSize = sources.size();
    if (filterMode == MCAST_INCLUDE_SOURCES) {
        auto it = std::lower_bound(sources.begin(), sources.end(), source);
        if (it == sources.end() || *it != source)
            sources.insert(it, source);
    }
    else {
        sources.erase(std::remove(sources.begin(), sources.end(), source), sources.end());
    }
    return sources.size() != oldSize;
}

Referenced by inet::Ipv4InterfaceData::addMulticastListener().

contains()

bool inet::Ipv4MulticastSourceList::contains

(

Ipv4Address

source

)

{
    return (filterMode == MCAST_INCLUDE_SOURCES && inet::contains(sources, source)) ||
           (filterMode == MCAST_EXCLUDE_SOURCES && !inet::contains(sources, source));
}

Referenced by inet::Ipv4InterfaceData::addMulticastListener(), and inet::Ipv4InterfaceData::hasMulticastListener().

containsAll()

bool inet::Ipv4MulticastSourceList::containsAll ( ) const

inline

{ return filterMode == MCAST_EXCLUDE_SOURCES && sources.empty(); }

Referenced by inet::Ipv4InterfaceData::addMulticastListener().

detailedInfo()

std::string inet::Ipv4MulticastSourceList::detailedInfo

(

)

const

{
    std::stringstream out;
    out << (filterMode == MCAST_INCLUDE_SOURCES ? "INCLUDE(" : "EXCLUDE(");
    for (size_t i = 0; i < sources.size(); ++i)
        out << (i > 0 ? ", " : "") << sources[i];
    out << ")";
    return out.str();
}

isEmpty()

bool inet::Ipv4MulticastSourceList::isEmpty ( ) const

inline

{ return filterMode == MCAST_INCLUDE_SOURCES && sources.empty(); }

Referenced by inet::Ipv4InterfaceData::changeMulticastGroupMembership(), and inet::Ipv4InterfaceData::hasMulticastListener().

operator!=()

bool inet::Ipv4MulticastSourceList::operator!= ( const Ipv4MulticastSourceList &  other )

inline

{ return filterMode != other.filterMode || sources != other.sources; }

operator==()

bool inet::Ipv4MulticastSourceList::operator== ( const Ipv4MulticastSourceList &  other )

inline

{ return filterMode == other.filterMode && sources == other.sources; }

remove()

bool inet::Ipv4MulticastSourceList::remove

(

Ipv4Address

source

)

{
    size_t oldSize = sources.size();
    if (filterMode == MCAST_INCLUDE_SOURCES) {
        sources.erase(std::remove(sources.begin(), sources.end(), source), sources.end());
    }
    else {
        auto it = lower_bound(sources.begin(), sources.end(), source);
        if (it == sources.end() || *it != source)
            sources.insert(it, source);
    }
    return sources.size() != oldSize;
}

str()

std::string inet::Ipv4MulticastSourceList::str

(

)

const

{
    std::stringstream out;
    out << (filterMode == MCAST_INCLUDE_SOURCES ? "I" : "E");
    for (auto& elem : sources)
        out << " " << elem;
    return out.str();
}

Member Data Documentation

ALL_SOURCES

const Ipv4MulticastSourceList inet::Ipv4MulticastSourceList::ALL_SOURCES

static

Referenced by inet::Ipv4InterfaceData::addMulticastListener().

filterMode

McastSourceFilterMode inet::Ipv4MulticastSourceList::filterMode

Referenced by add(), inet::Igmpv3::RouterGroupData::collectForwardedSources(), contains(), detailedInfo(), inet::Igmpv3::multicastSourceListChanged(), operator!=(), operator==(), inet::Igmpv3::processReport(), remove(), inet::Ipv4InterfaceData::setMulticastListeners(), str(), and inet::Ipv4InterfaceData::HostMulticastGroupData::updateSourceList().

sources

Ipv4AddressVector inet::Ipv4MulticastSourceList::sources

Referenced by add(), inet::Igmpv3::RouterGroupData::collectForwardedSources(), contains(), detailedInfo(), inet::Igmpv3::multicastSourceListChanged(), operator!=(), operator==(), inet::Igmpv3::processReport(), remove(), inet::Ipv4InterfaceData::setMulticastListeners(), and str().

---

The documentation for this struct was generated from the following files:

• Ipv4InterfaceData.h
• Ipv4InterfaceData.cc