wsf::comm::IGMP_SubscriptionEvent Class Reference
An event class for handling join/leave multicast delays. More...
#include <WsfCommProtocolIGMP.hpp>
Inheritance diagram for wsf::comm::IGMP_SubscriptionEvent:
Collaboration diagram for wsf::comm::IGMP_SubscriptionEvent:
Public Types | |
| enum class | EventType : size_t { cJOIN , cLEAVE } |
| Public Types inherited from WsfEvent | |
| enum | EventDisposition { cDELETE , cRESCHEDULE } |
Public Member Functions | |
| IGMP_SubscriptionEvent (double aSimTime, EventType aEventType, const Address &aCommAddress, const Address &aMulticastGroupAddress) | |
| ~IGMP_SubscriptionEvent () override=default | |
| EventDisposition | Execute () override |
| Public Member Functions inherited from WsfEvent | |
| WsfEvent ()=default | |
| WsfEvent (double aSimTime, int aPriority=0) | |
| WsfEvent (const WsfEvent &aSrc)=delete | |
| Copy constructor and copy assignment deleted to prevent copying. | |
| WsfEvent & | operator= (const WsfEvent &aRhs)=delete |
| virtual | ~WsfEvent ()=default |
| double | GetTime () const |
| int | GetPriority () const |
| bool | ShouldExecute () const |
| void | SetTime (double aSimTime) |
| void | SetPriority (int aPriority) |
| void | SetShouldExecute (bool aExecute) |
| WsfSimulation * | GetSimulation () const |
| void | AddedToEventQueue (WsfSimulation &aSimulation) |
| Called when the event is added to the event queue of the specified simulation. | |
Detailed Description
An event class for handling join/leave multicast delays.
Member Enumeration Documentation
◆ EventType
|
strong |
Constructor & Destructor Documentation
◆ IGMP_SubscriptionEvent()
| wsf::comm::IGMP_SubscriptionEvent::IGMP_SubscriptionEvent | ( | double | aSimTime, |
| EventType | aEventType, | ||
| const Address & | aCommAddress, | ||
| const Address & | aMulticastGroupAddress ) |
References WsfEvent::WsfEvent().
◆ ~IGMP_SubscriptionEvent()
|
overridedefault |
References Execute().
Member Function Documentation
◆ Execute()
|
overridevirtual |
Execute the specified event.
- Returns
- The disposition of the event. This indicates to the event manager what should be done with the event. If cRESCHEDULE then Execute should have called SetTime to set the time for which the event manager should reschedule the event.
Implements WsfEvent.
References WsfEvent::cDELETE, cJOIN, cLEAVE, WsfSimulation::GetCommNetworkManager(), WsfEvent::GetSimulation(), and WsfEvent::GetTime().
Referenced by ~IGMP_SubscriptionEvent().
The documentation for this class was generated from the following files: