A Discrete-Event Network Simulator
API
ns3::TimerImpl Class Referenceabstract

The timer implementation underlying Timer and Watchdog. More...

#include <timer-impl.h>

+ Inheritance diagram for ns3::TimerImpl:

Public Member Functions

virtual ~TimerImpl ()
 Destructor. More...
 
virtual void Invoke (void)=0
 Invoke the expire function. More...
 
virtual EventId Schedule (const Time &delay)=0
 Schedule the callback for a future time. More...
 
template<typename T1 >
void SetArgs (T1 a1)
 Set the arguments to be used when invoking the expire function. More...
 
template<typename T1 , typename T2 >
void SetArgs (T1 a1, T2 a2)
 
template<typename T1 , typename T2 , typename T3 >
void SetArgs (T1 a1, T2 a2, T3 a3)
 
template<typename T1 , typename T2 , typename T3 , typename T4 >
void SetArgs (T1 a1, T2 a2, T3 a3, T4 a4)
 
template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
void SetArgs (T1 a1, T2 a2, T3 a3, T4 a4, T5 a5)
 
template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 >
void SetArgs (T1 a1, T2 a2, T3 a3, T4 a4, T5 a5, T6 a6)
 

Detailed Description

The timer implementation underlying Timer and Watchdog.

Definition at line 42 of file timer-impl.h.

Constructor & Destructor Documentation

virtual ns3::TimerImpl::~TimerImpl ( )
inlinevirtual

Destructor.

Definition at line 46 of file timer-impl.h.

Member Function Documentation

virtual void ns3::TimerImpl::Invoke ( void  )
pure virtual

Invoke the expire function.

Referenced by ns3::Watchdog::Expire().

+ Here is the caller graph for this function:

virtual EventId ns3::TimerImpl::Schedule ( const Time delay)
pure virtual

Schedule the callback for a future time.

Parameters
delayThe amount of time until the timer expires.
Returns
The scheduled EventId.

Referenced by ns3::Timer::Resume(), and ns3::Timer::Schedule().

+ Here is the caller graph for this function:

template<typename T1 >
void ns3::TimerImpl::SetArgs ( T1  a1)

Set the arguments to be used when invoking the expire function.

Template Parameters
T1Type of the first argument.
Parameters
a1The first argument

Definition at line 974 of file timer-impl.h.

References NS_FATAL_ERROR.

Referenced by ns3::Watchdog::SetArguments(), and ns3::Timer::SetArguments().

+ Here is the caller graph for this function:

template<typename T1 , typename T2 >
void ns3::TimerImpl::SetArgs ( T1  a1,
T2  a2 
)
Template Parameters
T1Type of the first argument.
T2Type of the second argument.
Parameters
a1the first argument
a2the second argument

Definition at line 990 of file timer-impl.h.

References NS_FATAL_ERROR.

template<typename T1 , typename T2 , typename T3 >
void ns3::TimerImpl::SetArgs ( T1  a1,
T2  a2,
T3  a3 
)
Template Parameters
T1Type of the first argument.
T2Type of the second argument.
T3Type of the third argument.
Parameters
a1the first argument
a2the second argument
a3the third argument

Definition at line 1007 of file timer-impl.h.

References NS_FATAL_ERROR.

template<typename T1 , typename T2 , typename T3 , typename T4 >
void ns3::TimerImpl::SetArgs ( T1  a1,
T2  a2,
T3  a3,
T4  a4 
)
Template Parameters
T1Type of the first argument.
T2Type of the second argument.
T3Type of the third argument.
T4Type of the fourth argument.
Parameters
a1the first argument
a2the second argument
a3the third argument
a4the fourth argument

Definition at line 1025 of file timer-impl.h.

References NS_FATAL_ERROR.

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
void ns3::TimerImpl::SetArgs ( T1  a1,
T2  a2,
T3  a3,
T4  a4,
T5  a5 
)
Template Parameters
T1Type of the first argument.
T2Type of the second argument.
T3Type of the third argument.
T4Type of the fourth argument.
T5Type of the fifth argument.
Parameters
a1the first argument
a2the second argument
a3the third argument
a4the fourth argument
a5the fifth argument

Definition at line 1044 of file timer-impl.h.

References NS_FATAL_ERROR.

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 >
void ns3::TimerImpl::SetArgs ( T1  a1,
T2  a2,
T3  a3,
T4  a4,
T5  a5,
T6  a6 
)
Template Parameters
T1Type of the first argument.
T2Type of the second argument.
T3Type of the third argument.
T4Type of the fourth argument.
T5Type of the fifth argument.
T6Type of the sixth argument.
Parameters
a1the first argument
a2the second argument
a3the third argument
a4the fourth argument
a5the fifth argument
a6the sixth argument

Definition at line 1064 of file timer-impl.h.

References NS_FATAL_ERROR.


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