Realtime version of SimulatorImpl. More...

#include "realtime-simulator-impl.h"

Inheritance diagram for ns3::RealtimeSimulatorImpl:

Collaboration diagram for ns3::RealtimeSimulatorImpl:

Public Types
enum	SynchronizationMode { SYNC_BEST_EFFORT , SYNC_HARD_LIMIT }
	What to do when we can't maintain real time synchrony. More...

Public Member Functions
	RealtimeSimulatorImpl ()
	Constructor.

	~RealtimeSimulatorImpl () override
	Destructor.

void	Cancel (const EventId &ev) override
	Set the cancel bit on this event: the event's associated function will not be invoked when it expires.

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

uint32_t	GetContext () const override
	Get the current simulation context.

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

uint64_t	GetEventCount () const override
	Get the number of events executed.

Time	GetHardLimit () const
	Get the current fatal error threshold for SynchronizationMode SYNC_HARD_LIMIT.

Time	GetMaximumSimulationTime () const override
	Get the maximum representable simulation time.

RealtimeSimulatorImpl::SynchronizationMode	GetSynchronizationMode () const
	Get the SynchronizationMode.

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

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

bool	IsFinished () const override
	Check if the simulation should finish.

Time	Now () const override
	Return the current simulation virtual time.

Time	RealtimeNow () const
	Get the current real time from the synchronizer.

void	Remove (const EventId &ev) override
	Remove an event from the event list.

void	Run () override
	Run the simulation.

EventId	Schedule (const Time &delay, EventImpl *event) override
	Schedule a future event execution (in the same context).

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

EventId	ScheduleNow (EventImpl *event) override
	Schedule an event to run at the current virtual time.

void	ScheduleRealtime (const Time &delay, EventImpl *event)
	Schedule a future event execution (in the same context).

void	ScheduleRealtimeNow (EventImpl *event)
	Schedule an event to run at the current virtual time.

void	ScheduleRealtimeNowWithContext (uint32_t context, EventImpl *event)
	Schedule an event to run at the current virtual time.

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

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

void	SetHardLimit (Time limit)
	Set the fatal error threshold for SynchronizationMode SYNC_HARD_LIMIT.

void	SetScheduler (ObjectFactory schedulerFactory) override
	Set the Scheduler to be used to manage the event list.

void	SetSynchronizationMode (RealtimeSimulatorImpl::SynchronizationMode mode)
	Set the SynchronizationMode.

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

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

Public Member Functions inherited from ns3::SimulatorImpl
virtual void	PreEventHook (const EventId &id)
	Hook called before processing each event.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the registered TypeId for this class.

Static Public Member Functions inherited from ns3::SimulatorImpl
static TypeId	GetTypeId ()
	Get the registered TypeId for this class.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Types
typedef std::list< EventId >	DestroyEvents
	Container type for events to be run at destroy time.

Private Member Functions
void	DoDispose () override
	Destructor implementation.

uint64_t	NextTs () const
	Get the timestep of the next event.

void	ProcessOneEvent ()
	Process the next event.

bool	Realtime () const
	Check that the Synchronizer is locked to the real time clock.

bool	Running () const
	Is the simulator running?

Private Attributes
DestroyEvents	m_destroyEvents
	Container for events to be run at destroy time.

Time	m_hardLimit
	The maximum allowable drift from real-time in SYNC_HARD_LIMIT mode.

std::thread::id	m_main
	Main thread.

std::mutex	m_mutex
	Mutex to control access to key state.

bool	m_running
	Is the simulator currently running.

bool	m_stop
	Has the stopping condition been reached?

SynchronizationMode	m_synchronizationMode
	SynchronizationMode policy.

Ptr< Synchronizer >	m_synchronizer
	The synchronizer in use to track real time.

Mutex-protected variables.
These variables are protected by m_mutex.
Ptr< Scheduler >	m_events
	The event list.

int	m_unscheduledEvents
	Unique id for the next event to be scheduled.

uint32_t	m_uid
	Unique id of the current event.

uint32_t	m_currentUid
	Timestep of the current event.

uint64_t	m_currentTs
	Execution context.

uint32_t	m_currentContext
	The event list.

uint64_t	m_eventCount
	The event count.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Realtime version of SimulatorImpl.

Definition at line 43 of file realtime-simulator-impl.h.

Member Typedef Documentation

◆ DestroyEvents

typedef std::list<EventId> ns3::RealtimeSimulatorImpl::DestroyEvents

private

Container type for events to be run at destroy time.

Definition at line 177 of file realtime-simulator-impl.h.

Member Enumeration Documentation

◆ SynchronizationMode

enum ns3::RealtimeSimulatorImpl::SynchronizationMode

What to do when we can't maintain real time synchrony.

Enumerator

SYNC_BEST_EFFORT

Make a best effort to keep synced to real-time.

If we fall behind, keep going.

SYNC_HARD_LIMIT

Keep to real time within the hard limit tolerance configured with SetHardLimit, or die trying.

Falling behind by more than the hard limit tolerance triggers a fatal error.

See also: SetHardLimit

Definition at line 55 of file realtime-simulator-impl.h.

Constructor & Destructor Documentation

◆ RealtimeSimulatorImpl()

ns3::RealtimeSimulatorImpl::RealtimeSimulatorImpl ( )

Constructor.

Definition at line 66 of file realtime-simulator-impl.cc.

References ns3::CreateObject(), ns3::EventId::INVALID, m_currentContext, m_currentTs, m_currentUid, m_eventCount, m_main, m_running, m_stop, m_synchronizer, m_uid, m_unscheduledEvents, ns3::Simulator::NO_CONTEXT, NS_LOG_FUNCTION, and ns3::EventId::VALID.

Here is the call graph for this function:

◆ ~RealtimeSimulatorImpl()

ns3::RealtimeSimulatorImpl::~RealtimeSimulatorImpl ( )

override

Destructor.

Definition at line 86 of file realtime-simulator-impl.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Cancel()

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

overridevirtual

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

Implements ns3::SimulatorImpl.

Definition at line 728 of file realtime-simulator-impl.cc.

References IsExpired().

Here is the call graph for this function:

◆ Destroy()

void ns3::RealtimeSimulatorImpl::Destroy ( )

overridevirtual

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.

Implements ns3::SimulatorImpl.

Definition at line 106 of file realtime-simulator-impl.cc.

References m_destroyEvents, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ DoDispose()

void ns3::RealtimeSimulatorImpl::DoDispose ( )

overrideprivatevirtual

Destructor implementation.

Reimplemented from ns3::Object.

Definition at line 92 of file realtime-simulator-impl.cc.

References ns3::Object::DoDispose(), ns3::Scheduler::Event::impl, m_events, m_synchronizer, NS_LOG_FUNCTION, and ns3::SimpleRefCount< T, PARENT, DELETER >::Unref().

Here is the call graph for this function:

◆ GetContext()

uint32_t ns3::RealtimeSimulatorImpl::GetContext ( ) const

overridevirtual

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

Implements ns3::SimulatorImpl.

Definition at line 783 of file realtime-simulator-impl.cc.

References m_currentContext.

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

Here is the caller graph for this function:

◆ GetDelayLeft()

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

overridevirtual

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.

Implements ns3::SimulatorImpl.

Definition at line 676 of file realtime-simulator-impl.cc.

References IsExpired(), and m_currentTs.

Here is the call graph for this function:

◆ GetEventCount()

uint64_t ns3::RealtimeSimulatorImpl::GetEventCount ( ) const

overridevirtual

Get the number of events executed.

Returns: The total number of events executed.

Implements ns3::SimulatorImpl.

Definition at line 789 of file realtime-simulator-impl.cc.

References m_eventCount.

◆ GetHardLimit()

Time ns3::RealtimeSimulatorImpl::GetHardLimit ( ) const

Get the current fatal error threshold for SynchronizationMode SYNC_HARD_LIMIT.

Returns: The hard limit threshold.

Definition at line 816 of file realtime-simulator-impl.cc.

References m_hardLimit, and NS_LOG_FUNCTION.

◆ GetMaximumSimulationTime()

Time ns3::RealtimeSimulatorImpl::GetMaximumSimulationTime ( ) const

overridevirtual

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.

Implements ns3::SimulatorImpl.

Definition at line 770 of file realtime-simulator-impl.cc.

◆ GetSynchronizationMode()

RealtimeSimulatorImpl::SynchronizationMode ns3::RealtimeSimulatorImpl::GetSynchronizationMode ( ) const

Get the SynchronizationMode.

Returns: The current SynchronizationMode.

Definition at line 802 of file realtime-simulator-impl.cc.

References m_synchronizationMode, and NS_LOG_FUNCTION.

◆ GetSystemId()

uint32_t ns3::RealtimeSimulatorImpl::GetSystemId ( ) const

overridevirtual

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.

Implements ns3::SimulatorImpl.

Definition at line 777 of file realtime-simulator-impl.cc.

◆ GetTypeId()

TypeId ns3::RealtimeSimulatorImpl::GetTypeId ( )

static

Get the registered TypeId for this class.

Returns: The TypeId.

Definition at line 43 of file realtime-simulator-impl.cc.

References m_hardLimit, ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), ns3::TypeId::SetParent(), SetSynchronizationMode(), SYNC_BEST_EFFORT, and SYNC_HARD_LIMIT.

Here is the call graph for this function:

◆ IsExpired()

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

overridevirtual

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.

Implements ns3::SimulatorImpl.

Definition at line 737 of file realtime-simulator-impl.cc.

References ns3::EventId::DESTROY, m_currentTs, m_currentUid, and m_destroyEvents.

Referenced by Cancel(), GetDelayLeft(), and Remove().

Here is the caller graph for this function:

◆ IsFinished()

bool ns3::RealtimeSimulatorImpl::IsFinished ( ) const

overridevirtual

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.

Implements ns3::SimulatorImpl.

Definition at line 388 of file realtime-simulator-impl.cc.

References m_events, m_mutex, and m_stop.

◆ NextTs()

uint64_t ns3::RealtimeSimulatorImpl::NextTs ( ) const

private

Get the timestep of the next event.

Returns: The timestep of the next event.

Definition at line 403 of file realtime-simulator-impl.cc.

References ns3::Scheduler::Event::key, m_events, ns3::Scheduler::EventKey::m_ts, and NS_ASSERT_MSG.

Referenced by ProcessOneEvent().

Here is the caller graph for this function:

◆ Now()

Time ns3::RealtimeSimulatorImpl::Now ( ) const

overridevirtual

Return the current simulation virtual time.

Returns: The current virtual time.

Implements ns3::SimulatorImpl.

Definition at line 574 of file realtime-simulator-impl.cc.

References m_currentTs.

◆ ProcessOneEvent()

void ns3::RealtimeSimulatorImpl::ProcessOneEvent ( )

private

Process the next event.

Definition at line 153 of file realtime-simulator-impl.cc.

References ns3::Time::GetTimeStep(), ns3::Scheduler::Event::impl, ns3::EventImpl::Invoke(), ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentContext, m_currentTs, m_currentUid, m_eventCount, m_events, m_hardLimit, m_mutex, m_synchronizationMode, m_synchronizer, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, m_unscheduledEvents, NextTs(), NS_ASSERT_MSG, NS_FATAL_ERROR, NS_LOG_LOGIC, ns3::SimulatorImpl::PreEventHook(), and SYNC_HARD_LIMIT.

Referenced by Run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Realtime()

bool ns3::RealtimeSimulatorImpl::Realtime ( ) const

private

Check that the Synchronizer is locked to the real time clock.

Returns: true if the Synchronizer is locked.

Definition at line 478 of file realtime-simulator-impl.cc.

References m_synchronizer.

◆ RealtimeNow()

Time ns3::RealtimeSimulatorImpl::RealtimeNow ( ) const

Get the current real time from the synchronizer.

Returns: The current real time.

Definition at line 648 of file realtime-simulator-impl.cc.

References m_synchronizer.

◆ Remove()

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

overridevirtual

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.

Implements ns3::SimulatorImpl.

Definition at line 691 of file realtime-simulator-impl.cc.

References ns3::EventId::DESTROY, ns3::Scheduler::Event::impl, IsExpired(), m_destroyEvents, m_events, m_mutex, and m_unscheduledEvents.

Here is the call graph for this function:

◆ Run()

void ns3::RealtimeSimulatorImpl::Run ( )

overridevirtual

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.

Implements ns3::SimulatorImpl.

Definition at line 412 of file realtime-simulator-impl.cc.

References m_currentTs, m_events, m_main, m_mutex, m_running, m_stop, m_synchronizer, m_unscheduledEvents, NS_ASSERT_MSG, NS_LOG_FUNCTION, and ProcessOneEvent().

