An identifier for simulation events. More...

#include "event-id.h"

Collaboration diagram for ns3::EventId:

Public Types
enum	UID { INVALID = 0 , NOW = 1 , DESTROY = 2 , RESERVED = 3 , VALID = 4 }
	Special values of the event UID. More...

Public Member Functions
	EventId ()
	Default constructor.

	EventId (const Ptr< EventImpl > &impl, uint64_t ts, uint32_t context, uint32_t uid)
	Construct a real event.

void	Cancel ()
	This method is syntactic sugar for the ns3::Simulator::Cancel method.

bool	IsExpired () const
	This method is syntactic sugar for the ns3::Simulator::IsExpired method.

bool	IsPending () const
	This method is syntactic sugar for !IsExpired().

bool	IsRunning () const
	This method is syntactic sugar for !IsExpired().

void	Remove ()
	This method is syntactic sugar for the ns3::Simulator::Remove method.

Scheduler Helpers.
These methods are normally invoked only by subclasses of the Scheduler base class.
EventImpl *	PeekEventImpl () const

uint64_t	GetTs () const

uint32_t	GetContext () const

uint32_t	GetUid () const

Private Attributes
uint32_t	m_context
	The context.

Ptr< EventImpl >	m_eventImpl
	The underlying event implementation.

uint64_t	m_ts
	The virtual time stamp.

uint32_t	m_uid
	The unique id.

Friends
bool	operator!= (const EventId &a, const EventId &b)
	Test if two EventId's are not equal.

bool	operator< (const EventId &a, const EventId &b)
	Less than operator for two EventId's, based on time stamps.

bool	operator== (const EventId &a, const EventId &b)
	Test if two EventId's are equal.

Detailed Description

An identifier for simulation events.

Each EventId identifies a unique event scheduled with one of the many Simulator::Schedule() methods. This EventId can be used to cancel or remove events after they are scheduled with Cancel(), Remove(), or Simulator::Cancel() or Simulator::Remove().

The important thing to remember about this class is that every variable of this type is always in a valid state, even when it has not been assigned an EventId coming from a Simulator::Schedule() method: calling Simulator::Cancel(), IsPending(), IsExpired() or passing around instances of this object will not result in crashes or memory leaks.

Definition at line 44 of file event-id.h.

Member Enumeration Documentation

◆ UID

enum ns3::EventId::UID

Special values of the event UID.

Enumerator
INVALID	Invalid UID value.
NOW	ScheduleNow() events.
DESTROY	ScheduleDestroy() events.
RESERVED	Reserved UID.
VALID	Schedule(), etc. events.

Definition at line 48 of file event-id.h.

Constructor & Destructor Documentation

◆ EventId() [1/2]

ns3::EventId::EventId ( )

Default constructor.

This EventId does nothing.

Definition at line 25 of file event-id.cc.

References m_context, m_eventImpl, m_ts, m_uid, and NS_LOG_FUNCTION.

Referenced by operator!=, operator<, and operator==.

Here is the caller graph for this function:

◆ EventId() [2/2]

ns3::EventId::EventId	(	const Ptr< EventImpl > &	impl,
		uint64_t	ts,
		uint32_t	context,
		uint32_t	uid )

Construct a real event.

Parameters

[in]	impl	The implementation of this event.
[in]	ts	The virtual time stamp this event should occur.
[in]	context	The execution context for this event.
[in]	uid	The unique id for this EventId.

Definition at line 34 of file event-id.cc.

References m_context, m_eventImpl, m_ts, m_uid, and NS_LOG_FUNCTION.

Member Function Documentation

◆ Cancel()

void ns3::EventId::Cancel ( )

This method is syntactic sugar for the ns3::Simulator::Cancel method.

Definition at line 44 of file event-id.cc.

References ns3::Simulator::Cancel(), and NS_LOG_FUNCTION.

Referenced by ns3::ApWifiMac::DoInitialize(), and ns3::ApWifiMac::SetBeaconGeneration().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetContext()

uint32_t ns3::EventId::GetContext ( ) const

Returns: The event context.

Definition at line 92 of file event-id.cc.

References m_context, and NS_LOG_FUNCTION.

◆ GetTs()

uint64_t ns3::EventId::GetTs ( ) const

Returns: The virtual time stamp.

Definition at line 85 of file event-id.cc.

References m_ts, and NS_LOG_FUNCTION.

Referenced by operator<, and ns3::Time::operator<.

