#include <IGMPv3.h>

Inheritance diagram for inet::IGMPv3:

Classes
struct	HostGroupData

struct	HostInterfaceData

struct	RouterGroupData

struct	RouterInterfaceData

struct	SourceRecord

Protected Types
enum	RouterState { IGMPV3_RS_INITIAL, IGMPV3_RS_QUERIER, IGMPV3_RS_NON_QUERIER }

enum	RouterGroupState { IGMPV3_RGS_NO_MEMBERS_PRESENT, IGMPV3_RGS_MEMBERS_PRESENT, IGMPV3_RGS_CHECKING_MEMBERSHIP }

enum	HostGroupState { IGMPV3_HGS_NON_MEMBER, IGMPV3_HGS_DELAYING_MEMBER, IGMPV3_HGS_IDLE_MEMBER }

enum	FilterMode { IGMPV3_FM_INCLUDE, IGMPV3_FM_EXCLUDE }

enum	ReportType { IGMPV3_RT_IS_IN = 1, IGMPV3_RT_IS_EX = 2, IGMPV3_RT_TO_IN = 3, IGMPV3_RT_TO_EX = 4, IGMPV3_RT_ALLOW = 5, IGMPV3_RT_BLOCK = 6 }

enum	IGMPTimerKind { IGMPV3_R_GENERAL_QUERY_TIMER, IGMPV3_R_GROUP_TIMER, IGMPV3_R_SOURCE_TIMER, IGMPV3_H_GENERAL_QUERY_TIMER, IGMPV3_H_GROUP_TIMER }

typedef std::vector< IPv4Address >	IPv4AddressVector

typedef std::map< IPv4Address, HostGroupData * >	GroupToHostDataMap

typedef std::map< IPv4Address, SourceRecord * >	SourceToSourceRecordMap

typedef std::map< IPv4Address, RouterGroupData * >	GroupToRouterDataMap

typedef std::map< int, HostInterfaceData * >	InterfaceToHostDataMap

typedef std::map< int, RouterInterfaceData * >	InterfaceToRouterDataMap

Protected Member Functions
virtual int	numInitStages () const override

virtual void	initialize (int stage) override

virtual void	handleMessage (cMessage *msg) override

virtual void	receiveSignal (cComponent source, simsignal_t signalID, cObject obj, cObject *details) override

virtual	~IGMPv3 ()

virtual HostInterfaceData *	createHostInterfaceData (InterfaceEntry *ie)

virtual RouterInterfaceData *	createRouterInterfaceData (InterfaceEntry *ie)

virtual HostInterfaceData *	getHostInterfaceData (InterfaceEntry *ie)

virtual RouterInterfaceData *	getRouterInterfaceData (InterfaceEntry *ie)

virtual void	deleteHostInterfaceData (int interfaceId)

virtual void	deleteRouterInterfaceData (int interfaceId)

virtual void	configureInterface (InterfaceEntry *ie)

virtual void	startTimer (cMessage *timer, double interval)

virtual void	sendGeneralQuery (RouterInterfaceData *interface, double maxRespTime)

virtual void	sendGroupSpecificQuery (RouterGroupData *group)

virtual void	sendGroupAndSourceSpecificQuery (RouterGroupData *group, const IPv4AddressVector &sources)

virtual void	sendGroupReport (InterfaceEntry *ie, const std::vector< GroupRecord > &records)

virtual void	sendQueryToIP (IGMPv3Query msg, InterfaceEntry ie, IPv4Address dest)

virtual void	sendReportToIP (IGMPv3Report msg, InterfaceEntry ie, IPv4Address dest)

virtual void	processHostGeneralQueryTimer (cMessage *msg)

virtual void	processHostGroupQueryTimer (cMessage *msg)

virtual void	processRouterGeneralQueryTimer (cMessage *msg)

virtual void	processRouterGroupTimer (cMessage *msg)
	Function for switching EXCLUDE filter mode back to INCLUDE If at least one source timer is still runing, it will switch to Include mode. More...

virtual void	processRouterSourceTimer (cMessage *msg)
	Function for checking expired source timers if group is in INCLUDE filter mode. More...

virtual void	processIgmpMessage (IGMPMessage *msg)

virtual void	processQuery (IGMPv3Query *msg)

virtual void	processReport (IGMPv3Report *msg)

virtual void	multicastSourceListChanged (InterfaceEntry *ie, IPv4Address group, const IPv4MulticastSourceList &sourceList)
	This function is sending report message if interface state was changed. More...

virtual double	decodeTime (unsigned char code)
	Function for computing the time value in seconds from an encoded value. More...

Protected Attributes
IRoutingTable *	rt

IInterfaceTable *	ift

bool	enabled

int	robustness

double	queryInterval

double	queryResponseInterval

double	groupMembershipInterval

double	otherQuerierPresentInterval

double	startupQueryInterval

double	startupQueryCount

double	lastMemberQueryInterval

double	lastMemberQueryCount

double	lastMemberQueryTime

double	unsolicitedReportInterval

InterfaceToHostDataMap	hostData

InterfaceToRouterDataMap	routerData

int	numGroups

int	numHostGroups

int	numRouterGroups

int	numQueriesSent

int	numQueriesRecv

int	numGeneralQueriesSent

int	numGeneralQueriesRecv

int	numGroupSpecificQueriesSent

int	numGroupSpecificQueriesRecv

int	numGroupAndSourceSpecificQueriesSent

int	numGroupAndSourceSpecificQueriesRecv

int	numReportsSent

int	numReportsRecv

Member Typedef Documentation

typedef std::map<IPv4Address, HostGroupData *> inet::IGMPv3::GroupToHostDataMap

protected

typedef std::map<IPv4Address, RouterGroupData *> inet::IGMPv3::GroupToRouterDataMap

protected

typedef std::map<int, HostInterfaceData *> inet::IGMPv3::InterfaceToHostDataMap

protected

typedef std::map<int, RouterInterfaceData *> inet::IGMPv3::InterfaceToRouterDataMap

protected

typedef std::vector<IPv4Address> inet::IGMPv3::IPv4AddressVector

protected

typedef std::map<IPv4Address, SourceRecord *> inet::IGMPv3::SourceToSourceRecordMap

protected

Member Enumeration Documentation

enum inet::IGMPv3::FilterMode

protected

Enumerator
IGMPV3_FM_INCLUDE
IGMPV3_FM_EXCLUDE

                     {
         IGMPV3_FM_INCLUDE,
         IGMPV3_FM_EXCLUDE,
     };

enum inet::IGMPv3::HostGroupState

protected

Enumerator
IGMPV3_HGS_NON_MEMBER
IGMPV3_HGS_DELAYING_MEMBER
IGMPV3_HGS_IDLE_MEMBER

                         {
         IGMPV3_HGS_NON_MEMBER,
         IGMPV3_HGS_DELAYING_MEMBER,
         IGMPV3_HGS_IDLE_MEMBER,
     };

enum inet::IGMPv3::IGMPTimerKind

protected

Enumerator
IGMPV3_R_GENERAL_QUERY_TIMER
IGMPV3_R_GROUP_TIMER
IGMPV3_R_SOURCE_TIMER
IGMPV3_H_GENERAL_QUERY_TIMER
IGMPV3_H_GROUP_TIMER

                        {
         IGMPV3_R_GENERAL_QUERY_TIMER,
         IGMPV3_R_GROUP_TIMER,
         IGMPV3_R_SOURCE_TIMER,
         IGMPV3_H_GENERAL_QUERY_TIMER,
         IGMPV3_H_GROUP_TIMER,
     };

enum inet::IGMPv3::ReportType

protected

