Control the scheduling of simulation events. More...

#include "simulator.h"

Collaboration diagram for ns3::Simulator:

Public Types
enum	: uint32_t { NO_CONTEXT = 0xffffffff }
	Context enum values. More...

Public Member Functions
	Simulator ()=delete

	~Simulator ()=delete

Static Public Member Functions
static void	Cancel (const EventId &id)
	Set the cancel bit on this event: the event's associated function will not be invoked when it expires.

static void	Destroy ()
	Execute the events scheduled with ScheduleDestroy().

static uint32_t	GetContext ()
	Get the current simulation context.

static Time	GetDelayLeft (const EventId &id)
	Get the remaining time until this event will execute.

static uint64_t	GetEventCount ()
	Get the number of events executed.

static Ptr< SimulatorImpl >	GetImplementation ()
	Get the SimulatorImpl singleton.

static Time	GetMaximumSimulationTime ()
	Get the maximum representable simulation time.

static EventId	GetStopEvent ()
	Returns the Stop Event, or an invalid event if the simulation does not have a scheduled stop time.

static uint32_t	GetSystemId ()
	Get the system id of this simulator.

static bool	IsExpired (const EventId &id)
	Check if an event has already run or been cancelled.

static bool	IsFinished ()
	Check if the simulation should finish.

static Time	Now ()
	Return the current simulation virtual time.

static void	Remove (const EventId &id)
	Remove an event from the event list.

static void	Run ()
	Run the simulation.

static EventId	Schedule (const Time &delay, const Ptr< EventImpl > &event)
	Schedule a future event execution (in the same context).

static EventId	ScheduleDestroy (const Ptr< EventImpl > &event)
	Schedule an event to run at the end of the simulation, after the Stop() time or condition has been reached.

static EventId	ScheduleNow (const Ptr< EventImpl > &event)
	Schedule an event to run at the current virtual time.

static void	ScheduleWithContext (uint32_t context, const Time &delay, EventImpl *event)
	Schedule a future event execution (in a different context).

static void	SetImplementation (Ptr< SimulatorImpl > impl)

static void	SetScheduler (ObjectFactory schedulerFactory)
	Set the scheduler type with an ObjectFactory.

static void	Stop ()
	Tell the Simulator the calling event should be the last one executed.

static EventId	Stop (const Time &delay)
	Schedule the time delay until the Simulator should stop.

Schedule events (in the same context) to run at a future time.
template<typename FUNC , std::enable_if_t<!std::is_convertible_v< FUNC, Ptr< EventImpl > >, int > = 0, std::enable_if_t<!std::is_function_v< std::remove_pointer_t< FUNC > >, int > = 0, typename... Ts>
static EventId	Schedule (const Time &delay, FUNC f, Ts &&... args)
	Schedule an event to expire after `delay`.

template<typename... Us, typename... Ts>
static EventId	Schedule (const Time &delay, void(*f)(Us...), Ts &&... args)
	Schedule an event to expire after `delay`.

Schedule events (in a different context) to run now or at a future time.
See main-test-sync.cc for example usage.
template<typename FUNC , std::enable_if_t<!std::is_convertible_v< FUNC, Ptr< EventImpl > >, int > = 0, std::enable_if_t<!std::is_function_v< std::remove_pointer_t< FUNC > >, int > = 0, typename... Ts>
static void	ScheduleWithContext (uint32_t context, const Time &delay, FUNC f, Ts &&... args)
	Schedule an event with the given context.

template<typename... Us, typename... Ts>
static void	ScheduleWithContext (uint32_t context, const Time &delay, void(*f)(Us...), Ts &&... args)
	Schedule an event with the given context.

Schedule events (in the same context) to run now.
template<typename FUNC , std::enable_if_t<!std::is_convertible_v< FUNC, Ptr< EventImpl > >, int > = 0, std::enable_if_t<!std::is_function_v< std::remove_pointer_t< FUNC > >, int > = 0, typename... Ts>
static EventId	ScheduleNow (FUNC f, Ts &&... args)
	Schedule an event to expire Now.

template<typename... Us, typename... Ts>
static EventId	ScheduleNow (void(*f)(Us...), Ts &&... args)
	Schedule an event to expire Now.

Schedule events to run at the end of the simulation, when Simulator:Destroy() is
called.
template<typename FUNC , std::enable_if_t<!std::is_convertible_v< FUNC, Ptr< EventImpl > >, int > = 0, std::enable_if_t<!std::is_function_v< std::remove_pointer_t< FUNC > >, int > = 0, typename... Ts>
static EventId	ScheduleDestroy (FUNC f, Ts &&... args)
	Schedule an event to run at the end of the simulation, when Simulator::Destroy() is called.

