A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::EventImpl Class Referenceabstract

a simulation event More...

#include <event-impl.h>

+ Inheritance diagram for ns3::EventImpl:

Public Member Functions

void Cancel (void)
 
void Invoke (void)
 
bool IsCancelled (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< EventImpl >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (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.

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 50 of file event-impl.cc.

References NS_LOG_FUNCTION.

void ns3::EventImpl::Invoke ( void  )

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

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

References NS_LOG_FUNCTION.

bool ns3::EventImpl::IsCancelled ( void  )
Returns
true if the event has been canceled.

Invoked by the simulation engine before calling Invoke.

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

References NS_LOG_FUNCTION.

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


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