a simulation event More...

#include <event-impl.h>

Inheritance diagram for ns3::EventImpl:

Collaboration diagram for ns3::EventImpl:

Public Member Functions
	EventImpl ()
virtual	~EventImpl ()=0
void	Cancel (void)
void	Invoke (void)
bool	IsCancelled (void)
Public Member Functions inherited from ns3::SimpleRefCount< EventImpl >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const

Protected Member Functions
virtual void	Notify (void)=0

Private Attributes
bool	m_cancel

Additional Inherited Members
Static Public Member Functions inherited from ns3::SimpleRefCount< EventImpl >
static void	Cleanup (void)

Detailed Description

a simulation event

Each subclass of this base class represents a simulation event. The EventImpl::Invoke method will be invoked by the simulation engine when the time associated to this event expires. This class is obviously (there are Ref and Unref methods) reference-counted and most subclasses are usually created by one of the many Simulator::Schedule methods.

Definition at line 39 of file event-impl.h.

Constructor & Destructor Documentation

ns3::EventImpl::EventImpl ( )

Definition at line 29 of file event-impl.cc.

ns3::EventImpl::~EventImpl ( )

pure virtual

Definition at line 25 of file event-impl.cc.

Member Function Documentation

void ns3::EventImpl::Cancel ( void )

Marks the event as 'canceled'. The event will not be removed from the event list but the simulation engine will check its canceled status before calling Invoke.

Definition at line 44 of file event-impl.cc.

References m_cancel.

void ns3::EventImpl::Invoke ( void )

Called by the simulation engine to notify the event that it has expired.

Definition at line 35 of file event-impl.cc.

References m_cancel, and Notify().

Referenced by ns3::DefaultSimulatorImpl::Destroy(), ns3::RealtimeSimulatorImpl::Destroy(), ns3::DistributedSimulatorImpl::Destroy(), ns3::DefaultSimulatorImpl::ProcessOneEvent(), and ns3::DistributedSimulatorImpl::ProcessOneEvent().

Here is the call graph for this function: