Class to aggregate to a NetDevice if it supports MPI capability. More...

#include "mpi-receiver.h"

Inheritance diagram for ns3::MpiReceiver:

Collaboration diagram for ns3::MpiReceiver:

Public Member Functions
	~MpiReceiver () override

void	Receive (Ptr< Packet > p)
	Direct an incoming packet to the device Receive() method.

void	SetReceiveCallback (Callback< void, Ptr< Packet > > callback)
	Set the receive callback to get packets to net devices.

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 ()
	Register this type.

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 Member Functions
void	DoDispose () override
	Destructor implementation.

Private Attributes
Callback< void, Ptr< Packet > >	m_rxCallback
	Callback to send received packets to.

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

Class to aggregate to a NetDevice if it supports MPI capability.

MpiInterface::ReceiveMessages () needs to send packets to a NetDevice Receive() method. Since each NetDevice's Receive() method is specific to the derived class, and since we do not know whether such a NetDevice is MPI-capable, we aggregate one of these objects to each MPI-capable device. In addition, we must hook up a NetDevice::Receive() method to the callback. So the two steps to enable MPI capability are to aggregate this object to a NetDevice, and to set the callback.

Definition at line 36 of file mpi-receiver.h.

Constructor & Destructor Documentation

◆ ~MpiReceiver()

ns3::MpiReceiver::~MpiReceiver ( )

override

Definition at line 29 of file mpi-receiver.cc.

Member Function Documentation

◆ DoDispose()

void ns3::MpiReceiver::DoDispose ( )

overrideprivatevirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 47 of file mpi-receiver.cc.

References m_rxCallback, and ns3::MakeNullCallback().

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::MpiReceiver::GetTypeId ( )

static

Register this type.

Returns: The object TypeId.

Definition at line 20 of file mpi-receiver.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Receive()

void ns3::MpiReceiver::Receive ( Ptr< Packet > p )

Direct an incoming packet to the device Receive() method.

Parameters

p	Packet to receive

Definition at line 40 of file mpi-receiver.cc.

References ns3::Callback< R, UArgs >::IsNull(), m_rxCallback, and NS_ASSERT.

Referenced by ns3::GrantedTimeWindowMpiInterface::ReceiveMessages(), and ns3::NullMessageMpiInterface::ReceiveMessages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetReceiveCallback()

void ns3::MpiReceiver::SetReceiveCallback ( Callback< void, Ptr< Packet > > callback )

Set the receive callback to get packets to net devices.

Parameters

callback the callback itself

Definition at line 34 of file mpi-receiver.cc.

References m_rxCallback.

Member Data Documentation

◆ m_rxCallback

Callback<void, Ptr<Packet> > ns3::MpiReceiver::m_rxCallback

private

Callback to send received packets to.

Definition at line 61 of file mpi-receiver.h.

Referenced by DoDispose(), Receive(), and SetReceiveCallback().

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

src/mpi/model/mpi-receiver.h
src/mpi/model/mpi-receiver.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~MpiReceiver()

Member Function Documentation

◆ DoDispose()

◆ GetTypeId()

◆ Receive()

◆ SetReceiveCallback()

Member Data Documentation

◆ m_rxCallback