A Discrete-Event Network Simulator
API
Public Member Functions | List of all members
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

◆ ~TimerImpl()

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

Destructor.

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

Member Function Documentation

◆ Invoke()

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

Invoke the expire function.

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

◆ Schedule()

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

Schedule the callback for a future time.

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

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

◆ SetArgs() [1/6]

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

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

Template Parameters
T1[deduced] Type of the first argument.
Parameters
[in]a1The first argument

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

References ns3::if(), and NS_FATAL_ERROR.

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

◆ SetArgs() [2/6]

template<typename T1 , typename T2 >
void ns3::TimerImpl::SetArgs ( T1  a1,
T2  a2 
)
Template Parameters
T1[deduced] Type of the first argument.
T2[deduced] Type of the second argument.
Parameters
[in]a1the first argument
[in]a2the second argument

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

References ns3::if(), and NS_FATAL_ERROR.

◆ SetArgs() [3/6]

template<typename T1 , typename T2 , typename T3 >
void ns3::TimerImpl::SetArgs ( T1  a1,
T2  a2,
T3  a3 
)
Template Parameters
T1[deduced] Type of the first argument.
T2[deduced] Type of the second argument.
T3[deduced] Type of the third argument.
Parameters
[in]a1the first argument
[in]a2the second argument
[in]a3the third argument

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

References ns3::if(), and NS_FATAL_ERROR.

◆ SetArgs() [4/6]

template<typename T1 , typename T2 , typename T3 , typename T4 >
void ns3::TimerImpl::SetArgs ( T1  a1,
T2  a2,
T3  a3,
T4  a4 
)
Template Parameters
T1[deduced] Type of the first argument.
T2[deduced] Type of the second argument.
T3[deduced] Type of the third argument.
T4[deduced] Type of the fourth argument.
Parameters
[in]a1the first argument
[in]a2the second argument
[in]a3the third argument
[in]a4the fourth argument

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

References ns3::if(), and NS_FATAL_ERROR.

◆ SetArgs() [5/6]

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
T1[deduced] Type of the first argument.
T2[deduced] Type of the second argument.
T3[deduced] Type of the third argument.
T4[deduced] Type of the fourth argument.
T5[deduced] Type of the fifth argument.
Parameters
[in]a1the first argument
[in]a2the second argument
[in]a3the third argument
[in]a4the fourth argument
[in]a5the fifth argument

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

References ns3::if(), and NS_FATAL_ERROR.

◆ SetArgs() [6/6]

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
T1[deduced] Type of the first argument.
T2[deduced] Type of the second argument.
T3[deduced] Type of the third argument.
T4[deduced] Type of the fourth argument.
T5[deduced] Type of the fifth argument.
T6[deduced] Type of the sixth argument.
Parameters
[in]a1the first argument
[in]a2the second argument
[in]a3the third argument
[in]a4the fourth argument
[in]a5the fifth argument
[in]a6the sixth argument

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

References ns3::if(), and NS_FATAL_ERROR.


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