Enumerator
IGMPV3_RT_IS_IN
IGMPV3_RT_IS_EX
IGMPV3_RT_TO_IN
IGMPV3_RT_TO_EX
IGMPV3_RT_ALLOW
IGMPV3_RT_BLOCK

                     {
         IGMPV3_RT_IS_IN = 1,
         IGMPV3_RT_IS_EX = 2,
         IGMPV3_RT_TO_IN = 3,
         IGMPV3_RT_TO_EX = 4,
         IGMPV3_RT_ALLOW = 5,
         IGMPV3_RT_BLOCK = 6,
     };

enum inet::IGMPv3::RouterGroupState

protected

Enumerator
IGMPV3_RGS_NO_MEMBERS_PRESENT
IGMPV3_RGS_MEMBERS_PRESENT
IGMPV3_RGS_CHECKING_MEMBERSHIP

                           {
         IGMPV3_RGS_NO_MEMBERS_PRESENT,
         IGMPV3_RGS_MEMBERS_PRESENT,
         IGMPV3_RGS_CHECKING_MEMBERSHIP,
     };

enum inet::IGMPv3::RouterState

protected

Enumerator
IGMPV3_RS_INITIAL
IGMPV3_RS_QUERIER
IGMPV3_RS_NON_QUERIER

                      {
         IGMPV3_RS_INITIAL,
         IGMPV3_RS_QUERIER,
         IGMPV3_RS_NON_QUERIER,
     };

Constructor & Destructor Documentation

inet::IGMPv3::~IGMPv3 ( )

protectedvirtual

 {
     while (!hostData.empty())
         deleteHostInterfaceData(hostData.begin()->first);
     while (!routerData.empty())
         deleteRouterInterfaceData(routerData.begin()->first);
 }

Member Function Documentation

void inet::IGMPv3::configureInterface ( InterfaceEntry * ie )

protectedvirtual

Referenced by initialize(), and receiveSignal().

 {
     if (enabled && rt->isMulticastForwardingEnabled()) {
         // start querier on this interface
         EV_INFO << "Sending General Query on interface '" << ie->getName() << "', and scheduling next Query to '"
                 << (simTime() + startupQueryInterval) << "'.\n";
         RouterInterfaceData *routerData = getRouterInterfaceData(ie);
         routerData->state = IGMPV3_RS_QUERIER;
 
         sendGeneralQuery(routerData, queryResponseInterval);
         startTimer(routerData->generalQueryTimer, startupQueryInterval);
     }
 }

IGMPv3::HostInterfaceData * inet::IGMPv3::createHostInterfaceData ( InterfaceEntry * ie )

protectedvirtual

Referenced by getHostInterfaceData().

 {
     return new HostInterfaceData(this, ie);
 }

IGMPv3::RouterInterfaceData * inet::IGMPv3::createRouterInterfaceData ( InterfaceEntry * ie )

protectedvirtual

Referenced by getRouterInterfaceData().

 {
     return new RouterInterfaceData(this, ie);
 }

double inet::IGMPv3::decodeTime ( unsigned char code )

protectedvirtual

Function for computing the time value in seconds from an encoded value.

Codes in the [1,127] interval are the number of 1/10 seconds, codes above 127 are contain a 3-bit exponent and a four bit mantissa and represents the (mantissa + 16) * 2^(3+exp) number of 1/10 seconds.

Referenced by processQuery().

 {
     unsigned time;
     if (code < 128)
         time = code;
     else {
         unsigned mantis = code & 0x15;
         unsigned exp = (code >> 4) & 0x07;
         time = (mantis | 0x10) << (exp + 3);
     }
 
     return (double)time / 10.0;
 }

void inet::IGMPv3::deleteHostInterfaceData ( int interfaceId )

protectedvirtual

Referenced by receiveSignal(), and ~IGMPv3().

 {
     auto interfaceIt = hostData.find(interfaceId);
     if (interfaceIt != hostData.end()) {
         HostInterfaceData *interface = interfaceIt->second;
         hostData.erase(interfaceIt);
         delete interface;
     }
 }

void inet::IGMPv3::deleteRouterInterfaceData ( int interfaceId )

protectedvirtual

Referenced by receiveSignal(), and ~IGMPv3().

 {
     auto interfaceIt = routerData.find(interfaceId);
     if (interfaceIt != routerData.end()) {
         RouterInterfaceData *interface = interfaceIt->second;
         routerData.erase(interfaceIt);
         delete interface;
     }
 }

IGMPv3::HostInterfaceData * inet::IGMPv3::getHostInterfaceData ( InterfaceEntry * ie )

protectedvirtual

Referenced by multicastSourceListChanged(), and processQuery().

 {
     int interfaceId = ie->getInterfaceId();
     auto it = hostData.find(interfaceId);
     if (it != hostData.end())
         return it->second;
 
     HostInterfaceData *data = createHostInterfaceData(ie);
     hostData[interfaceId] = data;
     return data;
 }

IGMPv3::RouterInterfaceData * inet::IGMPv3::getRouterInterfaceData ( InterfaceEntry * ie )

protectedvirtual

Referenced by configureInterface(), processQuery(), and processReport().

 {
     int interfaceId = ie->getInterfaceId();
     auto it = routerData.find(interfaceId);
     if (it != routerData.end())
         return it->second;
 
     RouterInterfaceData *data = createRouterInterfaceData(ie);
     routerData[interfaceId] = data;
     return data;
 }

void inet::IGMPv3::handleMessage ( cMessage * msg )

overrideprotectedvirtual

 {
     if (!enabled) {
         if (!msg->isSelfMessage()) {
             EV << "IGMPv3 disabled, dropping packet.\n";
             delete msg;
         }
         return;
     }
 
     if (msg->isSelfMessage()) {
         switch (msg->getKind()) {
             case IGMPV3_R_GENERAL_QUERY_TIMER:
                 processRouterGeneralQueryTimer(msg);
                 break;
 
             case IGMPV3_R_GROUP_TIMER:
                 processRouterGroupTimer(msg);
                 break;
 
             case IGMPV3_R_SOURCE_TIMER:
                 processRouterSourceTimer(msg);
                 break;
 
             case IGMPV3_H_GENERAL_QUERY_TIMER:
                 processHostGeneralQueryTimer(msg);
                 break;
 
             case IGMPV3_H_GROUP_TIMER:
                 processHostGroupQueryTimer(msg);
                 break;
 
             default:
                 ASSERT(false);
                 break;
         }
     }
     else
         processIgmpMessage(check_and_cast<IGMPMessage *>(msg));
 }

void inet::IGMPv3::initialize ( int stage )