Here is the call graph for this function:

◆ Running()

bool ns3::RealtimeSimulatorImpl::Running ( ) const

private

Is the simulator running?

Returns: true if we are running.

Definition at line 472 of file realtime-simulator-impl.cc.

References m_running.

◆ Schedule()

EventId ns3::RealtimeSimulatorImpl::Schedule	(	const Time &	delay,
		EventImpl *	event )

overridevirtual

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.

Implements ns3::SimulatorImpl.

Definition at line 501 of file realtime-simulator-impl.cc.

References GetContext(), ns3::Time::GetTimeStep(), ns3::Scheduler::Event::impl, ns3::Time::IsPositive(), ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_events, m_mutex, m_synchronizer, ns3::Scheduler::EventKey::m_ts, m_uid, ns3::Scheduler::EventKey::m_uid, m_unscheduledEvents, ns3::Simulator::Now(), NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by ScheduleNow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScheduleDestroy()

EventId ns3::RealtimeSimulatorImpl::ScheduleDestroy ( EventImpl * event )

overridevirtual

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.

Implements ns3::SimulatorImpl.

Definition at line 654 of file realtime-simulator-impl.cc.

References ns3::EventId::DESTROY, m_currentTs, m_destroyEvents, m_mutex, m_uid, and NS_LOG_FUNCTION.

◆ ScheduleNow()

EventId ns3::RealtimeSimulatorImpl::ScheduleNow ( EventImpl * event )

overridevirtual

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.

Implements ns3::SimulatorImpl.

Definition at line 567 of file realtime-simulator-impl.cc.

References NS_LOG_FUNCTION, and Schedule().

Here is the call graph for this function:

◆ ScheduleRealtime()

void ns3::RealtimeSimulatorImpl::ScheduleRealtime	(	const Time &	delay,
		EventImpl *	event )

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

Parameters

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

Definition at line 607 of file realtime-simulator-impl.cc.

References GetContext(), NS_LOG_FUNCTION, and ScheduleRealtimeWithContext().

Here is the call graph for this function:

◆ ScheduleRealtimeNow()

void ns3::RealtimeSimulatorImpl::ScheduleRealtimeNow ( EventImpl * event )

Schedule an event to run at the current virtual time.

Parameters

[in] event The event to schedule.

Definition at line 641 of file realtime-simulator-impl.cc.

References GetContext(), NS_LOG_FUNCTION, and ScheduleRealtimeNowWithContext().

Here is the call graph for this function:

◆ ScheduleRealtimeNowWithContext()

void ns3::RealtimeSimulatorImpl::ScheduleRealtimeNowWithContext	(	uint32_t	context,
		EventImpl *	event )

Schedule an event to run at the current virtual time.

Parameters

[in]	context	Event context.
[in]	event	The event to schedule.

Definition at line 614 of file realtime-simulator-impl.cc.

References ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentTs, m_events, m_mutex, m_running, m_synchronizer, ns3::Scheduler::EventKey::m_ts, m_uid, ns3::Scheduler::EventKey::m_uid, m_unscheduledEvents, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by ScheduleRealtimeNow().

Here is the caller graph for this function:

◆ ScheduleRealtimeWithContext()

void ns3::RealtimeSimulatorImpl::ScheduleRealtimeWithContext	(	uint32_t	context,
		const Time &	delay,
		EventImpl *	event )

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 583 of file realtime-simulator-impl.cc.

References ns3::Time::GetTimeStep(), ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, m_currentTs, m_events, m_mutex, m_synchronizer, ns3::Scheduler::EventKey::m_ts, m_uid, ns3::Scheduler::EventKey::m_uid, m_unscheduledEvents, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by ScheduleRealtime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScheduleWithContext()

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

overridevirtual

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.

Implements ns3::SimulatorImpl.

Definition at line 530 of file realtime-simulator-impl.cc.

References ns3::Time::GetTimeStep(), ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentTs, m_events, m_main, m_mutex, m_running, m_synchronizer, ns3::Scheduler::EventKey::m_ts, m_uid, ns3::Scheduler::EventKey::m_uid, m_unscheduledEvents, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ SetHardLimit()

void ns3::RealtimeSimulatorImpl::SetHardLimit ( Time limit )

Set the fatal error threshold for SynchronizationMode SYNC_HARD_LIMIT.

Parameters

[in] limit The maximum amount of real time we are allowed to fall behind before we trigger a fatal error.

Definition at line 809 of file realtime-simulator-impl.cc.

References m_hardLimit, and NS_LOG_FUNCTION.

◆ SetScheduler()

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

overridevirtual

Set the Scheduler to be used to manage the event list.

Parameters

[in] schedulerFactory A new event scheduler factory.

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.

Implements ns3::SimulatorImpl.

Definition at line 131 of file realtime-simulator-impl.cc.

References ns3::ObjectFactory::Create(), m_events, m_mutex, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ SetSynchronizationMode()

void ns3::RealtimeSimulatorImpl::SetSynchronizationMode ( RealtimeSimulatorImpl::SynchronizationMode mode )

Set the SynchronizationMode.

Parameters

[in] mode The new SynchronizationMode.

Definition at line 795 of file realtime-simulator-impl.cc.

References m_synchronizationMode, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ Stop() [1/2]

void ns3::RealtimeSimulatorImpl::Stop ( )

overridevirtual

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.

Implements ns3::SimulatorImpl.

Definition at line 484 of file realtime-simulator-impl.cc.

References m_stop, and NS_LOG_FUNCTION.

◆ Stop() [2/2]

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

overridevirtual

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.

Implements ns3::SimulatorImpl.

Definition at line 491 of file realtime-simulator-impl.cc.

References NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and ns3::Simulator::Stop().

Here is the call graph for this function:

Member Data Documentation

◆ m_currentContext

uint32_t ns3::RealtimeSimulatorImpl::m_currentContext

private

The event list.

Number of events in the event list.

Definition at line 202 of file realtime-simulator-impl.h.

Referenced by RealtimeSimulatorImpl(), GetContext(), and ProcessOneEvent().

◆ m_currentTs

uint64_t ns3::RealtimeSimulatorImpl::m_currentTs

private

Execution context.

Definition at line 200 of file realtime-simulator-impl.h.

Referenced by RealtimeSimulatorImpl(), GetDelayLeft(), IsExpired(), Now(), ProcessOneEvent(), Run(), ScheduleDestroy(), ScheduleRealtimeNowWithContext(), ScheduleRealtimeWithContext(), and ScheduleWithContext().

◆ m_currentUid

uint32_t ns3::RealtimeSimulatorImpl::m_currentUid

private

Timestep of the current event.

Definition at line 198 of file realtime-simulator-impl.h.

Referenced by RealtimeSimulatorImpl(), IsExpired(), and ProcessOneEvent().

◆ m_destroyEvents

DestroyEvents ns3::RealtimeSimulatorImpl::m_destroyEvents

private

Container for events to be run at destroy time.

Definition at line 179 of file realtime-simulator-impl.h.

Referenced by Destroy(), IsExpired(), Remove(), and ScheduleDestroy().

◆ m_eventCount

uint64_t ns3::RealtimeSimulatorImpl::m_eventCount

private

The event count.

Definition at line 204 of file realtime-simulator-impl.h.

Referenced by RealtimeSimulatorImpl(), GetEventCount(), and ProcessOneEvent().

◆ m_events

Ptr<Scheduler> ns3::RealtimeSimulatorImpl::m_events

private

The event list.

Number of events in the event list.

Definition at line 192 of file realtime-simulator-impl.h.

Referenced by DoDispose(), IsFinished(), NextTs(), ProcessOneEvent(), Remove(), Run(), Schedule(), ScheduleRealtimeNowWithContext(), ScheduleRealtimeWithContext(), ScheduleWithContext(), and SetScheduler().

◆ m_hardLimit

Time ns3::RealtimeSimulatorImpl::m_hardLimit

private

The maximum allowable drift from real-time in SYNC_HARD_LIMIT mode.

Definition at line 217 of file realtime-simulator-impl.h.

Referenced by GetHardLimit(), GetTypeId(), ProcessOneEvent(), and SetHardLimit().

◆ m_main

std::thread::id ns3::RealtimeSimulatorImpl::m_main

private

Main thread.

Definition at line 220 of file realtime-simulator-impl.h.

Referenced by RealtimeSimulatorImpl(), Run(), and ScheduleWithContext().

◆ m_mutex

std::mutex ns3::RealtimeSimulatorImpl::m_mutex

mutableprivate

Mutex to control access to key state.