Here is the caller graph for this function:

◆ GetUid()

uint32_t ns3::EventId::GetUid ( ) const

Returns: The unique id.

Definition at line 99 of file event-id.cc.

References m_uid, and NS_LOG_FUNCTION.

Referenced by ns3::dsdv::RoutingProtocol::RecvDsdv().

Here is the caller graph for this function:

◆ IsExpired()

bool ns3::EventId::IsExpired ( ) const

This method is syntactic sugar for the ns3::Simulator::IsExpired method.

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

Definition at line 58 of file event-id.cc.

References ns3::Simulator::IsExpired(), and NS_LOG_FUNCTION.

Referenced by ns3::dsdv::RoutingTable::DeleteIpv4Event(), SimulatorEventsTestCase::DoRun(), and IsPending().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsPending()

bool ns3::EventId::IsPending ( ) const

This method is syntactic sugar for !IsExpired().

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

Definition at line 65 of file event-id.cc.

References IsExpired(), and NS_LOG_FUNCTION.

Referenced by ns3::dsdv::RoutingTable::DeleteIpv4Event(), IsRunning(), TcpZeroWindowTest::ProcessedAck(), and ns3::Txop::Queue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsRunning()

bool ns3::EventId::IsRunning ( ) const

This method is syntactic sugar for !IsExpired().

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

Deprecated: "Deprecated in ns-3.42: " "Use IsPending instead"

Definition at line 72 of file event-id.cc.

References IsPending().

Here is the call graph for this function:

◆ PeekEventImpl()

EventImpl * ns3::EventId::PeekEventImpl ( ) const

Returns: The underlying EventImpl pointer.

Definition at line 78 of file event-id.cc.

References m_eventImpl, NS_LOG_FUNCTION, and ns3::PeekPointer().

Here is the call graph for this function:

◆ Remove()

void ns3::EventId::Remove ( )

This method is syntactic sugar for the ns3::Simulator::Remove method.

Definition at line 51 of file event-id.cc.

References NS_LOG_FUNCTION, and ns3::Simulator::Remove().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ operator!=

bool operator!=	(	const EventId &	a,
		const EventId &	b )

friend

Test if two EventId's are not equal.

Parameters

[in]	a	The first EventId.
[in]	b	The second EventId.

Returns: true if the a and b are not the same event.

Definition at line 162 of file event-id.h.

References EventId().

◆ operator<

bool operator<	(	const EventId &	a,
		const EventId &	b )

friend

Less than operator for two EventId's, based on time stamps.

Parameters

[in]	a	The first EventId.
[in]	b	The second EventId.

Returns: true if a occurs before b.

Definition at line 167 of file event-id.h.

References EventId(), and GetTs().

◆ operator==

bool operator==	(	const EventId &	a,
		const EventId &	b )

friend

Test if two EventId's are equal.

Parameters

[in]	a	The first EventId.
[in]	b	The second EventId.

Returns: true if the a and b represent the same event.

Definition at line 155 of file event-id.h.

References EventId().

Member Data Documentation

◆ m_context

uint32_t ns3::EventId::m_context

private

The context.

Definition at line 146 of file event-id.h.

Referenced by EventId(), EventId(), and GetContext().

◆ m_eventImpl

Ptr<EventImpl> ns3::EventId::m_eventImpl

private

The underlying event implementation.

Definition at line 144 of file event-id.h.

Referenced by EventId(), EventId(), and PeekEventImpl().

◆ m_ts

uint64_t ns3::EventId::m_ts

private

The virtual time stamp.

Definition at line 145 of file event-id.h.

Referenced by EventId(), EventId(), and GetTs().

◆ m_uid

uint32_t ns3::EventId::m_uid

private

The unique id.

Definition at line 147 of file event-id.h.

Referenced by EventId(), EventId(), and GetUid().

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

src/core/model/event-id.h
src/core/model/event-id.cc

Public Types

Public Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ UID

Constructor & Destructor Documentation

◆ EventId() [1/2]

◆ EventId() [2/2]

Member Function Documentation

◆ Cancel()

◆ GetContext()

◆ GetTs()

◆ GetUid()

◆ IsExpired()

◆ IsPending()

◆ IsRunning()

◆ PeekEventImpl()

◆ Remove()

Friends And Related Symbol Documentation

◆ operator!=

◆ operator<

◆ operator==

Member Data Documentation

◆ m_context

◆ m_eventImpl

◆ m_ts

◆ m_uid