overrideprotectedvirtual

 {
     if (stage == INITSTAGE_LOCAL) {
         ift = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);
         rt = getModuleFromPar<IIPv4RoutingTable>(par("routingTableModule"), this);
 
         cModule *host = getContainingNode(this);
         host->subscribe(NF_INTERFACE_DELETED, this);
         host->subscribe(NF_IPv4_MCAST_CHANGE, this);
 
         enabled = par("enabled");
         robustness = par("robustnessVariable");
         queryInterval = par("queryInterval");
         queryResponseInterval = par("queryResponseInterval");
         groupMembershipInterval = par("groupMembershipInterval");
         otherQuerierPresentInterval = par("otherQuerierPresentInterval");
         startupQueryInterval = par("startupQueryInterval");
         startupQueryCount = par("startupQueryCount");
         lastMemberQueryInterval = par("lastMemberQueryInterval");
         lastMemberQueryCount = par("lastMemberQueryCount");
         lastMemberQueryTime = lastMemberQueryInterval * lastMemberQueryCount;    //todo checknut ci je to takto..
         unsolicitedReportInterval = par("unsolicitedReportInterval");
 
         numGroups = 0;
         numHostGroups = 0;
         numRouterGroups = 0;
 
         numQueriesSent = 0;
         numQueriesRecv = 0;
         numGeneralQueriesSent = 0;
         numGeneralQueriesRecv = 0;
         numGroupSpecificQueriesSent = 0;
         numGroupSpecificQueriesRecv = 0;
         numGroupAndSourceSpecificQueriesSent = 0;
         numGroupAndSourceSpecificQueriesRecv = 0;
         numReportsSent = 0;
         numReportsRecv = 0;
 
         WATCH(numGroups);
         WATCH(numHostGroups);
         WATCH(numRouterGroups);
 
         WATCH(numQueriesSent);
         WATCH(numQueriesRecv);
         WATCH(numGeneralQueriesSent);
         WATCH(numGeneralQueriesRecv);
         WATCH(numGroupSpecificQueriesSent);
         WATCH(numGroupSpecificQueriesRecv);
         WATCH(numGroupAndSourceSpecificQueriesSent);
         WATCH(numGroupAndSourceSpecificQueriesRecv);
         WATCH(numReportsSent);
         WATCH(numReportsRecv);
 
         IPSocket ipSocket(gate("ipOut"));
         ipSocket.registerProtocol(IP_PROT_IGMP);
     }
     else if (stage == INITSTAGE_NETWORK_LAYER) {
         for (int i = 0; i < (int)ift->getNumInterfaces(); ++i) {
             InterfaceEntry *ie = ift->getInterface(i);
             if (ie->isMulticast())
                 configureInterface(ie);
         }
 
         cModule *host = getContainingNode(this);
         host->subscribe(NF_INTERFACE_CREATED, this);
     }
     else if (stage == INITSTAGE_NETWORK_LAYER_2) {    // ipv4Data() created in INITSTAGE_NETWORK_LAYER
         // in multicast routers: join to ALL_IGMPv3_ROUTERS_MCAST address on all interfaces
         if (enabled && rt->isMulticastForwardingEnabled()) {
             for (int i = 0; i < (int)ift->getNumInterfaces(); ++i) {
                 InterfaceEntry *ie = ift->getInterface(i);
                 if (ie->isMulticast())
                     ie->ipv4Data()->joinMulticastGroup(IPv4Address::ALL_IGMPV3_ROUTERS_MCAST);
             }
         }
     }
 }

void inet::IGMPv3::multicastSourceListChanged	(	InterfaceEntry *	ie,
		IPv4Address	group,
		const IPv4MulticastSourceList &	sourceList
	)

protectedvirtual

This function is sending report message if interface state was changed.

See RFC 3376 5.1.

Referenced by receiveSignal().

 {
     ASSERT(ie);
     ASSERT(isSorted(sourceList.sources));
 
     if (!enabled || group.isLinkLocalMulticast())
         return;
 
     HostInterfaceData *interfaceData = getHostInterfaceData(ie);
     HostGroupData *groupData = interfaceData->getOrCreateGroupData(group);
 
     FilterMode filter = sourceList.filterMode == MCAST_INCLUDE_SOURCES ? IGMPV3_FM_INCLUDE : IGMPV3_FM_EXCLUDE;
 
     EV_DETAIL_C("test") << "State of group '" << group << "' on interface '" << ie->getName() << "' has changed:\n";
     EV_DETAIL_C("test") << "    Old state: " << groupData->getStateInfo() << ".\n";
     EV_DETAIL_C("test") << "    New state: " << (filter == IGMPV3_FM_INCLUDE ? "INCLUDE" : "EXCLUDE") << sourceList.sources << ".\n";
 
     // Check if IF state is different
     if (!(groupData->filter == filter) || !(groupData->sourceAddressList == sourceList.sources)) {
         // INCLUDE(A) -> INCLUDE(B): Send ALLOW(B-A), BLOCK(A-B)
         if (groupData->filter == IGMPV3_FM_INCLUDE && filter == IGMPV3_FM_INCLUDE && groupData->sourceAddressList != sourceList.sources) {
             EV_DETAIL << "Sending ALLOW/BLOCK report.\n";
             vector<GroupRecord> records(2);
             records[0].groupAddress = group;
             records[0].recordType = IGMPV3_RT_ALLOW;
             records[0].sourceList = set_complement(sourceList.sources, groupData->sourceAddressList);
             records[1].groupAddress = group;
             records[1].recordType = IGMPV3_RT_BLOCK;
             records[1].sourceList = set_complement(groupData->sourceAddressList, sourceList.sources);
             records.erase(remove_if(records.begin(), records.end(), isEmptyRecord), records.end());
             if (!records.empty())
                 sendGroupReport(ie, records);
         }
         // EXCLUDE(A) -> EXCLUDE(B): Send ALLOW(A-B), BLOCK(B-A)
         else if (groupData->filter == IGMPV3_FM_EXCLUDE && filter == IGMPV3_FM_EXCLUDE && groupData->sourceAddressList != sourceList.sources) {
             EV_DETAIL << "Sending ALLOW/BLOCK report.\n";
             vector<GroupRecord> records(2);
             records[0].groupAddress = group;
             records[0].recordType = IGMPV3_RT_ALLOW;
             records[0].sourceList = set_complement(groupData->sourceAddressList, sourceList.sources);
             records[1].groupAddress = group;
             records[1].recordType = IGMPV3_RT_BLOCK;
             records[1].sourceList = set_complement(sourceList.sources, groupData->sourceAddressList);
             records.erase(remove_if(records.begin(), records.end(), isEmptyRecord), records.end());
             if (!records.empty())
                 sendGroupReport(ie, records);
         }
         // INCLUDE(A) -> EXCLUDE(B): Send TO_EX(B)
         else if (groupData->filter == IGMPV3_FM_INCLUDE && filter == IGMPV3_FM_EXCLUDE) {
             EV_DETAIL << "Sending TO_EX report.\n";
             vector<GroupRecord> records(1);
             records[0].groupAddress = group;
             records[0].recordType = IGMPV3_RT_TO_EX;
             records[0].sourceList = sourceList.sources;
             sendGroupReport(ie, records);
         }
         // EXCLUDE(A) -> INCLUDE(B): Send TO_IN(B)
         else if (groupData->filter == IGMPV3_FM_EXCLUDE && filter == IGMPV3_FM_INCLUDE) {
             EV_DETAIL << "Sending TO_IN report.\n";
             vector<GroupRecord> records(1);
             records[0].groupAddress = group;
             records[0].recordType = IGMPV3_RT_TO_IN;
             records[0].sourceList = sourceList.sources;
             sendGroupReport(ie, records);
         }
 
         // Go to new state
         groupData->filter = filter;
         groupData->sourceAddressList = sourceList.sources;
         sort(groupData->sourceAddressList.begin(), groupData->sourceAddressList.end());
     }
 
     // FIXME missing: the report  is retransmitted [Robustness Variable] - 1 more times,
     //       at intervals chosen at random from the range (0, [Unsolicited Report Interval])
 
     // FIXME if an interface change occured when there is a pending report, then
     //       the groups of the old report and the new report are to be merged.
 }

virtual int inet::IGMPv3::numInitStages ( ) const

inlineoverrideprotectedvirtual

210 { return NUM_INIT_STAGES; }

inet::NUM_INIT_STAGES

The number of initialization stages.

Definition: InitStages.h:116

void inet::IGMPv3::processHostGeneralQueryTimer ( cMessage * msg )

protectedvirtual