Definition at line 208 of file realtime-simulator-impl.h.

Referenced by IsFinished(), ProcessOneEvent(), Remove(), Run(), Schedule(), ScheduleDestroy(), ScheduleRealtimeNowWithContext(), ScheduleRealtimeWithContext(), ScheduleWithContext(), and SetScheduler().

◆ m_running

bool ns3::RealtimeSimulatorImpl::m_running

private

Is the simulator currently running.

Definition at line 183 of file realtime-simulator-impl.h.

Referenced by RealtimeSimulatorImpl(), Run(), Running(), ScheduleRealtimeNowWithContext(), and ScheduleWithContext().

◆ m_stop

bool ns3::RealtimeSimulatorImpl::m_stop

private

Has the stopping condition been reached?

Definition at line 181 of file realtime-simulator-impl.h.

Referenced by RealtimeSimulatorImpl(), IsFinished(), Run(), and Stop().

◆ m_synchronizationMode

SynchronizationMode ns3::RealtimeSimulatorImpl::m_synchronizationMode

private

SynchronizationMode policy.

Definition at line 214 of file realtime-simulator-impl.h.

Referenced by GetSynchronizationMode(), ProcessOneEvent(), and SetSynchronizationMode().

◆ m_synchronizer

Ptr<Synchronizer> ns3::RealtimeSimulatorImpl::m_synchronizer

private

The synchronizer in use to track real time.

Definition at line 211 of file realtime-simulator-impl.h.

Referenced by RealtimeSimulatorImpl(), DoDispose(), ProcessOneEvent(), Realtime(), RealtimeNow(), Run(), Schedule(), ScheduleRealtimeNowWithContext(), ScheduleRealtimeWithContext(), and ScheduleWithContext().

◆ m_uid

uint32_t ns3::RealtimeSimulatorImpl::m_uid

private

Unique id of the current event.

Definition at line 196 of file realtime-simulator-impl.h.

Referenced by RealtimeSimulatorImpl(), Schedule(), ScheduleDestroy(), ScheduleRealtimeNowWithContext(), ScheduleRealtimeWithContext(), and ScheduleWithContext().

◆ m_unscheduledEvents

int ns3::RealtimeSimulatorImpl::m_unscheduledEvents

private

Unique id for the next event to be scheduled.

Definition at line 194 of file realtime-simulator-impl.h.

Referenced by RealtimeSimulatorImpl(), ProcessOneEvent(), Remove(), Run(), Schedule(), ScheduleRealtimeNowWithContext(), ScheduleRealtimeWithContext(), and ScheduleWithContext().

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

src/core/model/realtime-simulator-impl.h
src/core/model/realtime-simulator-impl.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DestroyEvents

Member Enumeration Documentation

◆ SynchronizationMode

Constructor & Destructor Documentation

◆ RealtimeSimulatorImpl()

◆ ~RealtimeSimulatorImpl()

Member Function Documentation

◆ Cancel()

◆ Destroy()

◆ DoDispose()

◆ GetContext()

◆ GetDelayLeft()

◆ GetEventCount()

◆ GetHardLimit()

◆ GetMaximumSimulationTime()

◆ GetSynchronizationMode()

◆ GetSystemId()

◆ GetTypeId()

◆ IsExpired()

◆ IsFinished()

◆ NextTs()

◆ Now()

◆ ProcessOneEvent()

◆ Realtime()

◆ RealtimeNow()

◆ Remove()

◆ Run()

◆ Running()

◆ Schedule()

◆ ScheduleDestroy()

◆ ScheduleNow()

◆ ScheduleRealtime()

◆ ScheduleRealtimeNow()

◆ ScheduleRealtimeNowWithContext()

◆ ScheduleRealtimeWithContext()

◆ ScheduleWithContext()

◆ SetHardLimit()

◆ SetScheduler()

◆ SetSynchronizationMode()

◆ Stop() [1/2]

◆ Stop() [2/2]

Member Data Documentation

◆ m_currentContext

◆ m_currentTs

◆ m_currentUid

◆ m_destroyEvents

◆ m_eventCount

◆ m_events

◆ m_hardLimit

◆ m_main

◆ m_mutex

◆ m_running

◆ m_stop

◆ m_synchronizationMode

◆ m_synchronizer

◆ m_uid

◆ m_unscheduledEvents