template<typename... Us, typename... Ts>
static EventId	ScheduleDestroy (void(*f)(Us...), Ts &&... args)
	Schedule an event to run at the end of the simulation, when Simulator::Destroy() is called.

Static Private Member Functions
static EventId	DoSchedule (const Time &delay, EventImpl *event)
	Implementation of the various Schedule methods.

static EventId	DoScheduleDestroy (EventImpl *event)
	Implementation of the various ScheduleDestroy methods.

static EventId	DoScheduleNow (EventImpl *event)
	Implementation of the various ScheduleNow methods.

Static Private Attributes
static EventId	m_stopEvent
	Stop event (if present)

Detailed Description

Control the scheduling of simulation events.

The internal simulation clock is maintained as a 64-bit integer in a unit specified by the user through the Time::SetResolution function. This means that it is not possible to specify event expiration times with anything better than this user-specified accuracy. Events whose expiration time is the same modulo this accuracy are scheduled in FIFO order: the first event inserted in the scheduling queue is scheduled to expire first.

A simple example of how to use the Simulator class to schedule events is shown in sample-simulator.cc:

/*
 * Copyright (c) 2010 INRIA
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
 
#include "ns3/command-line.h"
#include "ns3/double.h"
#include "ns3/nstime.h"
#include "ns3/random-variable-stream.h"
#include "ns3/simulator.h"
 
#include <iostream>
 
/**
 * @file
 * @ingroup core-examples
 * @ingroup simulator
 * Example program demonstrating use of various Schedule functions.
 */
 
using namespace ns3;
 
namespace
{
 
/** Simple model object to illustrate event handling. */
class MyModel
{
  public:
    /** Start model execution by scheduling a HandleEvent. */
    void Start();
 
  private:
    /**
     *  Simple event handler.
     *
     * @param [in] eventValue Event argument.
     */
    void HandleEvent(double eventValue);
};
 
void
MyModel::Start()
{
    Simulator::Schedule(Seconds(10), &MyModel::HandleEvent, this, Simulator::Now().GetSeconds());
}
 
void
MyModel::HandleEvent(double value)
{
    std::cout << "Member method received event at " << Simulator::Now().GetSeconds()
              << "s started at " << value << "s" << std::endl;
}
 
/**
 * Simple function event handler which Starts a MyModel object.
 *
 * @param [in] model The MyModel object to start.
 */
void
ExampleFunction(MyModel* model)
{
    std::cout << "ExampleFunction received event at " << Simulator::Now().GetSeconds() << "s"
              << std::endl;
    model->Start();
}
 
/**
 * Simple function event handler; this function is called randomly.
 */
void
RandomFunction()
{
    std::cout << "RandomFunction received event at " << Simulator::Now().GetSeconds() << "s"
              << std::endl;
}
 
/** Simple function event handler; the corresponding event is cancelled. */
void
CancelledEvent()
{
    std::cout << "I should never be called... " << std::endl;
}
 
} // unnamed namespace
 
int
main(int argc, char* argv[])
{
    CommandLine cmd(__FILE__);
    cmd.Parse(argc, argv);
 
    MyModel model;
    Ptr<UniformRandomVariable> v = CreateObject<UniformRandomVariable>();
    v->SetAttribute("Min", DoubleValue(10));
    v->SetAttribute("Max", DoubleValue(20));
 
    Simulator::Schedule(Seconds(10), &ExampleFunction, &model);
 
    Simulator::Schedule(Seconds(v->GetValue()), &RandomFunction);
 
    EventId id = Simulator::Schedule(Seconds(30), &CancelledEvent);
    Simulator::Cancel(id);
 
    Simulator::Schedule(Seconds(25), []() {
        std::cout << "Code within a lambda expression at time " << Simulator::Now().As(Time::S)
                  << std::endl;
    });
 
    Simulator::Run();
 
    Simulator::Destroy();
 
    return 0;
}

Definition at line 56 of file simulator.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : uint32_t

Context enum values.

Internal:: This enum type is fixed to match the representation size of simulation context.

Enumerator
NO_CONTEXT	Flag for events not associated with any particular context.

Definition at line 194 of file simulator.h.

Constructor & Destructor Documentation

◆ Simulator()

ns3::Simulator::Simulator ( )

delete