Referenced by handleMessage().

 {
     HostInterfaceData *interfaceData = (HostInterfaceData *)msg->getContextPointer();
     InterfaceEntry *ie = interfaceData->ie;
     ASSERT(ie);
 
     EV_INFO << "Response timer to a General Query on interface '" << ie->getName() << "' has expired.\n";
 
     //HostInterfaceData *interfaceData = getHostInterfaceData(ie);
     IGMPv3Report *report = new IGMPv3Report("IGMPv3 report");
     unsigned int byteLength = 8;   // IGMPv3Report header size
     report->setType(IGMPV3_MEMBERSHIP_REPORT);
     int counter = 0;
     report->setGroupRecordArraySize(interfaceData->groups.size());
 
     // FIXME Do not create reports larger than MTU of the interface
     //
 
     /*
      * creating GroupRecord for each group on interface
      */
     for (auto & elem : interfaceData->groups) {
         GroupRecord gr;
         if (elem.second->filter == IGMPV3_FM_INCLUDE) {
             gr.recordType = IGMPV3_RT_IS_IN;
         }
         else if (elem.second->filter == IGMPV3_FM_EXCLUDE) {
             gr.recordType = IGMPV3_RT_IS_EX;
         }
         gr.groupAddress = elem.second->groupAddr;
         gr.sourceList = elem.second->sourceAddressList;
         report->setGroupRecord(counter++, gr);
         byteLength += 8 + gr.sourceList.size() * 4;    // 8 byte header + n * 4 byte (IPv4Address)
     }
     report->setByteLength(byteLength);
 
     if (counter != 0) {    //if no record created, dont need to send report
         EV_INFO << "Sending response to a General Query on interface '" << ie->getName() << "'.\n";
         sendReportToIP(report, ie, IPv4Address::ALL_IGMPV3_ROUTERS_MCAST);
         numReportsSent++;
     }
     else {
         EV_INFO << "There are no multicast listeners, no response is sent to a General Query on interface '" << ie->getName() << "'.\n";
         delete report;
     }
 }

void inet::IGMPv3::processHostGroupQueryTimer ( cMessage * msg )

protectedvirtual

Referenced by handleMessage().

 {
     HostGroupData *group = (HostGroupData *)msg->getContextPointer();
     InterfaceEntry *ie = group->parent->ie;
 
     vector<GroupRecord> records(1);
 
     //checking if query is group or group-and-source specific
     if (group->queriedSources.empty()) {
         // Send report for a Group-Specific Query
         EV_INFO << "Response timer for a Group-Specific Query for group '" << group->groupAddr << "' on interface '" << ie->getName() << "'\n";
 
         records[0].groupAddress = group->groupAddr;
         records[0].recordType = group->filter == IGMPV3_FM_INCLUDE ? IGMPV3_RT_IS_IN : IGMPV3_RT_IS_EX;
         records[0].sourceList = group->sourceAddressList;
         sendGroupReport(ie, records);
     }
     else {
         // Send report for a Group-and-Source-Specific Query
         EV_INFO << "Response timer for a Group-and-Source-Specific Query for group '" << group->groupAddr << "' on interface '" << ie->getName() << "'\n";
 
         records[0].groupAddress = group->groupAddr;
         records[0].recordType = IGMPV3_RT_IS_IN;
         records[0].sourceList = group->filter == IGMPV3_FM_INCLUDE ? set_intersection(group->sourceAddressList, group->queriedSources) :
             set_complement(group->queriedSources, group->sourceAddressList);
         sendGroupReport(ie, records);
     }
 
     group->queriedSources.clear();
 }

void inet::IGMPv3::processIgmpMessage ( IGMPMessage * msg )

protectedvirtual

Referenced by handleMessage().

 {
     switch (msg->getType()) {
         case IGMP_MEMBERSHIP_QUERY:
             if (dynamic_cast<IGMPv3Query *>(msg))
                 processQuery((IGMPv3Query *)msg);
             else
                 /* TODO process v1 and v2 queries*/;
             break;
 
         case IGMPV3_MEMBERSHIP_REPORT:
             processReport(check_and_cast<IGMPv3Report *>(msg));
             break;
 
         // TODO process v1/v2 reports
         default:
             //delete msg;
             throw cRuntimeError("IGMPv3: Unhandled message type (%dq)", msg->getType());
     }
 }

void inet::IGMPv3::processQuery ( IGMPv3Query * msg )

protectedvirtual

Referenced by processIgmpMessage().

 {
     IPv4ControlInfo *controlInfo = (IPv4ControlInfo *)msg->getControlInfo();
     InterfaceEntry *ie = ift->getInterfaceById(controlInfo->getInterfaceId());
     IPv4Address groupAddr = msg->getGroupAddress();
     IPv4AddressVector& queriedSources = msg->getSourceList();
     double maxRespTime = decodeTime(msg->getMaxRespCode());
 
     ASSERT(ie->isMulticast());
 
     EV_INFO << "Received IGMPv3 query on interface '" << ie->getName() << "' for group '" << groupAddr << "'.\n";
 
     HostInterfaceData *interfaceData = getHostInterfaceData(ie);
 
     numQueriesRecv++;
 
     double delay = uniform(0.0, maxRespTime);
 
     // Rules from RFC page 22:
     if (interfaceData->generalQueryTimer->isScheduled() && interfaceData->generalQueryTimer->getArrivalTime() < simTime() + delay) {
         // 1. If there is a pending response to a previous General Query
         //    scheduled sooner than the selected delay, no additional response
         //    needs to be scheduled.
         EV_DETAIL << "There is a pending response to a previous General Query, no further response is scheduled.\n";
     }
     else if (groupAddr.isUnspecified() && queriedSources.empty()) {
         // 2. If the received Query is a General Query, the interface timer is
         //    used to schedule a response to the General Query after the
         //    selected delay.  Any previously pending response to a General
         //    Query is canceled.
         EV_DETAIL << "Received a General Query, scheduling report with delay=" << delay << ".\n";
         startTimer(interfaceData->generalQueryTimer, delay);
     }
     else if (!groupAddr.isUnspecified()) {
         HostGroupData *groupData = interfaceData->getOrCreateGroupData(groupAddr);
 
         if (!groupData->timer->isScheduled()) {
             // 3. If the received Query is a Group-Specific Query or a Group-and-
             //    Source-Specific Query and there is no pending response to a
             //    previous Query for this group, then the group timer is used to
             //    schedule a report.  If the received Query is a Group-and-Source-
             //    Specific Query, the list of queried sources is recorded to be used
             //    when generating a response.
             EV_DETAIL << "Received Group" << (queriedSources.empty() ? "" : "-and-Source") << "-Specific Query, "
                       << "scheduling report with delay=" << delay << ".\n";
 
             sort(queriedSources.begin(), queriedSources.end());
             groupData->queriedSources = queriedSources;
             startTimer(groupData->timer, delay);
         }
         else if (queriedSources.empty()) {
             //4. If there already is a pending response to a previous Query
             //   scheduled for this group, and either the new Query is a Group-
             //   Specific Query or the recorded source-list associated with the
             //   group is empty, then the group source-list is cleared and a single
             //   response is scheduled using the group timer.  The new response is
             //   scheduled to be sent at the earliest of the remaining time for the
             //   pending report and the selected delay.
             EV_DETAIL << "Received Group-Specific Query, scheduling report with delay="
                       << min(delay, SIMTIME_DBL(groupData->timer->getArrivalTime() - simTime())) << ".\n";
 
             sort(queriedSources.begin(), queriedSources.end());
             groupData->queriedSources = queriedSources;
             if (groupData->timer->getArrivalTime() > simTime() + delay)
                 startTimer(groupData->timer, delay);
         }
         else {
             // 5. If the received Query is a Group-and-Source-Specific Query and
             //    there is a pending response for this group with a non-empty
             //    source-list, then the group source list is augmented to contain
             //    the list of sources in the new Query and a single response is
             //    scheduled using the group timer.  The new response is scheduled to
             //    be sent at the earliest of the remaining time for the pending
             //    report and the selected delay.
             EV_DETAIL << "Received Group-and-Source-Specific Query, combining sources with the sources of pending report, "
                       << "and scheduling a new report with delay="
                       << min(delay, SIMTIME_DBL(groupData->timer->getArrivalTime() - simTime())) << ".\n";
 
             if (groupData->timer->getArrivalTime() > simTime() + delay) {
                 sort(queriedSources.begin(), queriedSources.end());
                 groupData->queriedSources = set_union(groupData->queriedSources, queriedSources);
                 startTimer(groupData->timer, delay);
             }
         }
     }
 
 // Router part | Querier Election
     if (rt->isMulticastForwardingEnabled()) {
         //Querier Election
         RouterInterfaceData *routerInterfaceData = getRouterInterfaceData(ie);
         if (controlInfo->getSrcAddr() < ie->ipv4Data()->getIPAddress()) {
             startTimer(routerInterfaceData->generalQueryTimer, otherQuerierPresentInterval);
             routerInterfaceData->state = IGMPV3_RS_NON_QUERIER;
         }
 
         if (!groupAddr.isUnspecified() && routerInterfaceData->state == IGMPV3_RS_NON_QUERIER) {    // group specific query
             RouterGroupData *groupData = routerInterfaceData->getOrCreateGroupData(groupAddr);
             if (groupData->state == IGMPV3_RGS_MEMBERS_PRESENT) {
                 double maxResponseTime = maxRespTime;
                 startTimer(groupData->timer, maxResponseTime * lastMemberQueryCount);
                 groupData->state = IGMPV3_RGS_CHECKING_MEMBERSHIP;
             }
         }
     }
     delete msg;
 }

