Collection of NS3 channels between local and remote nodes. More...

#include "remote-channel-bundle.h"

Inheritance diagram for ns3::RemoteChannelBundle:

Collaboration diagram for ns3::RemoteChannelBundle:

Public Member Functions
	RemoteChannelBundle ()

	RemoteChannelBundle (const uint32_t remoteSystemId)

	~RemoteChannelBundle ()

void	AddChannel (Ptr< Channel > channel, Time delay)

Time	GetDelay (void) const

EventId	GetEventId (void) const

Time	GetGuaranteeTime (void) const

std::size_t	GetSize (void) const

uint32_t	GetSystemId () const

void	Send (Time time)

void	SetEventId (EventId id)
	Set the event ID of the Null Message send event current scheduled for this channel. More...

void	SetGuaranteeTime (Time time)

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

virtual	~Object ()
	Destructor. More...

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

void	Dispose (void)
	Dispose of this Object. More...

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

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

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

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

template<>
Ptr< Object >	GetObject () const

template<>
Ptr< Object >	GetObject (TypeId tid) const

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

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

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

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

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

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

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

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

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

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

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

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

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

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

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

Static Public Member Functions
static TypeId	GetTypeId (void)

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

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

Private Attributes
std::map< uint32_t, Ptr< Channel > >	m_channels

Time	m_delay

Time	m_guaranteeTime

EventId	m_nullEventId

uint32_t	m_remoteSystemId

Friends
std::ostream &	operator<< (std::ostream &out, ns3::RemoteChannelBundle &bundle)
	Output for debugging purposes. More...

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

virtual void	DoDispose (void)
	Destructor implementation. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

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

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

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

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

Detailed Description

Collection of NS3 channels between local and remote nodes.

An instance exists for each remote system that the local system is in communication with. These are created and managed by the RemoteChannelBundleManager class. Stores time information for each bundle.

Definition at line 45 of file remote-channel-bundle.h.

Constructor & Destructor Documentation

◆ RemoteChannelBundle() [1/2]

ns3::RemoteChannelBundle::RemoteChannelBundle ( )

Definition at line 42 of file remote-channel-bundle.cc.

◆ RemoteChannelBundle() [2/2]

ns3::RemoteChannelBundle::RemoteChannelBundle ( const uint32_t remoteSystemId )

Definition at line 49 of file remote-channel-bundle.cc.

◆ ~RemoteChannelBundle()

ns3::RemoteChannelBundle::~RemoteChannelBundle ( )

inline

Definition at line 54 of file remote-channel-bundle.h.

Member Function Documentation

◆ AddChannel()

void ns3::RemoteChannelBundle::AddChannel	(	Ptr< Channel >	channel,
		Time	delay
	)

Parameters

channel	to add to the bundle
delay	time for the channel (usually the latency)

Definition at line 57 of file remote-channel-bundle.cc.

References third::channel, m_channels, m_delay, and ns3::Min().

Here is the call graph for this function:

◆ GetDelay()

Time ns3::RemoteChannelBundle::GetDelay ( void ) const

Returns: the minimum delay along any channel in this bundle

Definition at line 84 of file remote-channel-bundle.cc.

References m_delay.

Referenced by ns3::NullMessageSimulatorImpl::NullMessageEventHandler().

Here is the caller graph for this function:

◆ GetEventId()

EventId ns3::RemoteChannelBundle::GetEventId ( void ) const

Returns: the event ID of the Null Message send event for this bundle

Definition at line 96 of file remote-channel-bundle.cc.

References m_nullEventId.

◆ GetGuaranteeTime()

Time ns3::RemoteChannelBundle::GetGuaranteeTime ( void ) const

Returns: guarantee time

Definition at line 70 of file remote-channel-bundle.cc.

References m_guaranteeTime.

◆ GetSize()

std::size_t ns3::RemoteChannelBundle::GetSize ( void ) const

Returns: number of NS3 channels in this bundle

Definition at line 102 of file remote-channel-bundle.cc.

References m_channels.

◆ GetSystemId()

uint32_t ns3::RemoteChannelBundle::GetSystemId ( void ) const

Returns: SystemID for remote side of this bundle

Definition at line 64 of file remote-channel-bundle.cc.

References m_remoteSystemId.

◆ GetTypeId()

TypeId ns3::RemoteChannelBundle::GetTypeId ( void )

static

Definition at line 33 of file remote-channel-bundle.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Send()

void ns3::RemoteChannelBundle::Send ( Time time )

Parameters

time

Send Null Message to the remote task associated with this bundle. Message will be delivered at current simulation time + the time passed in.

Definition at line 108 of file remote-channel-bundle.cc.

References ns3::NullMessageMpiInterface::SendNullMessage().

Here is the call graph for this function:

◆ SetEventId()

void ns3::RemoteChannelBundle::SetEventId ( EventId id )

Set the event ID of the Null Message send event current scheduled for this channel.

Definition at line 90 of file remote-channel-bundle.cc.

References m_nullEventId.

◆ SetGuaranteeTime()

void ns3::RemoteChannelBundle::SetGuaranteeTime ( Time time )

Parameters

guarantee time

Set the guarantee time for the bundle. This should be called after a packet or Null Message received.

Definition at line 76 of file remote-channel-bundle.cc.

References m_guaranteeTime, ns3::Simulator::Now(), and NS_ASSERT.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	out,
		ns3::RemoteChannelBundle &	bundle
	)

friend

Output for debugging purposes.

Definition at line 113 of file remote-channel-bundle.cc.

Member Data Documentation

◆ m_channels

std::map< uint32_t, Ptr < Channel > > ns3::RemoteChannelBundle::m_channels

private

Definition at line 128 of file remote-channel-bundle.h.

Referenced by AddChannel(), GetSize(), and ns3::operator<<().

◆ m_delay

Time ns3::RemoteChannelBundle::m_delay

private

Definition at line 140 of file remote-channel-bundle.h.

Referenced by AddChannel(), GetDelay(), and ns3::operator<<().

◆ m_guaranteeTime

Time ns3::RemoteChannelBundle::m_guaranteeTime

private

Definition at line 135 of file remote-channel-bundle.h.

Referenced by GetGuaranteeTime(), ns3::operator<<(), and SetGuaranteeTime().

◆ m_nullEventId

EventId ns3::RemoteChannelBundle::m_nullEventId

private

Definition at line 145 of file remote-channel-bundle.h.

Referenced by GetEventId(), and SetEventId().

◆ m_remoteSystemId

uint32_t ns3::RemoteChannelBundle::m_remoteSystemId

private

Definition at line 121 of file remote-channel-bundle.h.

Referenced by GetSystemId(), and ns3::operator<<().

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

src/mpi/model/remote-channel-bundle.h
src/mpi/model/remote-channel-bundle.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RemoteChannelBundle() [1/2]

◆ RemoteChannelBundle() [2/2]

◆ ~RemoteChannelBundle()

Member Function Documentation

◆ AddChannel()

◆ GetDelay()

◆ GetEventId()

◆ GetGuaranteeTime()

◆ GetSize()

◆ GetSystemId()

◆ GetTypeId()

◆ Send()

◆ SetEventId()

◆ SetGuaranteeTime()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ m_channels

◆ m_delay

◆ m_guaranteeTime

◆ m_nullEventId

◆ m_remoteSystemId