◆ ~Simulator()

ns3::Simulator::~Simulator ( )

delete

Member Function Documentation

◆ Cancel()

void ns3::Simulator::Cancel ( const EventId & id )

static

Set the cancel bit on this event: the event's associated function will not be invoked when it expires.

This method has the same visible effect as the ns3::Simulator::Remove method but its algorithmic complexity is much lower: it has O(1) complexity. This method has the exact same semantics as ns3::EventId::Cancel. Note that it is not possible to cancel events which were scheduled for the "destroy" time. Doing so will result in a program error (crash).

Parameters

[in] id the event to cancel

Definition at line 274 of file simulator.cc.

References ns3::SimulatorImpl::Cancel(), ns3::GetImpl(), and ns3::PeekImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Destroy()

void ns3::Simulator::Destroy ( )

static

Execute the events scheduled with ScheduleDestroy().

This method is typically invoked at the end of a simulation to avoid false-positive reports by a leak checker. After this method has been invoked, it is actually possible to restart a new simulation with a set of calls to Simulator::Run, Simulator::Schedule and Simulator::ScheduleWithContext.

Definition at line 131 of file simulator.cc.

References ns3::LogSetNodePrinter(), ns3::LogSetTimePrinter(), NS_LOG_FUNCTION_NOARGS, and ns3::PeekImpl().

Here is the call graph for this function:

◆ DoSchedule()

EventId ns3::Simulator::DoSchedule	(	const Time &	delay,
		EventImpl *	event )

staticprivate

Implementation of the various Schedule methods.

Parameters

[in]	delay	Delay until the event should execute.
[in]	event	The event to execute.

Returns: The EventId.

Definition at line 240 of file simulator.cc.

References ns3::Singleton< DesMetrics >::Get(), ns3::GetImpl(), Now(), ns3::SimulatorImpl::Schedule(), and ns3::DesMetrics::Trace().

Referenced by Schedule(), Schedule(), and Schedule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoScheduleDestroy()

EventId ns3::Simulator::DoScheduleDestroy ( EventImpl * event )

staticprivate

Implementation of the various ScheduleDestroy methods.

Parameters

[in] event The event to execute.

Returns: The EventId.

Definition at line 258 of file simulator.cc.

References ns3::GetImpl(), and ns3::SimulatorImpl::ScheduleDestroy().

Referenced by ScheduleDestroy(), ScheduleDestroy(), and ScheduleDestroy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoScheduleNow()

EventId ns3::Simulator::DoScheduleNow ( EventImpl * event )

staticprivate

Implementation of the various ScheduleNow methods.

Parameters

[in] event The event to execute.

Returns: The EventId.

Definition at line 249 of file simulator.cc.

References ns3::Singleton< DesMetrics >::Get(), ns3::GetImpl(), Now(), ns3::SimulatorImpl::ScheduleNow(), and ns3::DesMetrics::Trace().

Referenced by ScheduleNow(), ScheduleNow(), and ScheduleNow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetContext()

uint32_t ns3::Simulator::GetContext ( )

static

Get the current simulation context.

The simulation context is the ns-3 notion of a Logical Process. Events in a single context should only modify state associated with that context. Events for objects in other contexts should be scheduled with ScheduleWithContext() to track the context switches. In other words, events in different contexts should be mutually thread safe, by not modify overlapping model state.

In circumstances where the context can't be determined, such as during object initialization, the enum value NO_CONTEXT should be used.

Returns: The current simulation context

Definition at line 307 of file simulator.cc.

References ns3::SimulatorImpl::GetContext(), and ns3::GetImpl().

Referenced by ns3::DefaultNodePrinter(), ns3::lorawan::LoraPacketTracker::MacGwReceptionCallback(), ns3::lorawan::LoraPacketTracker::MacTransmissionCallback(), ns3::Node::ReceiveFromDevice(), ns3::DesMetrics::Trace(), and ns3::DesMetrics::TraceWithContext().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDelayLeft()

Time ns3::Simulator::GetDelayLeft ( const EventId & id )

static

Get the remaining time until this event will execute.

Parameters

[in] id The event id to analyse.

Returns: The delay left until the input event id expires. if the event is not running, this method returns zero.

Definition at line 206 of file simulator.cc.

References ns3::SimulatorImpl::GetDelayLeft(), ns3::GetImpl(), and NS_LOG_FUNCTION.

Referenced by ns3::ThreeGppHttpClient::CancelAllPendingEvents(), ns3::LteUeRrc::CancelEnteringTrigger(), ns3::LteUeRrc::CancelEnteringTrigger(), ns3::LteUeRrc::CancelLeavingTrigger(), ns3::LteUeRrc::CancelLeavingTrigger(), ns3::ThreeGppHttpServerTxBuffer::CloseAllSockets(), ns3::ThreeGppHttpServerTxBuffer::CloseSocket(), ns3::TcpSocketBase::Destroy(), ns3::TcpSocketBase::Destroy6(), ns3::TcpSocketBase::DoForwardUp(), ns3::ChannelAccessManager::DoRestartAccessTimeoutIfNeeded(), ns3::HePhy::DoStartReceivePayload(), ns3::Timer::GetDelayLeft(), ns3::TrickleTimer::GetDelayLeft(), ns3::EmlsrManager::GetElapsedMediumSyncDelayTimer(), ns3::TrickleTimer::GetIntervalLeft(), ns3::PhyEntity::GetTimeToMacHdrEnd(), ns3::Rip::HandleResponses(), ns3::RipNg::HandleResponses(), ns3::AdvancedEmlsrManager::InterruptSwitchMainPhyBackTimerIfNeeded(), ns3::TcpSocketBase::NewAck(), ns3::lrwpan::LrWpanMac::PdDataIndication(), ns3::lrwpan::LrWpanMac::PlmeEdConfirm(), ns3::TcpSocketBase::ReceivedData(), ns3::AdvancedEmlsrManager::ReceivedMacHdr(), ns3::ThreeGppHttpServerTxBuffer::RemoveSocket(), ns3::StaWifiMac::RestartBeaconWatchdog(), ns3::Timer::Suspend(), and ns3::AdvancedEmlsrManager::SwitchMainPhyIfTxopGainedByAuxPhy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetEventCount()

uint64_t ns3::Simulator::GetEventCount ( )

static

Get the number of events executed.

Returns: The total number of events executed.

Definition at line 313 of file simulator.cc.

References ns3::SimulatorImpl::GetEventCount(), and ns3::GetImpl().

Referenced by ns3::ShowProgress::CheckProgress(), and Ipv4DeduplicationPerformanceTest::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetImplementation()

Ptr< SimulatorImpl > ns3::Simulator::GetImplementation ( )

static

Get the SimulatorImpl singleton.

Internal:: If the SimulatorImpl singleton hasn't been created yet, this function does so. At the same time it also creates the Scheduler. Both of these respect the global values which may have been set from the command line or through the Config system.

As a side effect we also call LogSetTimePrinter() and LogSetNodePrinter() with the default implementations since we can't really do any logging until we have a SimulatorImpl and Scheduler.

Returns: The SimulatorImpl singleton.

Definition at line 362 of file simulator.cc.

References ns3::GetImpl(), and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::PyViz::SimulatorRunUntil().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMaximumSimulationTime()

Time ns3::Simulator::GetMaximumSimulationTime ( )

static

Get the maximum representable simulation time.

Returns: The maximum simulation time at which an event can be scheduled.

The returned value will always be bigger than or equal to Simulator::Now.

Definition at line 300 of file simulator.cc.

References ns3::GetImpl(), ns3::SimulatorImpl::GetMaximumSimulationTime(), and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::ChannelAccessManager::DoRestartAccessTimeoutIfNeeded(), ns3::RemoteChannelBundleManager::GetSafeTime(), ns3::aodv::RoutingProtocol::NotifyAddAddress(), ns3::dsdv::RoutingProtocol::NotifyAddAddress(), ns3::aodv::RoutingProtocol::NotifyInterfaceUp(), ns3::dsdv::RoutingProtocol::NotifyInterfaceUp(), ns3::aodv::RoutingProtocol::NotifyRemoveAddress(), ns3::aodv::RoutingProtocol::SetIpv4(), and ns3::dsdv::RoutingProtocol::SetIpv4().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetStopEvent()

EventId ns3::Simulator::GetStopEvent ( )

static

Returns the Stop Event, or an invalid event if the simulation does not have a scheduled stop time.

Returns: The stop EventId.

Definition at line 191 of file simulator.cc.

References m_stopEvent.

◆ GetSystemId()

uint32_t ns3::Simulator::GetSystemId ( )

static

Get the system id of this simulator.

The system id is the identifier for this simulator instance in a distributed simulation. For MPI this is the MPI rank.

Returns: The system id for this simulator.

Definition at line 319 of file simulator.cc.

References ns3::GetImpl(), ns3::SimulatorImpl::GetSystemId(), NS_LOG_FUNCTION_NOARGS, and ns3::PeekImpl().

Referenced by ns3::GlobalRouteManagerImpl::InitializeRoutes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsExpired()

bool ns3::Simulator::IsExpired ( const EventId & id )

static

Check if an event has already run or been cancelled.

This method has O(1) complexity. Note that it is not possible to test for the expiration of events which were scheduled for the "destroy" time. Doing so will result in a program error (crash). An event is said to "expire" when it starts being executed, which means that if the code executed by the event calls this function, it will get true.

Parameters

[in] id The event to test for expiration.

Returns: true if the event has expired, false otherwise.

Definition at line 284 of file simulator.cc.

References ns3::GetImpl(), ns3::SimulatorImpl::IsExpired(), and ns3::PeekImpl().

Referenced by ns3::ThreeGppHttpClient::CancelAllPendingEvents(), ns3::ThreeGppHttpServerTxBuffer::CloseAllSockets(), ns3::ThreeGppHttpServerTxBuffer::CloseSocket(), ns3::EventId::IsExpired(), and ns3::ThreeGppHttpServerTxBuffer::RemoveSocket().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsFinished()

bool ns3::Simulator::IsFinished ( )

static

Check if the simulation should finish.

Reasons to finish are because there are no more events lefts to be scheduled, or if simulation time has already reached the "stop time" (see Simulator::Stop()).

Returns: true if no more events or stop time reached.

Definition at line 160 of file simulator.cc.

References ns3::GetImpl(), ns3::SimulatorImpl::IsFinished(), and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::ThreeGppHttpClient::DoDispose(), ns3::ThreeGppHttpServer::DoDispose(), GraphBattery1(), GraphBattery2(), GraphBattery3(), GraphBattery4(), GraphBattery5(), ns3::AnimationInterface::MobilityAutoCheck(), PrintCellInfo(), visualizer.core.SimulationThread::run(), ns3::energy::GenericBatteryModel::UpdateEnergySource(), ns3::energy::LiIonEnergySource::UpdateEnergySource(), ns3::energy::RvBatteryModel::UpdateEnergySource(), and ns3::energy::BasicEnergyHarvester::UpdateHarvestedPower().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Now()

Time ns3::Simulator::Now ( )

static

Return the current simulation virtual time.

Returns: The current virtual time.

Definition at line 197 of file simulator.cc.

References ns3::GetImpl(), and ns3::SimulatorImpl::Now().

Here is the call graph for this function:

◆ Remove()

void ns3::Simulator::Remove ( const EventId & id )

static

Remove an event from the event list.

This method has the same visible effect as the ns3::EventId::Cancel method but its algorithmic complexity is much higher: it has often O(log(n)) complexity, sometimes O(n), sometimes worse. Note that it is not possible to remove events which were scheduled for the "destroy" time. Doing so will result in a program error (crash).

Parameters

[in] id The event to remove from the list of scheduled events.

Definition at line 264 of file simulator.cc.

References ns3::GetImpl(), ns3::PeekImpl(), and ns3::SimulatorImpl::Remove().

Referenced by SimulatorEventsTestCase::DoRun(), ns3::RandomWalk2dOutdoorMobilityModel::DoSetPosition(), SimulatorEventsTestCase::EventB(), and ns3::EventId::Remove().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Run()

void ns3::Simulator::Run ( )

static

Run the simulation.

The simulation will run until one of:

No events are present anymore
The user called Simulator::Stop
The user called Simulator::Stop with a stop time and the expiration time of the next event to be processed is greater than or equal to the stop time.

Definition at line 167 of file simulator.cc.

References ns3::Time::ClearMarkedTimes(), ns3::GetImpl(), NS_LOG_FUNCTION_NOARGS, and ns3::SimulatorImpl::Run().

Here is the call graph for this function:

◆ Schedule() [1/3]

EventId ns3::Simulator::Schedule	(	const Time &	delay,
		const Ptr< EventImpl > &	event )

static

Schedule a future event execution (in the same context).

Parameters

[in]	delay	Delay until the event expires.
[in]	event	The event to schedule.

Returns: A unique identifier for the newly-scheduled event.

Definition at line 213 of file simulator.cc.

References DoSchedule(), and ns3::GetPointer().

Here is the call graph for this function:

◆ Schedule() [2/3]

template<typename FUNC , std::enable_if_t<!std::is_convertible_v< FUNC, Ptr< EventImpl > >, int > , std::enable_if_t<!std::is_function_v< std::remove_pointer_t< FUNC > >, int > , typename... Ts>

EventId ns3::Simulator::Schedule	(	const Time &	delay,
		FUNC	f,
		Ts &&...	args )

static

Schedule an event to expire after delay.

This can be thought of as scheduling an event for the current simulation time plus the delay passed as a parameter.

We leverage SFINAE to discard this overload if the second argument is convertible to Ptr<EventImpl> or is a function pointer.

Template Parameters

FUNC	[deduced] Template type for the function to invoke.
Ts	[deduced] Argument types.

Parameters

[in]	delay	The relative expiration time of the event.
[in]	f	The function to invoke.
[in]	args	Arguments to pass to MakeEvent.

Returns: The id for the scheduled event.

Definition at line 560 of file simulator.h.

References DoSchedule(), and ns3::MakeEvent().

Here is the call graph for this function:

◆ Schedule() [3/3]

template<typename... Us, typename... Ts>

EventId ns3::Simulator::Schedule	(	const Time &	delay,
		void(*	f )(Us...),
		Ts &&...	args )

static

Schedule an event to expire after delay.

This can be thought of as scheduling an event for the current simulation time plus the delay passed as a parameter.

Template Parameters

Us	[deduced] Formal function argument types.
Ts	[deduced] Actual function argument types. When the event expires (when it becomes due to be run), the function will be invoked with any supplied arguments.

Parameters

[in]	delay	The relative expiration time of the event.
[in]	f	The function to invoke.
[in]	args	Arguments to pass to the invoked function.

Returns: The id for the scheduled event.

Definition at line 567 of file simulator.h.

References DoSchedule(), and ns3::MakeEvent().

Here is the call graph for this function:

◆ ScheduleDestroy() [1/3]

EventId ns3::Simulator::ScheduleDestroy ( const Ptr< EventImpl > & event )

static

Schedule an event to run at the end of the simulation, after the Stop() time or condition has been reached.

Parameters

[in] event The event to schedule.

Returns: A unique identifier for the newly-scheduled event.

Definition at line 234 of file simulator.cc.

References DoScheduleDestroy(), and ns3::GetPointer().

Here is the call graph for this function:

◆ ScheduleDestroy() [2/3]

template<typename FUNC , std::enable_if_t<!std::is_convertible_v< FUNC, Ptr< EventImpl > >, int > , std::enable_if_t<!std::is_function_v< std::remove_pointer_t< FUNC > >, int > , typename... Ts>

EventId ns3::Simulator::ScheduleDestroy	(	FUNC	f,
		Ts &&...	args )

static

Schedule an event to run at the end of the simulation, when Simulator::Destroy() is called.

All events scheduled to expire at "Destroy" time are scheduled FIFO, after all normal events have expired and only when Simulator::Destroy is invoked.

We leverage SFINAE to discard this overload if the second argument is convertible to Ptr<EventImpl> or is a function pointer.

Template Parameters

FUNC	[deduced] Template type for the function to invoke.
Ts	[deduced] Actual function argument types.

Parameters

[in]	f	The function to invoke.
[in]	args	Arguments to pass to MakeEvent.

Returns: The EventId of the scheduled event.

Definition at line 611 of file simulator.h.

References DoScheduleDestroy(), and ns3::MakeEvent().

Referenced by ns3::Mac16Address::Allocate(), ns3::Mac48Address::Allocate(), ns3::Mac64Address::Allocate(), ns3::Mac8Address::Allocate(), ns3::BuildingListPriv::DoGet(), ns3::ChannelListPriv::DoGet(), ns3::NodeListPriv::DoGet(), SimulatorEventsTestCase::DoRun(), SimulatorTemplateTestCase::DoRun(), ns3::SimulationSingleton< T >::GetObject(), and ns3::FdReader::Start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScheduleDestroy() [3/3]

template<typename... Us, typename... Ts>

EventId ns3::Simulator::ScheduleDestroy	(	void(*	f )(Us...),
		Ts &&...	args )

static

Schedule an event to run at the end of the simulation, when Simulator::Destroy() is called.

All events scheduled to expire at "Destroy" time are scheduled FIFO, after all normal events have expired and only when Simulator::Destroy is invoked.

Template Parameters

Us	[deduced] Formal function argument types.
Ts	[deduced] Actual function argument types.

Parameters

[in]	f	The function to invoke.
[in]	args	Arguments to pass to MakeEvent.

Returns: The EventId of the scheduled event.

Definition at line 618 of file simulator.h.

References DoScheduleDestroy(), and ns3::MakeEvent().

Here is the call graph for this function:

◆ ScheduleNow() [1/3]

EventId ns3::Simulator::ScheduleNow ( const Ptr< EventImpl > & event )

static

Schedule an event to run at the current virtual time.

Parameters

[in] event The event to schedule.

Returns: A unique identifier for the newly-scheduled event.

Definition at line 219 of file simulator.cc.

References DoScheduleNow(), and ns3::GetPointer().

Here is the call graph for this function:

◆ ScheduleNow() [2/3]

template<typename FUNC , std::enable_if_t<!std::is_convertible_v< FUNC, Ptr< EventImpl > >, int > , std::enable_if_t<!std::is_function_v< std::remove_pointer_t< FUNC > >, int > , typename... Ts>

EventId ns3::Simulator::ScheduleNow	(	FUNC	f,
		Ts &&...	args )

static

Schedule an event to expire Now.

All events scheduled to to expire "Now" are scheduled FIFO, after all normal events have expired.

We leverage SFINAE to discard this overload if the second argument is convertible to Ptr<EventImpl> or is a function pointer.

Template Parameters

FUNC	[deduced] Template type for the function to invoke.
Ts	[deduced] Actual function argument types.

Parameters

[in]	f	The function to invoke.
[in]	args	Arguments to pass to the invoked function.

Returns: The EventId of the scheduled event.

Definition at line 594 of file simulator.h.

References DoScheduleNow(), and ns3::MakeEvent().

Here is the call graph for this function:

◆ ScheduleNow() [3/3]

template<typename... Us, typename... Ts>

EventId ns3::Simulator::ScheduleNow	(	void(*	f )(Us...),
		Ts &&...	args )

static

Schedule an event to expire Now.

All events scheduled to to expire "Now" are scheduled FIFO, after all normal events have expired.

Template Parameters

Us	[deduced] Formal function argument types.
Ts	[deduced] Actual function argument types.

Parameters

[in]	f	The function to invoke.
[in]	args	Arguments to pass to MakeEvent.

Returns: The EventId of the scheduled event.

Definition at line 601 of file simulator.h.

References DoScheduleNow(), and ns3::MakeEvent().

Here is the call graph for this function:

◆ ScheduleWithContext() [1/3]

void ns3::Simulator::ScheduleWithContext	(	uint32_t	context,
		const Time &	delay,
		EventImpl *	event )

static

Schedule a future event execution (in a different context).

This method is thread-safe: it can be called from any thread.

Parameters

[in]	delay	Delay until the event expires.
[in]	context	Event context.
[in]	event	The event to schedule.

Definition at line 225 of file simulator.cc.

References ns3::Singleton< DesMetrics >::Get(), ns3::GetImpl(), Now(), ns3::SimulatorImpl::ScheduleWithContext(), and ns3::DesMetrics::TraceWithContext().

Here is the call graph for this function:

◆ ScheduleWithContext() [2/3]

template<typename FUNC , std::enable_if_t<!std::is_convertible_v< FUNC, Ptr< EventImpl > >, int > , std::enable_if_t<!std::is_function_v< std::remove_pointer_t< FUNC > >, int > , typename... Ts>

void ns3::Simulator::ScheduleWithContext	(	uint32_t	context,
		const Time &	delay,
		FUNC	f,
		Ts &&...	args )

static

Schedule an event with the given context.

A context of 0xffffffff means no context is specified. This method is thread-safe: it can be called from any thread.

We leverage SFINAE to discard this overload if the second argument is convertible to Ptr<EventImpl> or is a function pointer.

Template Parameters

FUNC	[deduced] Template type for the function to invoke.
Ts	[deduced] Argument types.

Parameters

[in]	context	User-specified context parameter
[in]	delay	The relative expiration time of the event.
[in]	f	The function to invoke.
[in]	args	Arguments to pass to MakeEvent.

Definition at line 577 of file simulator.h.

References ns3::MakeEvent(), and ScheduleWithContext().

Here is the call graph for this function:

◆ ScheduleWithContext() [3/3]

template<typename... Us, typename... Ts>

void ns3::Simulator::ScheduleWithContext	(	uint32_t	context,
		const Time &	delay,
		void(*	f )(Us...),
		Ts &&...	args )

static

Schedule an event with the given context.

A context of 0xffffffff means no context is specified. This method is thread-safe: it can be called from any thread.

Template Parameters

Us	[deduced] Formal function argument types.
Ts	[deduced] Actual function argument types.

Parameters

[in]	context	User-specified context parameter
[in]	delay	The relative expiration time of the event.
[in]	f	The function to invoke.
[in]	args	Arguments to pass to the invoked function.

Definition at line 584 of file simulator.h.

References ns3::MakeEvent(), and ScheduleWithContext().

Here is the call graph for this function:

◆ SetImplementation()

void ns3::Simulator::SetImplementation ( Ptr< SimulatorImpl > impl )

static

Parameters

[in] impl A new simulator implementation.

The simulator provides a mechanism to swap out different implementations. For example, the default implementation is a single-threaded simulator that performs no realtime synchronization. By calling this method, you can substitute in a new simulator implementation that might be multi- threaded and synchronize events to a realtime clock.

The simulator implementation can be set when the simulator is not running.

Definition at line 334 of file simulator.cc.

References ns3::DefaultNodePrinter(), ns3::DefaultTimePrinter(), ns3::g_schedTypeImpl, ns3::StringValue::Get(), ns3::GetPointer(), ns3::GlobalValue::GetValue(), ns3::LogSetNodePrinter(), ns3::LogSetTimePrinter(), NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::PeekImpl(), and ns3::ObjectFactory::SetTypeId().

Here is the call graph for this function:

◆ SetScheduler()

void ns3::Simulator::SetScheduler ( ObjectFactory schedulerFactory )

static

Set the scheduler type with an ObjectFactory.

Parameters

[in] schedulerFactory The configured ObjectFactory.

The event scheduler can be set at any time: the events scheduled in the previous scheduler will be transferred to the new scheduler before we start to use it.

Definition at line 153 of file simulator.cc.

References ns3::GetImpl(), NS_LOG_FUNCTION, and ns3::SimulatorImpl::SetScheduler().

Referenced by BenchSuite::BenchSuite(), SimulatorEventsTestCase::DoRun(), and ThreadedSimulatorEventsTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Stop() [1/2]

void ns3::Simulator::Stop ( )

static

Tell the Simulator the calling event should be the last one executed.

If a running event invokes this method, it will be the last event executed by the Simulator::Run method before returning to the caller.

Definition at line 175 of file simulator.cc.

References ns3::GetImpl(), NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, and ns3::SimulatorImpl::Stop().

Here is the call graph for this function:

◆ Stop() [2/2]

EventId ns3::Simulator::Stop ( const Time & delay )

static

Schedule the time delay until the Simulator should stop.

Force the Simulator::Run method to return to the caller when the expiration time of the next event to be processed is greater than or equal to the stop time. The stop time is relative to the current simulation time.

Parameters

[in] delay The stop time, relative to the current time.

Returns: The stop EventId.

Definition at line 183 of file simulator.cc.

References ns3::GetImpl(), m_stopEvent, NS_LOG_FUNCTION, and ns3::SimulatorImpl::Stop().

Here is the call graph for this function:

Member Data Documentation

◆ m_stopEvent

EventId ns3::Simulator::m_stopEvent

staticprivate

Stop event (if present)

Definition at line 523 of file simulator.h.

Referenced by GetStopEvent(), and Stop().

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

src/core/model/simulator.h
src/core/model/simulator.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ Simulator()

◆ ~Simulator()

Member Function Documentation

◆ Cancel()

◆ Destroy()

◆ DoSchedule()

◆ DoScheduleDestroy()

◆ DoScheduleNow()

◆ GetContext()

◆ GetDelayLeft()

◆ GetEventCount()

◆ GetImplementation()

◆ GetMaximumSimulationTime()

◆ GetStopEvent()

◆ GetSystemId()

◆ IsExpired()

◆ IsFinished()

◆ Now()

◆ Remove()

◆ Run()

◆ Schedule() [1/3]

◆ Schedule() [2/3]

◆ Schedule() [3/3]

◆ ScheduleDestroy() [1/3]

◆ ScheduleDestroy() [2/3]

◆ ScheduleDestroy() [3/3]

◆ ScheduleNow() [1/3]

◆ ScheduleNow() [2/3]

◆ ScheduleNow() [3/3]

◆ ScheduleWithContext() [1/3]

◆ ScheduleWithContext() [2/3]

◆ ScheduleWithContext() [3/3]

◆ SetImplementation()

◆ SetScheduler()

◆ Stop() [1/2]

◆ Stop() [2/2]

Member Data Documentation

◆ m_stopEvent