void inet::IGMPv3::processReport ( IGMPv3Report * msg )

protectedvirtual

Referenced by processIgmpMessage().

 {
     IPv4ControlInfo *controlInfo = (IPv4ControlInfo *)msg->getControlInfo();
     InterfaceEntry *ie = ift->getInterfaceById(controlInfo->getInterfaceId());
     ASSERT(ie->isMulticast());
 
     EV_INFO << "Received IGMPv3 Membership Report on interface '" << ie->getName() << "'.\n";
 
     numReportsRecv++;
 
     if (rt->isMulticastForwardingEnabled()) {
         RouterInterfaceData *interfaceData = getRouterInterfaceData(ie);
 
         for (unsigned int i = 0; i < msg->getGroupRecordArraySize(); i++) {
             GroupRecord gr = msg->getGroupRecord(i);
             EV_DETAIL << "Found a record for group '" << gr.groupAddress << "'.\n";
 
             // ensure that the received sources are sorted
             sort(gr.sourceList.begin(), gr.sourceList.end());
             IPv4AddressVector& receivedSources = gr.sourceList;    // sorted
 
             RouterGroupData *groupData = interfaceData->getOrCreateGroupData(gr.groupAddress);
 
             IPv4MulticastSourceList oldSourceList;
             groupData->collectForwardedSources(oldSourceList);
 
             EV_DETAIL << "Router State is " << groupData->getStateInfo() << ".\n";
 
             // RFC 3376 6.4.1: Reception of Current State Record
             if (gr.recordType == IGMPV3_RT_IS_IN) {
                 EV_DETAIL << "Received IS_IN" << receivedSources << " report.\n";
                 // INCLUDE(A)   -> IS_IN(B) -> INCLUDE(A+B)    : (B) = GMI
                 // EXCLUDE(X,Y) -> IS_IN(A) -> EXCLUDE(X+A,Y-A): (A) = GMI
                 for (auto & receivedSource : receivedSources) {
                     EV_DETAIL << "Setting source timer of '" << receivedSource << "' to '" << groupMembershipInterval << "'.\n";
                     SourceRecord *record = groupData->getOrCreateSourceRecord(receivedSource);
                     startTimer(record->sourceTimer, groupMembershipInterval);
                 }
             }
             else if (gr.recordType == IGMPV3_RT_IS_EX) {
                 EV_DETAIL << "Received IS_EX" << receivedSources << " report.\n";
 
                 // Group Timer = GMI
                 EV_DETAIL << "Setting group timer to '" << groupMembershipInterval << "'.\n";
                 startTimer(groupData->timer, groupMembershipInterval);
 
                 // INCLUDE(A)   -> IS_EX(B) -> EXCLUDE(A*B,B-A): Delete (A-B)
                 // EXCLUDE(X,Y) -> IS_EX(A) -> EXCLUDE(A-Y,Y*A): Delete (X-A) Delete (Y-A)
                 for (auto it = groupData->sources.begin(); it != groupData->sources.end(); ++it) {
                     if (find(receivedSources.begin(), receivedSources.end(), it->first) == receivedSources.end()) {
                         EV_DETAIL << "Deleting source record of '" << it->first << "'.\n";
                         groupData->deleteSourceRecord(it->first);
                     }
                 }
 
                 // Router State == INCLUDE(A),   Report == IS_EX(B): (B-A) = 0
                 // Router State == EXCLUDE(X,Y), Report == IS_EX(A): (A-X-Y) = GMI
                 for (auto & receivedSource : receivedSources) {
                     if (!groupData->hasSourceRecord(receivedSource)) {
                         SourceRecord *record = groupData->createSourceRecord(receivedSource);
                         double timerValue = groupData->filter == IGMPV3_FM_INCLUDE ? 0.0 : groupMembershipInterval;
                         EV_DETAIL << "Setting source timer of '" << receivedSource << "' to '" << timerValue << "'.\n";
                         if (timerValue > 0)
                             startTimer(record->sourceTimer, groupMembershipInterval);
                     }
                 }
 
                 groupData->filter = IGMPV3_FM_EXCLUDE;
             }
             // RFC 3376 6.4.2: Reception of Filter-Mode-Change and Source-List-Change Records
             else if (gr.recordType == IGMPV3_RT_ALLOW) {
                 EV_DETAIL << "Received ALLOW" << receivedSources << " report.\n";
 
                 // INCLUDE(A)   -> ALLOW(B) -> INCLUDE(A+B):     (B) = GMI
                 // EXCLUDE(X,Y) -> ALLOW(A) -> EXCLUDE(X+A,Y-A): (A) = GMI
                 for (auto & receivedSource : receivedSources) {
                     EV_DETAIL << "Setting source timer of '" << receivedSource << "' to '" << groupMembershipInterval << "'.\n";
                     SourceRecord *record = groupData->getOrCreateSourceRecord(receivedSource);
                     startTimer(record->sourceTimer, groupMembershipInterval);
                 }
             }
             else if (gr.recordType == IGMPV3_RT_BLOCK) {
                 EV_DETAIL << "Received BLOCK" << receivedSources << " report.\n";
 
                 if (groupData->filter == IGMPV3_FM_INCLUDE) {
                     // INCLUDE(A) -> BLOCK(B) -> INCLUDE(A): Send Q(G,A*B)
                     IPv4AddressVector sourcesA;
                     for (auto & elem : groupData->sources)
                         sourcesA.push_back(elem.first);
 
                     IPv4AddressVector aIntersectB = set_intersection(sourcesA, receivedSources);
                     if (!aIntersectB.empty()) {
                         EV_INFO << "Sending Group-and-Source-Specific Query for group '" << groupData->groupAddr
                                 << "' on interface '" << ie->getName() << "'.\n";
                         sendGroupAndSourceSpecificQuery(groupData, aIntersectB);
                     }
                 }
                 else if (groupData->filter == IGMPV3_FM_EXCLUDE) {
                     // EXCLUDE (X,Y) -> BLOCK (A) -> EXCLUDE (X+(A-Y),Y): (A-X-Y)=Group Timer
                     for (auto it = groupData->sources.begin(); it != groupData->sources.end(); ++it) {
                         if (!groupData->hasSourceRecord(it->first)) {
                             SourceRecord *record = groupData->createSourceRecord(it->first);
                             double grouptimertime = groupData->timer->getArrivalTime().dbl() - simTime().dbl();
                             EV_DETAIL << "Setting source timer of '" << it->first << "' to '" << grouptimertime << "'.\n";
                             startTimer(record->sourceTimer, grouptimertime);
                         }
                     }
                     // Send Q(G,A-Y)
                     IPv4AddressVector ySources;
                     for (auto & elem : groupData->sources) {
                         if (!elem.second->sourceTimer->isScheduled()) {
                             ySources.push_back(elem.first);
                         }
                     }
                     IPv4AddressVector aMinusY = set_complement(receivedSources, ySources);
                     if (!aMinusY.empty()) {
                         EV_INFO << "Sending Group-and-Source-Specific Query for group '" << groupData->groupAddr
                                 << "' on interface '" << ie->getName() << "'.\n";
                         sendGroupAndSourceSpecificQuery(groupData, aMinusY);
                     }
                 }
             }
             else if (gr.recordType == IGMPV3_RT_TO_IN) {
                 EV_DETAIL << "Received TO_IN" << receivedSources << " report.\n";
 
                 if (groupData->filter == IGMPV3_FM_INCLUDE) {
                     // INCLUDE(A) -> TO_IN (B) -> INCLUDE (A+B): (B)=GMI
                     for (auto & receivedSource : receivedSources) {
                         EV_DETAIL << "Setting source timer of '" << receivedSource << "' to '" << groupMembershipInterval << "'.\n";
                         SourceRecord *record = groupData->getOrCreateSourceRecord(receivedSource);
                         startTimer(record->sourceTimer, groupMembershipInterval);
                     }
                     // Send Q(G,A-B)
                     IPv4AddressVector sourcesA;
                     for (auto & elem : groupData->sources)
                         sourcesA.push_back(elem.first);
                     IPv4AddressVector aMinusB = set_complement(sourcesA, receivedSources);
                     if (!aMinusB.empty()) {
                         EV_INFO << "Sending Group-and-Source-Specific Query for group '" << groupData->groupAddr
                                 << "' on interface '" << ie->getName() << "'.\n";
                         sendGroupAndSourceSpecificQuery(groupData, aMinusB);
                     }
                 }
                 else if (groupData->filter == IGMPV3_FM_EXCLUDE) {
                     // compute X before modifying the state
                     IPv4AddressVector sourcesX;
                     for (auto & elem : groupData->sources) {
                         if (elem.second->sourceTimer->isScheduled())
                             sourcesX.push_back(elem.first);
                     }
 
                     // EXCLUDE(X,Y) -> TO_IN(A) -> EXCLUDE(X+A,Y-A): (A) = GMI
                     for (auto & receivedSource : receivedSources) {
                         EV_DETAIL << "Setting source timer of '" << receivedSource << "' to '" << groupMembershipInterval << "'.\n";
                         SourceRecord *record = groupData->getOrCreateSourceRecord(receivedSource);
                         startTimer(record->sourceTimer, groupMembershipInterval);
                     }
 
                     // Send Q(G,X-A)
                     IPv4AddressVector xMinusA = set_complement(sourcesX, receivedSources);
                     if (!xMinusA.empty()) {
                         EV_INFO << "Sending Group-and-Source-Specific Query for group '" << groupData->groupAddr
                                 << "' on interface '" << ie->getName() << "'.\n";
                         sendGroupAndSourceSpecificQuery(groupData, xMinusA);
                     }
 
                     // Send Q(G)
                     EV_INFO << "Sending Group-Specific Query for group '" << groupData->groupAddr
                             << "' on interface '" << ie->getName() << "'.\n";
                     sendGroupSpecificQuery(groupData);
                 }
             }
             else if (gr.recordType == IGMPV3_RT_TO_EX) {
                 EV_DETAIL << "Received TO_EX" << receivedSources << " report.\n";
 
                 if (groupData->filter == IGMPV3_FM_INCLUDE) {
                     // INCLUDE (A) -> TO_EX(B) -> EXCLUDE (A*B,B-A): Group Timer = GMI
                     EV_DETAIL << "Setting group timer to '" << groupMembershipInterval << "'.\n";
                     startTimer(groupData->timer, groupMembershipInterval);
 
                     //change to mode exclude
                     groupData->filter = IGMPV3_FM_EXCLUDE;
 
                     // save A
                     IPv4AddressVector sourcesA;
                     for (auto & elem : groupData->sources)
                         sourcesA.push_back(elem.first);
 
                     // (B-A) = 0
                     for (auto & receivedSource : receivedSources) {
                         if (!groupData->hasSourceRecord(receivedSource)) {
                             EV_DETAIL << "Setting source timer of '" << receivedSource << "' to '0'.\n";
                             groupData->createSourceRecord(receivedSource);
                         }
                     }
 
                     // Delete A-B
                     for (auto & elem : sourcesA) {
                         if (find(receivedSources.begin(), receivedSources.end(), elem) == receivedSources.end()) {
                             EV_DETAIL << "Deleting source record of '" << elem << "'.\n";
                             groupData->deleteSourceRecord(elem);
                         }
                     }
 
                     // Send Q(G,A*B)
                     IPv4AddressVector aIntersectB = set_intersection(sourcesA, receivedSources);
                     if (!aIntersectB.empty()) {
                         EV_INFO << "Sending Group-Specific Query for group '" << groupData->groupAddr
                                 << "' on interface '" << ie->getName() << "'.\n";
                         sendGroupAndSourceSpecificQuery(groupData, aIntersectB);
                     }
                 }
                 else if (groupData->filter == IGMPV3_FM_EXCLUDE) {
                     // EXCLUDE (X,Y) -> TO_EX (A) -> EXCLUDE (A-Y,Y*A): Group Timer = GMI
                     EV_DETAIL << "Setting group timer to '" << groupMembershipInterval << "'.\n";
                     startTimer(groupData->timer, groupMembershipInterval);
 
                     // save Y
                     IPv4AddressVector sourcesY;
                     for (auto & elem : groupData->sources) {
                         if (!elem.second->sourceTimer->isScheduled())
                             sourcesY.push_back(elem.first);
                     }
 
                     // Delete (X-A) Delete (Y-A)
                     for (auto it = groupData->sources.begin(); it != groupData->sources.end(); ) {
                         auto rec = it->first;
                         ++it; // let's advance the iterator now because the deleteSourcerecord call will invalidate it and we wont be able to increment it after that
                         if (find(receivedSources.begin(), receivedSources.end(), it->first) == receivedSources.end()) {
                             EV_DETAIL << "Deleting source record of '" << rec << "'.\n";
                             groupData->deleteSourceRecord(rec);
                         }
                     }
 
                     // (A-X-Y) = GMI FIXME should be set to Group Timer
                     for (auto & receivedSource : receivedSources) {
                         if (!groupData->hasSourceRecord(receivedSource)) {
                             EV_DETAIL << "Setting source timer of '" << receivedSource << "' to '" << groupMembershipInterval << "'.\n";
                             SourceRecord *record = groupData->createSourceRecord(receivedSource);
                             startTimer(record->sourceTimer, groupMembershipInterval);
                         }
                     }
 
                     // Send Q(G,A-Y)
                     IPv4AddressVector aMinusY = set_complement(receivedSources, sourcesY);
                     if (!aMinusY.empty()) {
                         EV_INFO << "Sending Group-Specific Query for group '" << groupData->groupAddr
                                 << "' on interface '" << ie->getName() << "'.\n";
                         sendGroupAndSourceSpecificQuery(groupData, aMinusY);
                     }
                 }
             }
 
             EV_DETAIL << "New Router State is " << groupData->getStateInfo() << ".\n";
 
             // update interface state
             IPv4MulticastSourceList newSourceList;
             groupData->collectForwardedSources(newSourceList);
 
             if (newSourceList != oldSourceList) {
                 ie->ipv4Data()->setMulticastListeners(groupData->groupAddr, newSourceList.filterMode, newSourceList.sources);
                 // TODO notifications?
             }
         }
     }
     delete msg;
 }

void inet::IGMPv3::processRouterGeneralQueryTimer ( cMessage * msg )

protectedvirtual

Referenced by handleMessage().

 {
     RouterInterfaceData *interfaceData = (RouterInterfaceData *)msg->getContextPointer();
     InterfaceEntry *ie = interfaceData->ie;
     ASSERT(ie);
     EV_INFO << "General Query timer expired on interface='" << ie->getName() << "'.\n";
     RouterState state = interfaceData->state;
     if (state == IGMPV3_RS_QUERIER || state == IGMPV3_RS_NON_QUERIER) {
         EV_INFO << "Sending General Query on interface '" << ie->getName() << "', and scheduling next Query to '"
                 << (simTime() + queryInterval) << "'.\n";
         interfaceData->state = IGMPV3_RS_QUERIER;
         sendGeneralQuery(interfaceData, queryResponseInterval);
         startTimer(msg, queryInterval);
     }
 }

void inet::IGMPv3::processRouterGroupTimer ( cMessage * msg )

protectedvirtual

Function for switching EXCLUDE filter mode back to INCLUDE If at least one source timer is still runing, it will switch to Include mode.

Else if no source timer is running, group record is deleted.

Referenced by handleMessage().

 {
     RouterGroupData *groupData = (RouterGroupData *)msg->getContextPointer();
     InterfaceEntry *ie = groupData->parent->ie;
 
     EV_INFO << "Group Timer for group '" << groupData->groupAddr << "' on interface '" << ie->getName() << "' has expired.\n";
     EV_DETAIL << "Router State is " << groupData->getStateInfo() << ".\n";
 
     if (groupData->filter == IGMPV3_FM_EXCLUDE) {
         bool timerRunning = false;
         for (auto it = groupData->sources.begin(); it != groupData->sources.end(); ++it) {
             if (!it->second->sourceTimer->isScheduled()) {
                 EV_DETAIL << "Deleting source record of '" << it->first << "'.\n";
                 groupData->deleteSourceRecord(it->first);
             }
             else {
                 timerRunning = true;
             }
         }
         groupData->filter = IGMPV3_FM_INCLUDE;
         if (!timerRunning) {
             EV_DETAIL << "Deleting multicast listener for group '" << groupData->groupAddr << "' from the interface table.\n";
             ie->ipv4Data()->removeMulticastListener(groupData->groupAddr);
             groupData->parent->deleteGroupData(groupData->groupAddr);
 
             EV_DETAIL << "New Router State is <deleted>.\n";
             return;
         }
     }
 
     EV_DETAIL << "New Router State is " << groupData->getStateInfo() << ".\n";
 }

void inet::IGMPv3::processRouterSourceTimer ( cMessage * msg )

protectedvirtual

Function for checking expired source timers if group is in INCLUDE filter mode.

Referenced by handleMessage().

 {
     SourceRecord *sourceRecord = (SourceRecord *)msg->getContextPointer();
     RouterGroupData *groupData = sourceRecord->parent;
     InterfaceEntry *ie = groupData->parent->ie;
 
     EV_INFO << "Source timer for group '" << groupData->groupAddr << "' and source '" << sourceRecord->sourceAddr
             << "' on interface '" << ie->getName() << "' has expired.\n";
 
     bool last = true;
     if (groupData->filter == IGMPV3_FM_INCLUDE) {
         groupData->deleteSourceRecord(sourceRecord->sourceAddr);
     }
     for (auto & elem : groupData->sources) {
         if (elem.second->sourceTimer->isScheduled()) {
             last = false;
         }
     }
     if (last) {
         ie->ipv4Data()->removeMulticastListener(groupData->groupAddr);
         groupData->parent->deleteGroupData(groupData->groupAddr);
     }
 }

void inet::IGMPv3::receiveSignal	(	cComponent *	source,
		simsignal_t	signalID,
		cObject *	obj,
		cObject *	details
	)

overrideprotectedvirtual

 {
     Enter_Method_Silent();
 
     InterfaceEntry *ie;
     int interfaceId;
     const IPv4MulticastGroupSourceInfo *info;
     if (signalID == NF_INTERFACE_CREATED) {
         ie = const_cast<InterfaceEntry *>(check_and_cast<const InterfaceEntry *>(obj));
         if (ie->isMulticast())
             configureInterface(ie);
     }
     else if (signalID == NF_INTERFACE_DELETED) {
         ie = const_cast<InterfaceEntry *>(check_and_cast<const InterfaceEntry *>(obj));
         if (ie->isMulticast()) {
             interfaceId = ie->getInterfaceId();
             deleteHostInterfaceData(interfaceId);
             deleteRouterInterfaceData(interfaceId);
         }
     }
     else if (signalID == NF_IPv4_MCAST_CHANGE) {
         info = check_and_cast<const IPv4MulticastGroupSourceInfo *>(obj);
         multicastSourceListChanged(info->ie, info->groupAddress, info->sourceList);
     }
 }

void inet::IGMPv3::sendGeneralQuery	(	RouterInterfaceData *	interface,
		double	maxRespTime
	)

protectedvirtual

Referenced by configureInterface(), and processRouterGeneralQueryTimer().

 {
     if (interfaceData->state == IGMPV3_RS_QUERIER) {
         IGMPv3Query *msg = new IGMPv3Query("IGMPv3 query");
         msg->setType(IGMP_MEMBERSHIP_QUERY);
         msg->setMaxRespCode((int)(maxRespTime * 10.0));
         msg->setByteLength(12);
         sendQueryToIP(msg, interfaceData->ie, IPv4Address::ALL_HOSTS_MCAST);
 
         numQueriesSent++;
         numGeneralQueriesSent++;
     }
 }

void inet::IGMPv3::sendGroupAndSourceSpecificQuery	(	RouterGroupData *	group,
		const IPv4AddressVector &	sources
	)

protectedvirtual

Referenced by processReport().

 {
     ASSERT(!sources.empty());
 
     RouterInterfaceData *interfaceData = groupData->parent;
 
     if (interfaceData->state == IGMPV3_RS_QUERIER) {
         IGMPv3Query *msg = new IGMPv3Query("IGMPv3 query");
         msg->setType(IGMP_MEMBERSHIP_QUERY);
         msg->setGroupAddress(groupData->groupAddr);
         msg->setMaxRespCode((int)(lastMemberQueryInterval * 10.0));    // FIXME compute code
         msg->setSourceList(sources);
         msg->setByteLength(12 + (4 * sources.size()));
         sendQueryToIP(msg, interfaceData->ie, groupData->groupAddr);
 
         numQueriesSent++;
         numGroupAndSourceSpecificQueriesSent++;
     }
 }

void inet::IGMPv3::sendGroupReport	(	InterfaceEntry *	ie,
		const std::vector< GroupRecord > &	records
	)

protectedvirtual

Referenced by multicastSourceListChanged(), and processHostGroupQueryTimer().

 {
     EV << "IGMPv3: sending Membership Report on iface=" << ie->getName() << "\n";
     IGMPv3Report *msg = new IGMPv3Report("IGMPv3 report");
     unsigned int byteLength = 8;   // IGMPv3Report header size
     msg->setType(IGMPV3_MEMBERSHIP_REPORT);
     msg->setGroupRecordArraySize(records.size());
     for (int i = 0; i < (int)records.size(); ++i) {
         IPv4Address group = records[i].groupAddress;
         ASSERT(group.isMulticast() && !group.isLinkLocalMulticast());
         msg->setGroupRecord(i, records[i]);
         byteLength += 8 + records[i].sourceList.size() * 4;    // 8 byte header + n * 4 byte (IPv4Address)
     }
     msg->setByteLength(byteLength);
 
     sendReportToIP(msg, ie, IPv4Address::ALL_IGMPV3_ROUTERS_MCAST);
     numReportsSent++;
 }

void inet::IGMPv3::sendGroupSpecificQuery ( RouterGroupData * group )

protectedvirtual

Referenced by processReport().

 {
     RouterInterfaceData *interfaceData = groupData->parent;
     bool suppressFlag = groupData->timer->isScheduled() && groupData->timer->getArrivalTime() > simTime() + lastMemberQueryTime;
 
     // Set group timer to LMQT
     startTimer(groupData->timer, lastMemberQueryTime);
 
     if (interfaceData->state == IGMPV3_RS_QUERIER) {
         IGMPv3Query *msg = new IGMPv3Query("IGMPv3 query");
         msg->setType(IGMP_MEMBERSHIP_QUERY);
         msg->setGroupAddress(groupData->groupAddr);
         msg->setMaxRespCode((int)(lastMemberQueryInterval * 10.0));    // FIXME compute code
         msg->setSuppressRouterProc(suppressFlag);
         msg->setByteLength(12);
         sendQueryToIP(msg, interfaceData->ie, groupData->groupAddr);
 
         numQueriesSent++;
         numGroupSpecificQueriesSent++;
     }
 
     // TODO retransmission [Last Member Query Count]-1 times
 }

void inet::IGMPv3::sendQueryToIP	(	IGMPv3Query *	msg,
		InterfaceEntry *	ie,
		IPv4Address	dest
	)

protectedvirtual

Referenced by sendGeneralQuery(), sendGroupAndSourceSpecificQuery(), and sendGroupSpecificQuery().

 {
     ASSERT(ie->isMulticast());
 
     IPv4ControlInfo *controlInfo = new IPv4ControlInfo();
     controlInfo->setProtocol(IP_PROT_IGMP);
     controlInfo->setInterfaceId(ie->getInterfaceId());
     controlInfo->setTimeToLive(1);
     controlInfo->setDestAddr(dest);
     msg->setControlInfo(controlInfo);
 
     send(msg, "ipOut");
 }

void inet::IGMPv3::sendReportToIP	(	IGMPv3Report *	msg,
		InterfaceEntry *	ie,
		IPv4Address	dest
	)

protectedvirtual

Referenced by processHostGeneralQueryTimer(), and sendGroupReport().

 {
     ASSERT(ie->isMulticast());
 
     IPv4ControlInfo *controlInfo = new IPv4ControlInfo();
     controlInfo->setProtocol(IP_PROT_IGMP);
     controlInfo->setInterfaceId(ie->getInterfaceId());
     controlInfo->setTimeToLive(1);
     controlInfo->setDestAddr(dest);
     msg->setControlInfo(controlInfo);
 
     send(msg, "ipOut");
 }

void inet::IGMPv3::startTimer	(	cMessage *	timer,
		double	interval
	)

protectedvirtual

Referenced by configureInterface(), processQuery(), processReport(), processRouterGeneralQueryTimer(), and sendGroupSpecificQuery().

 {
     ASSERT(timer);
     cancelEvent(timer);
     scheduleAt(simTime() + interval, timer);
 }

Member Data Documentation

bool inet::IGMPv3::enabled

protected

Referenced by configureInterface(), handleMessage(), initialize(), and multicastSourceListChanged().

double inet::IGMPv3::groupMembershipInterval

protected

Referenced by initialize(), and processReport().

InterfaceToHostDataMap inet::IGMPv3::hostData

protected

Referenced by deleteHostInterfaceData(), getHostInterfaceData(), and ~IGMPv3().

IInterfaceTable* inet::IGMPv3::ift

protected

Referenced by initialize(), processQuery(), and processReport().

double inet::IGMPv3::lastMemberQueryCount

protected

Referenced by initialize(), and processQuery().

double inet::IGMPv3::lastMemberQueryInterval

protected

Referenced by initialize(), sendGroupAndSourceSpecificQuery(), and sendGroupSpecificQuery().

double inet::IGMPv3::lastMemberQueryTime

protected

Referenced by initialize(), and sendGroupSpecificQuery().

int inet::IGMPv3::numGeneralQueriesRecv

protected

Referenced by initialize().

int inet::IGMPv3::numGeneralQueriesSent

protected

Referenced by initialize(), and sendGeneralQuery().

int inet::IGMPv3::numGroupAndSourceSpecificQueriesRecv

protected

Referenced by initialize().

int inet::IGMPv3::numGroupAndSourceSpecificQueriesSent

protected

Referenced by initialize(), and sendGroupAndSourceSpecificQuery().

int inet::IGMPv3::numGroups

protected

Referenced by inet::IGMPv3::HostInterfaceData::deleteGroupData(), inet::IGMPv3::RouterInterfaceData::deleteGroupData(), inet::IGMPv3::HostInterfaceData::getOrCreateGroupData(), inet::IGMPv3::RouterInterfaceData::getOrCreateGroupData(), and initialize().

int inet::IGMPv3::numGroupSpecificQueriesRecv

protected

Referenced by initialize().

int inet::IGMPv3::numGroupSpecificQueriesSent

protected

Referenced by initialize(), and sendGroupSpecificQuery().

int inet::IGMPv3::numHostGroups

protected

Referenced by inet::IGMPv3::HostInterfaceData::deleteGroupData(), inet::IGMPv3::HostInterfaceData::getOrCreateGroupData(), and initialize().

int inet::IGMPv3::numQueriesRecv

protected

Referenced by initialize(), and processQuery().

int inet::IGMPv3::numQueriesSent

protected

Referenced by initialize(), sendGeneralQuery(), sendGroupAndSourceSpecificQuery(), and sendGroupSpecificQuery().

int inet::IGMPv3::numReportsRecv

protected

Referenced by initialize(), and processReport().

int inet::IGMPv3::numReportsSent

protected

Referenced by initialize(), processHostGeneralQueryTimer(), and sendGroupReport().

int inet::IGMPv3::numRouterGroups

protected

Referenced by inet::IGMPv3::RouterInterfaceData::deleteGroupData(), inet::IGMPv3::RouterInterfaceData::getOrCreateGroupData(), and initialize().

double inet::IGMPv3::otherQuerierPresentInterval

protected

Referenced by initialize(), and processQuery().

double inet::IGMPv3::queryInterval

protected

Referenced by initialize(), and processRouterGeneralQueryTimer().

double inet::IGMPv3::queryResponseInterval

protected

Referenced by configureInterface(), initialize(), and processRouterGeneralQueryTimer().

int inet::IGMPv3::robustness

protected

Referenced by initialize().

InterfaceToRouterDataMap inet::IGMPv3::routerData

protected

Referenced by configureInterface(), deleteRouterInterfaceData(), getRouterInterfaceData(), and ~IGMPv3().

IRoutingTable* inet::IGMPv3::rt

protected

Referenced by configureInterface(), initialize(), processQuery(), and processReport().

double inet::IGMPv3::startupQueryCount

protected

Referenced by initialize().

double inet::IGMPv3::startupQueryInterval

protected

Referenced by configureInterface(), and initialize().

double inet::IGMPv3::unsolicitedReportInterval

protected

Referenced by initialize().

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

Classes

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation