A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::internal::TimerImpl Class Referenceabstract

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

#include "timer-impl.h"

+ Inheritance diagram for ns3::internal::TimerImpl:

Public Member Functions

virtual ~TimerImpl ()
 Destructor.
 
virtual void Invoke ()=0
 Invoke the expire function.
 
virtual EventId Schedule (const Time &delay)=0
 Schedule the callback for a future time.
 
template<typename... Args>
void SetArgs (Args... args)
 Set the arguments to be used when invoking the expire function.
 

Detailed Description

The timer implementation underlying Timer and Watchdog.

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

Constructor & Destructor Documentation

◆ ~TimerImpl()

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

Destructor.

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

Member Function Documentation

◆ Invoke()

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

Invoke the expire function.

Referenced by ns3::Watchdog::Expire(), and ns3::TrickleTimer::TimerExpire().

+ Here is the caller graph for this function:

◆ Schedule()

virtual EventId ns3::internal::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().

+ Here is the caller graph for this function:

◆ SetArgs()

template<typename... Args>
void ns3::internal::TimerImpl::SetArgs ( Args...  args)

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

Template Parameters
Args[deduced] Type template parameter pack
Parameters
[in]argsThe arguments to pass to the invoked method

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

References NS_FATAL_ERROR.

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

+ Here is the caller graph for this function:

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