A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::MpiReceiver Class Reference

#include <mpi-receiver.h>

+ Inheritance diagram for ns3::MpiReceiver:
+ Collaboration diagram for ns3::MpiReceiver:

Public Member Functions

virtual ~MpiReceiver ()
 
void Receive (Ptr< Packet > p)
 Direct an incoming packet to the device Receive() method. More...
 
void SetReceiveCallback (Callback< void, Ptr< Packet > > callback)
 Set the receive callback to get packets to net devices. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Member Functions

virtual void DoDispose (void)
 

Private Attributes

Callback< void, Ptr< Packet > > m_rxCallback
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

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 42 of file mpi-receiver.h.

Constructor & Destructor Documentation

ns3::MpiReceiver::~MpiReceiver ( )
virtual

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

Member Function Documentation

void ns3::MpiReceiver::DoDispose ( void  )
privatevirtual

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

Subclasses are expected to implement their real destruction code in an overriden 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 50 of file mpi-receiver.cc.

References m_rxCallback.

TypeId ns3::MpiReceiver::GetTypeId ( void  )
static

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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

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

Parameters
pPacket to receive

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

References ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_rxCallback, and NS_ASSERT.

Referenced by ns3::MpiInterface::ReceiveMessages().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Set the receive callback to get packets to net devices.

Parameters
callbackthe callback itself

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

References m_rxCallback.

Member Data Documentation

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

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: