ns-3
ns3::EventImpl Class Reference

a simulation event More...

#include <event-impl.h>

Inheritance diagram for ns3::EventImpl:
Collaboration diagram for ns3::EventImpl:

List of all members.

Public Member Functions

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

Protected Member Functions

virtual void Notify (void)=0

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.


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.

void ns3::EventImpl::Invoke ( void  )

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

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

bool ns3::EventImpl::IsCancelled ( void  )

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