Public Member Functions | Protected Member Functions

ns3::EventImpl Class Reference
[Simulator]

a simulation event More...

#include <event-impl.h>

Inheritance diagram for ns3::EventImpl:
Inheritance graph
[legend]
Collaboration diagram for ns3::EventImpl:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void Invoke (void)
void Cancel (void)
bool IsCancelled (void)

Protected Member Functions

virtual void Notify (void)=0

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.

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

Invoked by the simulation engine before calling Invoke.


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